edu.illinois.cs.cogcomp.core.math

Class ArgMin<T,V extends Comparable<V>>

java.lang.Object

edu.illinois.cs.cogcomp.core.math.ArgMin<T,V>

public class ArgMin<T,V extends Comparable<V>>
extends Object

Keeps track of maximum and the object that corresponds to the maximum.

V: type of value over which the max decision is made. T: type of the objects which generate the values

In case of ties, if randomTieBreak is false the first object is chosen; otherwise it's a random choice.

Example:

Suppose we have a list of strings that can be scored and we wish to track the maximum.

 ArgMax<Double, String> argmax = new Argmax<Double, String>(Double.NEGATIVE_INFINITY, "");
 
 for (String str : stringList) // stringList is probably an array of Strings
 {
     argmax.update(str, getScore(str));
 }
 
 double maxValue = argmax.getMaxValue();
 String argmaxString = argmax.getArgMax();
 

Author:

Vivek Srikumar, Christos Christodouloupoulos

Constructor Summary

Constructors

Constructor and Description
ArgMin(T initialObject, V initialValue)
ArgMin(T initialObject, V initialValue, boolean randomTieBreak)

Method Summary

Modifier and Type	Method and Description
T	getArgmin()
V	getMinValue()
String	toString()
void	update(T object, V value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArgMin

public ArgMin(T initialObject,
              V initialValue)

ArgMin

public ArgMin(T initialObject,
              V initialValue,
              boolean randomTieBreak)

Method Detail

update

public void update(T object,
                   V value)

getMinValue

public V getMinValue()

getArgmin

public T getArgmin()

toString

public String toString()

Overrides:

toString in class Object