gov.sandia.cognition.math.matrix
Class VectorizableIndexComparator

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.math.matrix.VectorizableIndexComparator
All Implemented Interfaces:
CloneableSerializable, Serializable, Cloneable, Comparator<Vectorizable>

public class VectorizableIndexComparator
extends AbstractCloneableSerializable
implements Comparator<Vectorizable>

Compares the given index of two Vectorizables.

Since:
3.0
Author:
Kevin R. Dixon
See Also:
Serialized Form

Constructor Summary
VectorizableIndexComparator()
          Creates a new instance of VectorizableIndexComparator
VectorizableIndexComparator(int index)
          Creates a new instance of VectorizableIndexComparator
 
Method Summary
 VectorizableIndexComparator clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 int compare(Vectorizable o1, Vectorizable o2)
           
 int getIndex()
          Getter for index.
 void setIndex(int index)
          Setter for index.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Constructor Detail

VectorizableIndexComparator

public VectorizableIndexComparator()
Creates a new instance of VectorizableIndexComparator


VectorizableIndexComparator

public VectorizableIndexComparator(int index)
Creates a new instance of VectorizableIndexComparator

Parameters:
index - Index to compare against.
Method Detail

clone

public VectorizableIndexComparator clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

compare

public int compare(Vectorizable o1,
                   Vectorizable o2)
Specified by:
compare in interface Comparator<Vectorizable>

getIndex

public int getIndex()
Getter for index.

Returns:
Index to compare against.

setIndex

public void setIndex(int index)
Setter for index.

Parameters:
index - Index to compare against.