Uses of Class
org.apache.lucene.util.quantization.ScalarQuantizer
Packages that use ScalarQuantizer
Package
Description
HNSW vector helper classes.
Lucene 9.9 file format.
Provides quantization methods for scaling vector values to smaller data types and possibly fewer
dimensions
-
Uses of ScalarQuantizer in org.apache.lucene.codecs.hnsw
Methods in org.apache.lucene.codecs.hnsw with parameters of type ScalarQuantizerModifier and TypeMethodDescriptionstatic float
ScalarQuantizedVectorScorer.quantizeQuery
(float[] query, byte[] quantizedQuery, VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer) Constructors in org.apache.lucene.codecs.hnsw with parameters of type ScalarQuantizerModifierConstructorDescriptionScalarQuantizedRandomVectorScorerSupplier
(VectorSimilarityFunction similarityFunction, ScalarQuantizer scalarQuantizer, QuantizedByteVectorValues values) -
Uses of ScalarQuantizer in org.apache.lucene.codecs.lucene99
Fields in org.apache.lucene.codecs.lucene99 declared as ScalarQuantizerModifier and TypeFieldDescriptionprivate final ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues.oldScalarQuantizer
private final ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues.quantizer
private final ScalarQuantizer
Lucene99ScalarQuantizedVectorsReader.FieldEntry.scalarQuantizer
The field for thescalarQuantizer
record component.private final ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues.scalarQuantizer
protected final ScalarQuantizer
OffHeapQuantizedByteVectorValues.scalarQuantizer
Methods in org.apache.lucene.codecs.lucene99 that return ScalarQuantizerModifier and TypeMethodDescription(package private) static ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.buildScalarQuantizer
(FloatVectorValues floatVectorValues, int numVectors, VectorSimilarityFunction vectorSimilarityFunction, Float confidenceInterval, byte bits) (package private) ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.FieldWriter.createQuantizer()
Lucene99HnswVectorsReader.getQuantizationState
(String field) Lucene99ScalarQuantizedVectorsReader.getQuantizationState
(String field) private static ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.getQuantizedState
(KnnVectorsReader vectorsReader, String fieldName) OffHeapQuantizedByteVectorValues.getScalarQuantizer()
static ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.mergeAndRecalculateQuantiles
(MergeState mergeState, FieldInfo fieldInfo, Float confidenceInterval, byte bits) Merges the quantiles of the segments and recalculates the quantiles if necessary.(package private) static ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.mergeQuantiles
(List<ScalarQuantizer> quantizationStates, IntArrayList segmentSizes, byte bits) Lucene99ScalarQuantizedVectorsReader.FieldEntry.scalarQuantizer()
Returns the value of thescalarQuantizer
record component.Methods in org.apache.lucene.codecs.lucene99 with parameters of type ScalarQuantizerModifier and TypeMethodDescriptionOffHeapQuantizedByteVectorValues.load
(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, long quantizedVectorDataOffset, long quantizedVectorDataLength, IndexInput vectorData) Lucene99ScalarQuantizedVectorsWriter.mergeOneFieldToIndex
(SegmentWriteState segmentWriteState, FieldInfo fieldInfo, MergeState mergeState, ScalarQuantizer mergedQuantizationState) Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues.mergeQuantizedByteVectorValues
(FieldInfo fieldInfo, MergeState mergeState, ScalarQuantizer scalarQuantizer) (package private) static boolean
Lucene99ScalarQuantizedVectorsWriter.shouldRecomputeQuantiles
(ScalarQuantizer mergedQuantizationState, List<ScalarQuantizer> quantizationStates) Returns true if the quantiles of the merged state are too far from the quantiles of the individual states.(package private) static boolean
Lucene99ScalarQuantizedVectorsWriter.shouldRequantize
(ScalarQuantizer existingQuantiles, ScalarQuantizer newQuantiles) Returns true if the quantiles of the new quantization state are too far from the quantiles of the existing quantization state.private void
Lucene99ScalarQuantizedVectorsWriter.writeField
(Lucene99ScalarQuantizedVectorsWriter.FieldWriter fieldData, int maxDoc, ScalarQuantizer scalarQuantizer) private void
Lucene99ScalarQuantizedVectorsWriter.writeQuantizedVectors
(Lucene99ScalarQuantizedVectorsWriter.FieldWriter fieldData, ScalarQuantizer scalarQuantizer) private void
Lucene99ScalarQuantizedVectorsWriter.writeSortedQuantizedVectors
(Lucene99ScalarQuantizedVectorsWriter.FieldWriter fieldData, int[] ordMap, ScalarQuantizer scalarQuantizer) private void
Lucene99ScalarQuantizedVectorsWriter.writeSortingField
(Lucene99ScalarQuantizedVectorsWriter.FieldWriter fieldData, int maxDoc, Sorter.DocMap sortMap, ScalarQuantizer scalarQuantizer) Method parameters in org.apache.lucene.codecs.lucene99 with type arguments of type ScalarQuantizerModifier and TypeMethodDescription(package private) static ScalarQuantizer
Lucene99ScalarQuantizedVectorsWriter.mergeQuantiles
(List<ScalarQuantizer> quantizationStates, IntArrayList segmentSizes, byte bits) (package private) static boolean
Lucene99ScalarQuantizedVectorsWriter.shouldRecomputeQuantiles
(ScalarQuantizer mergedQuantizationState, List<ScalarQuantizer> quantizationStates) Returns true if the quantiles of the merged state are too far from the quantiles of the individual states.Constructors in org.apache.lucene.codecs.lucene99 with parameters of type ScalarQuantizerModifierConstructorDescriptionDenseOffHeapVectorValues
(int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice) private
FieldEntry
(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, ScalarQuantizer scalarQuantizer, int size, byte bits, boolean compress, OrdToDocDISIReaderConfiguration ordToDoc) Creates an instance of aFieldEntry
record class.(package private)
OffHeapQuantizedByteVectorValues
(int dimension, int size, ScalarQuantizer scalarQuantizer, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, boolean compress, IndexInput slice) (package private)
OffsetCorrectedQuantizedByteVectorValues
(QuantizedByteVectorValues in, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer scalarQuantizer, ScalarQuantizer oldScalarQuantizer) QuantizedFloatVectorValues
(FloatVectorValues values, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer quantizer) SparseOffHeapVectorValues
(OrdToDocDISIReaderConfiguration configuration, int dimension, int size, ScalarQuantizer scalarQuantizer, boolean compress, IndexInput dataIn, VectorSimilarityFunction similarityFunction, FlatVectorsScorer vectorsScorer, IndexInput slice) -
Uses of ScalarQuantizer in org.apache.lucene.util.quantization
Methods in org.apache.lucene.util.quantization that return ScalarQuantizerModifier and TypeMethodDescriptionstatic ScalarQuantizer
ScalarQuantizer.fromVectors
(FloatVectorValues floatVectorValues, float confidenceInterval, int totalVectorCount, byte bits) This will read the float vector values and calculate the quantiles.(package private) static ScalarQuantizer
ScalarQuantizer.fromVectors
(FloatVectorValues floatVectorValues, float confidenceInterval, int totalVectorCount, byte bits, int quantizationSampleSize) static ScalarQuantizer
ScalarQuantizer.fromVectorsAutoInterval
(FloatVectorValues floatVectorValues, VectorSimilarityFunction function, int totalVectorCount, byte bits) QuantizedVectorsReader.getQuantizationState
(String fieldName) QuantizedByteVectorValues.getScalarQuantizer()
Methods in org.apache.lucene.util.quantization with parameters of type ScalarQuantizerModifier and TypeMethodDescriptionfloat
ScalarQuantizer.recalculateCorrectiveOffset
(byte[] quantizedVector, ScalarQuantizer oldQuantizer, VectorSimilarityFunction similarityFunction) Recalculate the old score corrective value given new current quantiles