Module org.elasticsearch.server
Package org.elasticsearch.index.codec.vectors

Interface RandomAccessBinarizedByteVectorValues

All Superinterfaces:
org.apache.lucene.util.hnsw.RandomAccessVectorValues, org.apache.lucene.util.hnsw.RandomAccessVectorValues.Bytes
All Known Implementing Classes:
OffHeapBinarizedVectorValues, OffHeapBinarizedVectorValues.DenseOffHeapVectorValues
public interface RandomAccessBinarizedByteVectorValues extends org.apache.lucene.util.hnsw.RandomAccessVectorValues.Bytes
Copied from Lucene, replace with Lucene's implementation sometime after Lucene 10

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues

    org.apache.lucene.util.hnsw.RandomAccessVectorValues.Bytes, org.apache.lucene.util.hnsw.RandomAccessVectorValues.Floats

  • Method Summary

    Modifier and Type
    Method
    Description
    RandomAccessBinarizedByteVectorValues
    copy()
     
    default int
    discretizedDimensions()
     
    float[]
    getCentroid()
     
    float
    getCentroidDistance(int vectorOrd)
    Returns the centroid distance for the vector
    default float
    getCentroidDP()
     
    float
    getNormOC(int targetOrd)
    Returns the norm of the target vector w the centroid corrective factor for the given vector ordinal
    float
    getODotC(int targetOrd)
    Returns the target vector dot product the centroid corrective factor for the given vector ordinal
    float
    getOOQ(int targetOrd)
    Returns OOQ corrective factor for the given vector ordinal
    BinaryQuantizer
    getQuantizer()
     
    float
    getVectorMagnitude(int vectorOrd)
    Returns the vector magnitude for the vector
    default float
    maxX1()
     
    default float
    sqrtDimensions()
     

    Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues

    dimension, getAcceptOrds, getSlice, ordToDoc, size

    Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues.Bytes

    getVectorByteLength, vectorValue

  • Method Details

    • getCentroidDistance

      float getCentroidDistance(int vectorOrd) throws IOException
      Returns the centroid distance for the vector
      Throws:
      IOException

    • getVectorMagnitude

      float getVectorMagnitude(int vectorOrd) throws IOException
      Returns the vector magnitude for the vector
      Throws:
      IOException

    • getOOQ

      float getOOQ(int targetOrd) throws IOException
      Returns OOQ corrective factor for the given vector ordinal
      Throws:
      IOException

    • getNormOC

      float getNormOC(int targetOrd) throws IOException
      Returns the norm of the target vector w the centroid corrective factor for the given vector ordinal
      Throws:
      IOException

    • getODotC

      float getODotC(int targetOrd) throws IOException
      Returns the target vector dot product the centroid corrective factor for the given vector ordinal
      Throws:
      IOException

    • getQuantizer

      BinaryQuantizer getQuantizer()
      Returns:
      the quantizer used to quantize the vectors

    • discretizedDimensions

      default int discretizedDimensions()

    • sqrtDimensions

      default float sqrtDimensions()

    • maxX1

      default float maxX1()

    • getCentroid

      float[] getCentroid() throws IOException
      Returns:
      coarse grained centroids for the vectors
      Throws:
      IOException

    • copy

      RandomAccessBinarizedByteVectorValues copy() throws IOException
      Specified by:
      copy in interface org.apache.lucene.util.hnsw.RandomAccessVectorValues
      Specified by:
      copy in interface org.apache.lucene.util.hnsw.RandomAccessVectorValues.Bytes
      Throws:
      IOException

    • getCentroidDP

      default float getCentroidDP() throws IOException
      Throws:
      IOException