jme3utilities.math

Class IntPair

java.lang.Object

jme3utilities.math.IntPair

All Implemented Interfaces:

java.lang.Comparable<IntPair>

public class IntPair
extends java.lang.Object
implements java.lang.Comparable<IntPair>

Represent a pair of distinct integers. Immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	logger message logger for this class

Constructor Summary

Constructors

Constructor and Description
IntPair(int a, int b) Instantiate a pair.

Method Summary

Modifier and Type	Method and Description
int	compareTo(IntPair otherPair) Compare to another IntPair, with the smaller elements having priority.
boolean	equals(java.lang.Object otherObject) Test for exact equivalence with another Object.
int	hashCode() Generate the hash code for this pair.
int	larger() Read the larger element of the pair.
int	smaller() Read the smaller element of the pair.
java.lang.String	toString() Represent this pair as a text string.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final java.util.logging.Logger logger

message logger for this class

Constructor Detail

IntPair

public IntPair(int a,
               int b)

Instantiate a pair.

Parameters:

a - the first element (≠ b)

b - the 2nd element (≠ a)

Method Detail

larger

public int larger()

Read the larger element of the pair.

Returns:

the element value

smaller

public int smaller()

Read the smaller element of the pair.

Returns:

the element value

compareTo

public int compareTo(IntPair otherPair)

Compare to another IntPair, with the smaller elements having priority.

Specified by:

compareTo in interface java.lang.Comparable<IntPair>

Parameters:

otherPair - (not null)

Returns:

0 if this equals otherPair; negative if this comes before otherPair; positive if this comes after otherPair

equals

public boolean equals(java.lang.Object otherObject)

Test for exact equivalence with another Object.

Overrides:

equals in class java.lang.Object

Parameters:

otherObject - the object to compare (may be null, unaffected)

Returns:

true if this and otherObject have identical values, otherwise false

hashCode

public int hashCode()

Generate the hash code for this pair.

Overrides:

hashCode in class java.lang.Object

Returns:

a 32-bit value for use in hashing

toString

public java.lang.String toString()

Represent this pair as a text string. The format is: {smaller,larger}

Overrides:

toString in class java.lang.Object

Returns:

a descriptive string of text (not null)