Package org.tribuo.clustering

Class ClusteringInfo

java.lang.Object
org.tribuo.clustering.ClusteringInfo
All Implemented Interfaces:
Serializable, OutputInfo<ClusterID>, ProtoSerializable<org.tribuo.protos.core.OutputDomainProto>
Direct Known Subclasses:
ImmutableClusteringInfo, MutableClusteringInfo
public abstract class ClusteringInfo extends Object implements OutputInfo<ClusterID>
The base class for a ClusterID OutputInfo.
See Also:

  • Field Details

    • clusterCounts

      protected final Map<Integer,com.oracle.labs.mlrg.olcut.util.MutableLong> clusterCounts
      The cluster counts for each id.

    • unknownCount

      protected int unknownCount
      The number of times this object has seen the unknown cluster id.

  • Method Details

    • serialize

      public org.tribuo.protos.core.OutputDomainProto serialize()
      Description copied from interface: ProtoSerializable
      Serializes this object to a protobuf.
      Specified by:
      serialize in interface ProtoSerializable<org.tribuo.protos.core.OutputDomainProto>
      Returns:
      The protobuf.

    • 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.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object