org.tribuo.clustering

Class ClusteringInfo

java.lang.Object

org.tribuo.clustering.ClusteringInfo

All Implemented Interfaces:

Serializable, OutputInfo<ClusterID>

Direct Known Subclasses:

ImmutableClusteringInfo, MutableClusteringInfo

public abstract class ClusteringInfo
extends Object
implements OutputInfo<ClusterID>

The base class for a ClusterID OutputInfo.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,com.oracle.labs.mlrg.olcut.util.MutableLong>	clusterCounts
protected int	unknownCount

Method Summary

Modifier and Type	Method and Description
abstract ClusteringInfo	copy() Generates a copy of this OutputInfo, including it's mutability.
ImmutableOutputInfo<ClusterID>	generateImmutableOutputInfo() Generates an ImmutableOutputInfo which has a copy of the data in this OutputInfo, but also has id values and is immutable.
MutableOutputInfo<ClusterID>	generateMutableOutputInfo() Generates a mutable copy of this OutputInfo.
Set<ClusterID>	getDomain() Returns a set of Output which represent the space of possible values the Output has taken.
int	getUnknownCount() Returns the number of unknown Output instances (generated by OutputFactory.getUnknownOutput()) that this OutputInfo has seen.
Iterable<com.oracle.labs.mlrg.olcut.util.Pair<String,Long>>	outputCountsIterable() An Iterable over the possible outputs and the number of times they were observed.
int	size() Returns the number of possible values this OutputInfo knows about.
String	toReadableString() Generates a String form of this OutputInfo.

Methods inherited from class java.lang.Object

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

Field Detail

clusterCounts

protected final Map<Integer,com.oracle.labs.mlrg.olcut.util.MutableLong> clusterCounts

unknownCount

protected int unknownCount

Method Detail

getUnknownCount

public int getUnknownCount()

Description copied from interface: OutputInfo

Returns the number of unknown Output instances (generated by OutputFactory.getUnknownOutput()) that this OutputInfo has seen.

Specified by:

getUnknownCount in interface OutputInfo<ClusterID>

Returns:

The number of unknown outputs observed.

getDomain

public Set<ClusterID> getDomain()

Description copied from interface: OutputInfo

Returns a set of Output which represent the space of possible values the Output has taken.

For real values this set represents the number of dimensions observed.

Specified by:

getDomain in interface OutputInfo<ClusterID>

Returns:

A Set of T.

size

public int size()

Description copied from interface: OutputInfo

Returns the number of possible values this OutputInfo knows about.

For real values this is the number of dimensions observed.

Specified by:

size in interface OutputInfo<ClusterID>

Returns:

An int representing the size of the domain.

generateImmutableOutputInfo

public ImmutableOutputInfo<ClusterID> generateImmutableOutputInfo()

Description copied from interface: OutputInfo

Generates an ImmutableOutputInfo which has a copy of the data in this OutputInfo, but also has id values and is immutable.

Specified by:

generateImmutableOutputInfo in interface OutputInfo<ClusterID>

Returns:

An immutable copy of this OutputInfo.

generateMutableOutputInfo

public MutableOutputInfo<ClusterID> generateMutableOutputInfo()

Description copied from interface: OutputInfo

Generates a mutable copy of this OutputInfo.

Specified by:

generateMutableOutputInfo in interface OutputInfo<ClusterID>

Returns:

A mutable copy of this OutputInfo.

copy

public abstract ClusteringInfo copy()

Description copied from interface: OutputInfo

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

Specified by:

copy in interface OutputInfo<ClusterID>

Returns:

A copy of the OutputInfo.

outputCountsIterable

public Iterable<com.oracle.labs.mlrg.olcut.util.Pair<String,Long>> outputCountsIterable()

Description copied from interface: OutputInfo

An Iterable over the possible outputs and the number of times they were observed.

Provides similar functionality to an iterator over the entrySet of a Map, though this is a copy of the data and immutable.

Specified by:

outputCountsIterable in interface OutputInfo<ClusterID>

Returns:

Lambda wrapping an iterator over Pairs.

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<ClusterID>

Returns:

A formatted String representing this OutputInfo.