edu.illinois.cs.cogcomp.lbjava.classify

Class ScoreSet

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.classify.ScoreSet

All Implemented Interfaces:

Cloneable

public class ScoreSet
extends Object
implements Cloneable

A score set is simply a set of Scores.

Author:

Nick Rizzolo

See Also:

Score

Constructor Summary

Constructors

Constructor and Description
ScoreSet() Default constructor.
ScoreSet(Score[] scores) The elements of the array are added to the set.
ScoreSet(String[] values, double[] scores) The elements of the two argument arrays are assumed to be pair-wise associated with each other.

Method Summary

Modifier and Type	Method and Description
Object	clone() Produces a deep copy of this object.
double	get(String v) Returns the double precision score for a particular classification value.
Score	getScore(String v) Retrieves the Score object associated with the given classification value.
String	highScoreValue() Retrieves the value with the highest score in this set.
void	put(String v, double s) Sets the score for a particular classification value.
int	size() Returns the number of scores in this set.
Score[]	toArray() Returns an array view of the Scores contained in this set.
String	toString() The string representation of a ScoreSet is the concatenation of the string representations of each Score in the set sorted by value, separated by commas, and surrounded by curly braces.
Set	values() Retrieves the set of values that have scores associated with them in this score set.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScoreSet

public ScoreSet()

Default constructor.

ScoreSet

public ScoreSet(String[] values,
                double[] scores)

The elements of the two argument arrays are assumed to be pair-wise associated with each other.

Parameters:

values - The classification values being scored.

scores - The scores of the classification values.

ScoreSet

public ScoreSet(Score[] scores)

The elements of the array are added to the set.

Parameters:

scores - The scores to add to the set.

Method Detail

size

public int size()

Returns the number of scores in this set.

put

public void put(String v,
                double s)

Sets the score for a particular classification value.

Parameters:

v - The classification value.

s - The score.

values

public Set values()

Retrieves the set of values that have scores associated with them in this score set.

Returns:

A set of Strings.

get

public double get(String v)

Returns the double precision score for a particular classification value.

Parameters:

v - The classification value.

Returns:

The associated score.

getScore

public Score getScore(String v)

Retrieves the Score object associated with the given classification value.

Parameters:

v - The classification value.

Returns:

The associated Score object.

highScoreValue

public String highScoreValue()

Retrieves the value with the highest score in this set.

toArray

public Score[] toArray()

Returns an array view of the Scores contained in this set.

Returns:

An array of Scores.

toString

public String toString()

The string representation of a ScoreSet is the concatenation of the string representations of each Score in the set sorted by value, separated by commas, and surrounded by curly braces.

Overrides:

toString in class Object

Returns:

The string representation of a ScoreSet.

clone

public Object clone()

Produces a deep copy of this object.

Overrides:

clone in class Object

Returns:

A deep copy of this object.