edu.stanford.nlp.util

Class UnorderedPair<T1,T2>

java.lang.Object

edu.stanford.nlp.util.Pair<T1,T2>

edu.stanford.nlp.util.UnorderedPair<T1,T2>

All Implemented Interfaces:

PrettyLoggable, java.io.Serializable, java.lang.Comparable<Pair<T1,T2>>

public class UnorderedPair<T1,T2>
extends Pair<T1,T2>

Holds an unordered pair of objects.

Version:

2/7/01

Author:

Dan Klein

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.stanford.nlp.util.Pair

Pair.ByFirstPairComparator<T1,T2>, Pair.ByFirstReversePairComparator<T1,T2>, Pair.BySecondPairComparator<T1,T2>, Pair.BySecondReversePairComparator<T1,T2>

Field Summary

Fields inherited from class edu.stanford.nlp.util.Pair

first, second

Constructor Summary

Constructors

Constructor and Description
UnorderedPair()
UnorderedPair(T1 first, T2 second)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<T1,T2> o) Compares this Pair to another object.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()

Methods inherited from class edu.stanford.nlp.util.Pair

asList, first, internedStringPair, makePair, prettyLog, save, second, setFirst, setSecond, stringIntern

Methods inherited from class java.lang.Object

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

Constructor Detail

UnorderedPair

public UnorderedPair()

UnorderedPair

public UnorderedPair(T1 first,
                     T2 second)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class Pair<T1,T2>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Pair<T1,T2>

hashCode

public int hashCode()

Overrides:

hashCode in class Pair<T1,T2>

compareTo

public int compareTo(Pair<T1,T2> o)

Description copied from class: Pair

Compares this Pair to another object. If the object is a Pair, this function will work providing the elements of the Pair are themselves comparable. It will then return a value based on the pair of objects, where p > q iff p.first() > q.first() || (p.first().equals(q.first()) && p.second() > q.second()). If the other object is not a Pair, it throws a ClassCastException.

Specified by:

compareTo in interface java.lang.Comparable<Pair<T1,T2>>

Overrides:

compareTo in class Pair<T1,T2>

Parameters:

o - the Object to be compared.

Returns:

the value 0 if the argument is a Pair equal to this Pair; a value less than 0 if the argument is a Pair greater than this Pair; and a value greater than 0 if the argument is a Pair less than this Pair.

See Also:

Comparable