Class ImmutableClusteringInfo

java.lang.Object

org.tribuo.clustering.ClusteringInfo

org.tribuo.clustering.ImmutableClusteringInfo

All Implemented Interfaces:

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

public class ImmutableClusteringInfo
extends ClusteringInfo
implements ImmutableOutputInfo<ClusterID>

An ImmutableOutputInfo object for ClusterIDs.

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

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.tribuo.clustering.ClusteringInfo

clusterCounts, unknownCount

Constructor Summary

Constructors

Constructor	Description
ImmutableClusteringInfo(Map<Integer, com.oracle.labs.mlrg.olcut.util.MutableLong> counts)
ImmutableClusteringInfo(ClusteringInfo other)

Method Summary

Modifier and Type	Method	Description
ClusteringInfo	copy()	Generates a copy of this OutputInfo, including it's mutability.
Set<ClusterID>	getDomain()	Returns a set of Output which represent the space of possible values the Output has taken.
int	getID(ClusterID output)	Return the id number associated with this output, or -1 if the output is unknown.
ClusterID	getOutput(int id)	Returns the output associated with this id, or null if the id is unknown.
long	getTotalObservations()	Returns the total number of observed outputs seen by this ImmutableOutputInfo.
Iterator<com.oracle.labs.mlrg.olcut.util.Pair<Integer, ClusterID>>	iterator()

Methods inherited from class org.tribuo.clustering.ClusteringInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getUnknownCount, outputCountsIterable, size, toReadableString, toString

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, toReadableString

Constructor Details

ImmutableClusteringInfo

public ImmutableClusteringInfo(Map<Integer, com.oracle.labs.mlrg.olcut.util.MutableLong> counts)

ImmutableClusteringInfo

public ImmutableClusteringInfo(ClusteringInfo other)

Method Details

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>

Overrides:

getDomain in class ClusteringInfo

Returns:

A Set of T.

getID

public int getID(ClusterID output)

Description copied from interface: ImmutableOutputInfo

Return the id number associated with this output, or -1 if the output is unknown.

Specified by:

getID in interface ImmutableOutputInfo<ClusterID>

Parameters:

output - An output

Returns:

A non-negative integer if the output is known, or -1 if the output is unknown.

getOutput

public ClusterID getOutput(int id)

Description copied from interface: ImmutableOutputInfo

Returns the output associated with this id, or null if the id is unknown.

Specified by:

getOutput in interface ImmutableOutputInfo<ClusterID>

Parameters:

id - A non-negative integer.

Returns:

An output object or null if it's unknown.

getTotalObservations

public long getTotalObservations()

Description copied from interface: ImmutableOutputInfo

Returns the total number of observed outputs seen by this ImmutableOutputInfo.

Specified by:

getTotalObservations in interface ImmutableOutputInfo<ClusterID>

Returns:

The number of observed outputs.

copy

public ClusteringInfo copy()

Description copied from interface: OutputInfo

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

Specified by:

copy in interface OutputInfo<ClusterID>

Specified by:

copy in class ClusteringInfo

Returns:

A copy of the OutputInfo.

iterator

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

Specified by:

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