Package org.apache.lucene.sandbox.codecs.quantization

Record Class KMeans.Results

java.lang.Object
java.lang.Record
org.apache.lucene.sandbox.codecs.quantization.KMeans.Results
Record Components:
centroids - the produced centroids
vectorCentroids - for each vector which centroid it belongs to, we use short type, as we expect less than MAX_NUM_CENTROIDS which is equal to 32767 centroids. Can be null if they were not computed.
Enclosing class:
KMeans
public static record KMeans.Results(float[][] centroids, short[] vectorCentroids) extends Record
Results of KMeans clustering

  • Constructor Summary

    Constructors
    Constructor
    Description
    Results(float[][] centroids, short[] vectorCentroids)
    Creates an instance of a Results record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float[][]
    centroids()
    Returns the value of the centroids record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    short[]
    vectorCentroids()
    Returns the value of the vectorCentroids record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Results

      public Results(float[][] centroids, short[] vectorCentroids)
      Creates an instance of a Results record class.
      Parameters:
      centroids - the value for the centroids record component
      vectorCentroids - the value for the vectorCentroids record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • centroids

      public float[][] centroids()
      Returns the value of the centroids record component.
      Returns:
      the value of the centroids record component

    • vectorCentroids

      public short[] vectorCentroids()
      Returns the value of the vectorCentroids record component.
      Returns:
      the value of the vectorCentroids record component