Package org.tribuo.classification

Class ImmutableLabelInfo

java.lang.Object

org.tribuo.classification.LabelInfo

org.tribuo.classification.ImmutableLabelInfo

All Implemented Interfaces:

Serializable, Iterable<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>>, ImmutableOutputInfo<Label>, OutputInfo<Label>

public class ImmutableLabelInfo
extends LabelInfo
implements ImmutableOutputInfo<Label>

An ImmutableOutputInfo object for Labels.

Gives each unique label an id number. Also counts each label occurrence like MutableLabelInfo does, though the counts are frozen in this object.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.tribuo.classification.LabelInfo

labelCounts, labels, unknownCount

Method Summary

Modifier and Type	Method	Description
ImmutableLabelInfo	copy()
boolean	domainAndIDEquals(ImmutableOutputInfo<Label> other)
Set<Label>	getDomain()	Returns the set of possible Labels that this LabelInfo has seen.
int	getID(Label output)
long	getLabelCount(int id)	Returns the number of times the supplied id was observed before this LabelInfo was frozen.
Label	getOutput(int id)
long	getTotalObservations()
Iterator<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>>	iterator()
String	toReadableString()
String	toString()

Methods inherited from class org.tribuo.classification.LabelInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getLabelCount, getLabelCount, getUnknownCount, outputCountsIterable, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.tribuo.OutputInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getUnknownCount, outputCountsIterable, size

Method Details

getDomain

public Set<Label> getDomain()

Returns the set of possible Labels that this LabelInfo has seen. Each label has the default score of Double.NaN.

Specified by:

getDomain in interface OutputInfo<Label>

Overrides:

getDomain in class LabelInfo

Returns:

The set of possible labels.

getID

public int getID(Label output)

Specified by:

getID in interface ImmutableOutputInfo<Label>

getOutput

public Label getOutput(int id)

Specified by:

getOutput in interface ImmutableOutputInfo<Label>

getTotalObservations

public long getTotalObservations()

Specified by:

getTotalObservations in interface ImmutableOutputInfo<Label>

getLabelCount

public long getLabelCount(int id)

Returns the number of times the supplied id was observed before this LabelInfo was frozen.

Parameters:

id - The id number.

Returns:

The count.

copy

public ImmutableLabelInfo copy()

Specified by:

copy in interface OutputInfo<Label>

Specified by:

copy in class LabelInfo

toReadableString

public String toReadableString()

Specified by:

toReadableString in interface OutputInfo<Label>

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>> iterator()

Specified by:

iterator in interface Iterable<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>>

domainAndIDEquals

public boolean domainAndIDEquals(ImmutableOutputInfo<Label> other)

Specified by:

domainAndIDEquals in interface ImmutableOutputInfo<Label>