edu.illinois.cs.cogcomp.lbjava.infer

Class FirstOrderVariable

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.infer.FirstOrderVariable

All Implemented Interfaces:

Cloneable

public class FirstOrderVariable
extends Object
implements Cloneable

Represents a classifier application. An inference algorithm may change the value returned by the classifier application when satisfying constraints.

Author:

Nick Rizzolo

Constructor Summary

Constructors

Constructor and Description
FirstOrderVariable(Learner c, Object e) Initializing constructor.

Method Summary

Modifier and Type	Method and Description
Object	clone() This method returns a shallow clone.
boolean	equals(Object o) Two FirstOrderVariables are equivalent when their classifiers are equivalent and they store the same example object.
Learner	getClassifier() Retrieves the classifier.
Object	getExample() Retrieves the example object.
double	getScore() Retrieves the score of the current value of this variable.
ScoreSet	getScores() Retrieves all the scores for the values this variable may take.
String	getValue() Retrieves the value this variable currently takes.
int	hashCode() The hash code of a FirstOrderVariable is the hash code of the string representation of the classifier plus the system's hash code for the example object.
void	setExample(Object e) Sets the example object.
void	setValue(String v) Sets the value of this variable.
String	toString() Returns a string representation of this variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstOrderVariable

public FirstOrderVariable(Learner c,
                          Object e)

Initializing constructor.

Parameters:

c - The classifier being applied.

e - The classifier is applied to this example object.

Method Detail

getClassifier

public Learner getClassifier()

Retrieves the classifier.

getExample

public Object getExample()

Retrieves the example object.

getValue

public String getValue()

Retrieves the value this variable currently takes.

setValue

public void setValue(String v)

Sets the value of this variable.

Parameters:

v - The new value of this variable.

setExample

public void setExample(Object e)

Sets the example object.

Parameters:

e - The new example object.

getScore

public double getScore()

Retrieves the score of the current value of this variable.

getScores

public ScoreSet getScores()

Retrieves all the scores for the values this variable may take.

toString

public String toString()

Returns a string representation of this variable.

Overrides:

toString in class Object

hashCode

public int hashCode()

The hash code of a FirstOrderVariable is the hash code of the string representation of the classifier plus the system's hash code for the example object.

Overrides:

hashCode in class Object

Returns:

The hash code of this FirstOrderVariable.

equals

public boolean equals(Object o)

Two FirstOrderVariables are equivalent when their classifiers are equivalent and they store the same example object.

Overrides:

equals in class Object

Parameters:

o - The object to test equivalence with.

Returns:

true iff this object is equivalent to the argument object.

clone

public Object clone()

This method returns a shallow clone.

Overrides:

clone in class Object

Returns:

A shallow clone.