Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> gui4j >> core >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.gui4j.core.util
Class SparseMatrix  

java.lang.Object
  org.gui4j.core.util.SparseMatrix

All Implemented Interfaces:

java.io.Serializable

---

public final class SparseMatrix

extends java.lang.Object

implements java.io.Serializable

Generic Class for sparsely populated matrices. The size of the matrix is dynamic, i.e. you can specify arbitrary row and column parameters. Another way to look at this class is as a "two-dimensional" map. Instead of a single key it uses a row and a column element to store and retrieve data elements. The public Interface Traverser allows to traverse the matrix generically. The Traverser object is passed into traverse(Traverser) and is given the opportunity to work with each element of the matrix.

---

Nested Class Summary
static interface	SparseMatrix.Traverser           Allows objects to traverse the matrix.

 

Field Summary
private  java.util.Map	matrixMap

 

Constructor Summary

SparseMatrix()

 

Method Summary
void	clear()           Löscht alle Elemente
java.util.Set	colSet()           Returns a Set of all used "columns" in the matrix.
boolean	equals(java.lang.Object obj)           Determine whether this Object is semantically equal to another Object.
java.lang.Object	get(java.lang.Object row, java.lang.Object col)           Returns the value found at the specified row and column of the matrix.
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
void	remove(java.lang.Object row, java.lang.Object col)
java.util.Set	rowSet()           Returns a Set of all used "rows" in the matrix.
void	set(java.lang.Object row, java.lang.Object col, java.lang.Object value)           Sets the value of the matrix at the specified row and column.
java.lang.String	toString()           Convert this Object to a human-readable String.
void	traverse(SparseMatrix.Traverser traverser)           Traverses the matrix and calls work() on the supplied Traverser object for each matrix element.

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

matrixMap

private final java.util.Map matrixMap

Constructor Detail

SparseMatrix

public SparseMatrix()

Method Detail

get

public java.lang.Object get(java.lang.Object row,
                            java.lang.Object col)

Returns the value found at the specified row and column of the matrix. Returns null if there's no value for the specified row and column.

---

set

public void set(java.lang.Object row,
                java.lang.Object col,
                java.lang.Object value)

Sets the value of the matrix at the specified row and column.

---

remove

public void remove(java.lang.Object row,
                   java.lang.Object col)

---

colSet

public java.util.Set colSet()

Returns a Set of all used "columns" in the matrix.

---

rowSet

public java.util.Set rowSet()

Returns a Set of all used "rows" in the matrix.

---

traverse

public void traverse(SparseMatrix.Traverser traverser)

Traverses the matrix and calls work() on the supplied Traverser object for each matrix element. The traversal sequence is undefined.

---

clear

public void clear()

Löscht alle Elemente

---

equals

public boolean equals(java.lang.Object obj)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> gui4j >> core >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---