Package org.tribuo.clustering

Class MutableClusteringInfo

java.lang.Object

org.tribuo.clustering.ClusteringInfo

org.tribuo.clustering.MutableClusteringInfo

All Implemented Interfaces:

Serializable, MutableOutputInfo<ClusterID>, OutputInfo<ClusterID>, ProtoSerializable<org.tribuo.protos.core.OutputDomainProto>

public class MutableClusteringInfo
extends ClusteringInfo
implements MutableOutputInfo<ClusterID>

A mutable ClusteringInfo. Can record new observations of ClusterIDs, incrementing the appropriate counts.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.tribuo.clustering.ClusteringInfo

clusterCounts, unknownCount

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the OutputInfo, removing all things it's observed.
MutableClusteringInfo	copy()	Generates a copy of this OutputInfo, including it's mutability.
static MutableClusteringInfo	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
void	observe(ClusterID output)	Records an output value or statistics thereof.

Methods inherited from class org.tribuo.clustering.ClusteringInfo

equals, generateImmutableOutputInfo, generateMutableOutputInfo, getDomain, getUnknownCount, hashCode, outputCountsIterable, serialize, size, toReadableString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tribuo.OutputInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getDomain, getUnknownCount, outputCountsIterable, size, toReadableString

Methods inherited from interface org.tribuo.protos.ProtoSerializable

serialize

Method Details

deserializeFromProto

public static MutableClusteringInfo deserializeFromProto(int version,
 String className,
 com.google.protobuf.Any message)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Deserialization factory.

Parameters:

version - The serialized object version.

className - The class name.

message - The serialized data.

Returns:

The deserialized object.

Throws:

com.google.protobuf.InvalidProtocolBufferException - If the protobuf could not be parsed from the message.

observe

public void observe(ClusterID output)

Description copied from interface: MutableOutputInfo

Records an output value or statistics thereof.

Specified by:

observe in interface MutableOutputInfo<ClusterID>

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

copy

public MutableClusteringInfo 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.