Class MutableMultiLabelInfo

java.lang.Object

org.tribuo.multilabel.MultiLabelInfo

org.tribuo.multilabel.MutableMultiLabelInfo

All Implemented Interfaces:

Serializable, MutableOutputInfo<MultiLabel>, OutputInfo<MultiLabel>

public class MutableMultiLabelInfo
extends MultiLabelInfo
implements MutableOutputInfo<MultiLabel>

A MutableOutputInfo for working with multi-label tasks.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.tribuo.multilabel.MultiLabelInfo

labelCounts, labels, totalCount, unknownCount

Constructor Summary

Constructors

Constructor	Description
MutableMultiLabelInfo(MultiLabelInfo info)	Construct a MutableMultiLabelInfo with it's state copied from another MultiLabelInfo.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the OutputInfo, removing all things it's observed.
MutableMultiLabelInfo	copy()	Generates a copy of this OutputInfo, including it's mutability.
void	observe(MultiLabel output)	Throws IllegalStateException if the MultiLabel contains a Label which has a "," in it.
String	toReadableString()	Generates a String form of this OutputInfo.

Methods inherited from class org.tribuo.multilabel.MultiLabelInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getDomain, 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 org.tribuo.OutputInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getDomain, getUnknownCount, outputCountsIterable, size

Constructor Details

MutableMultiLabelInfo

public MutableMultiLabelInfo(MultiLabelInfo info)

Construct a MutableMultiLabelInfo with it's state copied from another MultiLabelInfo.

Parameters:

info - The info to copy.

Method Details

observe

public void observe(MultiLabel output)

Throws IllegalStateException if the MultiLabel contains a Label which has a "," in it.

Such labels are disallowed. There should be an exception thrown when one is constructed too.

Specified by:

observe in interface MutableOutputInfo<MultiLabel>

Parameters:

output - The observed output.

clear

public void clear()

Description copied from interface: MutableOutputInfo

Clears the OutputInfo, removing all things it's observed.

Specified by:

clear in interface MutableOutputInfo<MultiLabel>

copy

public MutableMultiLabelInfo copy()

Description copied from interface: OutputInfo

Generates a copy of this OutputInfo, including it's mutability.

Specified by:

copy in interface OutputInfo<MultiLabel>

Specified by:

copy in class MultiLabelInfo

Returns:

A copy of the OutputInfo.

toReadableString

public String 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 interface OutputInfo<MultiLabel>

Returns:

A formatted String representing this OutputInfo.