org.perro.functions.mapper

Class DoubleIndexPair

java.lang.Object

org.perro.functions.mapper.DoubleIndexPair

public class DoubleIndexPair
extends java.lang.Object

An immutable object that pairs a primitive double value, with an associated int index. Note that, unlike Pair, this class does not implement Map.Entry, because it deals with primitive values only.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
double	getDoubleValue() Getter for the double value associated with an index.
int	getIndex() Getter for the index.
int	hashCode() Generates a hash code based on the hash codes of its primitive attributes.
static DoubleIndexPair	of(double doubleValue, int index) Builds a new instance of this class, with the given doubleValue and index values.
java.lang.String	toString() Returns a string representation of the object, containing the primitive attribute values of this object.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static DoubleIndexPair of(double doubleValue,
                                 int index)

Builds a new instance of this class, with the given doubleValue and index values.

Parameters:

doubleValue - A double value to be paired with an associated index.

index - An int index.

Returns:

A new instance of this class.

getDoubleValue

public double getDoubleValue()

Getter for the double value associated with an index.

Returns:

A double value associated with an index.

getIndex

public int getIndex()

Getter for the index.

Returns:

An index associated with a double value.

hashCode

public int hashCode()

Generates a hash code based on the hash codes of its primitive attributes.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one. The will be considered equal if the given object is of the same class, and is either the identical object, or the primitive double and int attributes are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The target object with which to compare the current instance.

Returns:

true if this object is considered equal to the obj argument; false otherwise.

toString

public java.lang.String toString()

Returns a string representation of the object, containing the primitive attribute values of this object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.