gov.sandia.cognition.learning.data
Interface ValueDiscriminantPair<ValueType,DiscriminantType extends Comparable<? super DiscriminantType>>

Type Parameters:
ValueType - The general value stored in the pair.
DiscriminantType - The discriminant comparable object used for ordering objects.
All Superinterfaces:
Pair<ValueType,DiscriminantType>, Serializable
All Known Implementing Classes:
AbstractValueDiscriminantPair, DefaultValueDiscriminantPair, DefaultWeightedValueDiscriminant

public interface ValueDiscriminantPair<ValueType,DiscriminantType extends Comparable<? super DiscriminantType>>
extends Pair<ValueType,DiscriminantType>

Interface for a pair of a value and a discriminant for ordering instances that have the same value.

Since:
3.1
Author:
Justin Basilico

Method Summary
 DiscriminantType getDiscriminant()
          Gets the discriminant for ordering instances of the same value.
 ValueType getValue()
          Gets the value in the pair.
 
Methods inherited from interface gov.sandia.cognition.util.Pair
getFirst, getSecond
 

Method Detail

getValue

ValueType getValue()
Gets the value in the pair.

Returns:
The value in the pair.

getDiscriminant

DiscriminantType getDiscriminant()
Gets the discriminant for ordering instances of the same value.

Returns:
The discriminant in the pair.