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>
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:
-
Field Summary
Fields inherited from class org.tribuo.classification.LabelInfo
labelCounts, labels, unknownCount
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Generates a copy of this OutputInfo, including it's mutability.Returns the set of possibleLabel
s that this LabelInfo has seen.int
Return the id number associated with this output, or -1 if the output is unknown.long
getLabelCount
(int id) Returns the number of times the supplied id was observed before this LabelInfo was frozen.getOutput
(int id) Returns the output associated with this id, or null if the id is unknown.long
Returns the total number of observed outputs seen by this ImmutableOutputInfo.iterator()
Generates a String form of this OutputInfo.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, toString, 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
-
getID
Description copied from interface:ImmutableOutputInfo
Return the id number associated with this output, or -1 if the output is unknown.- Specified by:
getID
in interfaceImmutableOutputInfo<Label>
- Parameters:
output
- An output- Returns:
- A non-negative integer if the output is known, or -1 if the output is unknown.
-
getOutput
Description copied from interface:ImmutableOutputInfo
Returns the output associated with this id, or null if the id is unknown.- Specified by:
getOutput
in interfaceImmutableOutputInfo<Label>
- Parameters:
id
- A non-negative integer.- Returns:
- An output object or null if it's unknown.
-
getTotalObservations
Description copied from interface:ImmutableOutputInfo
Returns the total number of observed outputs seen by this ImmutableOutputInfo.- Specified by:
getTotalObservations
in interfaceImmutableOutputInfo<Label>
- Returns:
- The number of observed outputs.
-
getLabelCount
Returns the number of times the supplied id was observed before this LabelInfo was frozen.- Parameters:
id
- The id number.- Returns:
- The count.
-
copy
Description copied from interface:OutputInfo
Generates a copy of this OutputInfo, including it's mutability.- Specified by:
copy
in interfaceOutputInfo<Label>
- Specified by:
copy
in classLabelInfo
- Returns:
- A copy of the OutputInfo.
-
toReadableString
Description copied from interface:OutputInfo
Generates a String form of this OutputInfo.This String can contain newlines, tabs and other formatting.
- Specified by:
toReadableString
in interfaceOutputInfo<Label>
- Returns:
- A formatted String representing this OutputInfo.
-
iterator
-