org.apache.lucene.util.quantization (Lucene 10.5.1 core API)
Description: declaration: package: org.apache.lucene.util.quantization

# Package org.apache.lucene.util.quantization

package org.apache.lucene.util.quantization
Provides quantization methods for scaling vector values to smaller data types and possibly fewer dimensions

- Related Packages
  Package
  Description
  org.apache.lucene.util
  Some utility classes.
- Class
  Description
  BaseQuantizedByteVectorValues
  A version of `ByteVectorValues` for Scalar quantization scores.
  LegacyQuantizedByteVectorValues
  A version of `BaseQuantizedByteVectorValues`, but additionally retrieving score correction offset for Scalar quantization scores.
  OptimizedScalarQuantizer
  This is a scalar quantizer that optimizes the quantization intervals for a given vector.
  OptimizedScalarQuantizer.QuantizationResult
  Quantization result containing the lower and upper interval bounds, the additional correction
  QuantizedByteVectorValues
  Scalar quantized byte vector values
  QuantizedByteVectorValues.ScalarEncoding
  Allowed encodings for scalar quantization.
  QuantizedVectorsReader
  Quantized vector reader
  ScalarQuantizedVectorSimilarity
  Calculates and adjust the scores correctly for quantized vectors given the scalar quantization parameters
  ScalarQuantizedVectorSimilarity.ByteVectorComparator
  Compares two byte vectors
  ScalarQuantizedVectorSimilarity.DotProduct
  Calculates dot product on quantized vectors, applying the appropriate corrections
  ScalarQuantizedVectorSimilarity.Euclidean
  Calculates euclidean distance on quantized vectors, applying the appropriate corrections
  ScalarQuantizedVectorSimilarity.MaximumInnerProduct
  Calculates max inner product on quantized vectors, applying the appropriate corrections
  ScalarQuantizer
  Will scalar quantize float vectors into `int8` byte values.