Uses of Class
org.apache.lucene.index.KnnVectorValues

Packages that use KnnVectorValues

Package	Description
org.apache.lucene.analysis.synonym.word2vec	Analysis components for Synonyms using Word2Vec model.
org.apache.lucene.backward_codecs.lucene90	Lucene 9.0 file format.
org.apache.lucene.backward_codecs.lucene91	Lucene 9.1 file format.
org.apache.lucene.backward_codecs.lucene92	Lucene 9.2 file format.
org.apache.lucene.backward_codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.bitvectors	A simple bit-vector format that supports hamming distance and storing vectors in an HNSW graph
org.apache.lucene.codecs.hnsw	HNSW vector helper classes.
org.apache.lucene.codecs.lucene95	Lucene 9.5 file format.
org.apache.lucene.codecs.lucene99	Lucene 9.9 file format.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.index.memory	High-performance single-document main memory Apache Lucene fulltext search index.
org.apache.lucene.sandbox.codecs.quantization	This package implements KMeans algorithm for clustering vectors
org.apache.lucene.util.hnsw	Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
org.apache.lucene.util.quantization	Provides quantization methods for scaling vector values to smaller data types and possibly fewer dimensions

Uses of KnnVectorValues in org.apache.lucene.analysis.synonym.word2vec

Subclasses of KnnVectorValues in org.apache.lucene.analysis.synonym.word2vec

Modifier and Type	Class	Description
class	Word2VecModel	Word2VecModel is a class representing the parsed Word2Vec model containing the vectors for each word in dictionary

Uses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene90

Subclasses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene90

Modifier and Type	Class	Description
(package private) static class	Lucene90HnswVectorsReader.OffHeapFloatVectorValues	Read the vector values from the index input.

Uses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene91

Subclasses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene91

Modifier and Type	Class	Description
(package private) static class	Lucene91HnswVectorsReader.OffHeapFloatVectorValues	Read the vector values from the index input.

Uses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene92

Subclasses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene92

Modifier and Type	Class	Description
(package private) class	OffHeapFloatVectorValues	Read the vector values from the index input.
(package private) static class	OffHeapFloatVectorValues.DenseOffHeapVectorValues
private static class	OffHeapFloatVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapFloatVectorValues.SparseOffHeapVectorValues

Uses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene94

Subclasses of KnnVectorValues in org.apache.lucene.backward_codecs.lucene94

Modifier and Type	Class	Description
(package private) class	OffHeapByteVectorValues	Read the vector values from the index input.
(package private) static class	OffHeapByteVectorValues.DenseOffHeapVectorValues
private static class	OffHeapByteVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapByteVectorValues.SparseOffHeapVectorValues
(package private) class	OffHeapFloatVectorValues	Read the vector values from the index input.
(package private) static class	OffHeapFloatVectorValues.DenseOffHeapVectorValues
private static class	OffHeapFloatVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapFloatVectorValues.SparseOffHeapVectorValues

Uses of KnnVectorValues in org.apache.lucene.codecs

Subclasses of KnnVectorValues in org.apache.lucene.codecs

Modifier and Type	Class	Description
private static class	BufferingKnnVectorsWriter.BufferedByteVectorValues
private static class	BufferingKnnVectorsWriter.BufferedFloatVectorValues
private static class	BufferingKnnVectorsWriter.SortingByteVectorValues	Sorting ByteVectorValues that iterate over documents in the order of the provided sortMap
private static class	BufferingKnnVectorsWriter.SortingFloatVectorValues	Sorting FloatVectorValues that iterate over documents in the order of the provided sortMap
(package private) static class	KnnVectorsWriter.MergedVectorValues.MergedByteVectorValues
(package private) static class	KnnVectorsWriter.MergedVectorValues.MergedFloat32VectorValues

Uses of KnnVectorValues in org.apache.lucene.codecs.bitvectors

Methods in org.apache.lucene.codecs.bitvectors with parameters of type KnnVectorValues

Modifier and Type	Method	Description
RandomVectorScorer	FlatBitVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)
RandomVectorScorer	FlatBitVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)
RandomVectorScorerSupplier	FlatBitVectorsScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)

Uses of KnnVectorValues in org.apache.lucene.codecs.hnsw

Methods in org.apache.lucene.codecs.hnsw with parameters of type KnnVectorValues

Modifier and Type	Method	Description
RandomVectorScorer	DefaultFlatVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)
RandomVectorScorer	DefaultFlatVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)
RandomVectorScorer	FlatVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)	Returns a RandomVectorScorer for the given set of vectors and target vector.
RandomVectorScorer	FlatVectorsScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)	Returns a RandomVectorScorer for the given set of vectors and target vector.
RandomVectorScorer	ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)
RandomVectorScorer	ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)
RandomVectorScorerSupplier	DefaultFlatVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)
RandomVectorScorerSupplier	FlatVectorsScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)	Returns a RandomVectorScorerSupplier that can be used to score vectors
RandomVectorScorerSupplier	ScalarQuantizedVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)

Uses of KnnVectorValues in org.apache.lucene.codecs.lucene95

Subclasses of KnnVectorValues in org.apache.lucene.codecs.lucene95

Modifier and Type	Class	Description
class	OffHeapByteVectorValues	Read the vector values from the index input.
static class	OffHeapByteVectorValues.DenseOffHeapVectorValues	Dense vector values that are stored off-heap.
private static class	OffHeapByteVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapByteVectorValues.SparseOffHeapVectorValues
class	OffHeapFloatVectorValues	Read the vector values from the index input.
static class	OffHeapFloatVectorValues.DenseOffHeapVectorValues	Dense vector values that are stored off-heap.
private static class	OffHeapFloatVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapFloatVectorValues.SparseOffHeapVectorValues

Uses of KnnVectorValues in org.apache.lucene.codecs.lucene99

Subclasses of KnnVectorValues in org.apache.lucene.codecs.lucene99

Modifier and Type	Class	Description
private static final class	Lucene99ScalarQuantizedVectorsReader.QuantizedVectorValues
(package private) static class	Lucene99ScalarQuantizedVectorsWriter.FloatVectorWrapper
(package private) static class	Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues	Returns a merged view over all the segment's QuantizedByteVectorValues.
(package private) static final class	Lucene99ScalarQuantizedVectorsWriter.NormalizedFloatVectorValues
(package private) static final class	Lucene99ScalarQuantizedVectorsWriter.OffsetCorrectedQuantizedByteVectorValues
(package private) static class	Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues
class	OffHeapQuantizedByteVectorValues	Read the quantized vector values and their score correction values from the index input.
static class	OffHeapQuantizedByteVectorValues.DenseOffHeapVectorValues	Dense vector values that are stored off-heap.
private static class	OffHeapQuantizedByteVectorValues.EmptyOffHeapVectorValues
private static class	OffHeapQuantizedByteVectorValues.SparseOffHeapVectorValues

Methods in org.apache.lucene.codecs.lucene99 with parameters of type KnnVectorValues

Modifier and Type	Method	Description
RandomVectorScorer	Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, byte[] target)
RandomVectorScorer	Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorer(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues, float[] target)
RandomVectorScorerSupplier	Lucene99ScalarQuantizedVectorScorer.getRandomVectorScorerSupplier(VectorSimilarityFunction similarityFunction, KnnVectorValues vectorValues)

Uses of KnnVectorValues in org.apache.lucene.codecs.simpletext

Subclasses of KnnVectorValues in org.apache.lucene.codecs.simpletext

Modifier and Type	Class	Description
private static class	SimpleTextKnnVectorsReader.SimpleTextByteVectorValues
private static class	SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues

Uses of KnnVectorValues in org.apache.lucene.index

Classes in org.apache.lucene.index with type parameters of type KnnVectorValues

Modifier and Type	Class	Description
private static final record	SlowCompositeCodecReaderWrapper.DocValuesSub<T extends KnnVectorValues>
private static class	SlowCompositeCodecReaderWrapper.MergedDocIterator<T extends KnnVectorValues>

Subclasses of KnnVectorValues in org.apache.lucene.index

Modifier and Type	Class	Description
class	ByteVectorValues	This class provides access to per-document floating point vector values indexed as KnnByteVectorField.
private class	ExitableDirectoryReader.ExitableFilterAtomicReader.ExitableByteVectorValues
private class	ExitableDirectoryReader.ExitableFilterAtomicReader.ExitableFloatVectorValues
class	FloatVectorValues	This class provides access to per-document floating point vector values indexed as KnnFloatVectorField.
(package private) class	SlowCompositeCodecReaderWrapper.SlowCompositeKnnVectorsReaderWrapper.MergedByteVectorValues
(package private) class	SlowCompositeCodecReaderWrapper.SlowCompositeKnnVectorsReaderWrapper.MergedFloatVectorValues
private static class	SortingCodecReader.SortingByteVectorValues
private static class	SortingCodecReader.SortingFloatVectorValues	Sorting FloatVectorValues that maps ordinals using the provided sortMap

Fields in org.apache.lucene.index declared as KnnVectorValues

Modifier and Type	Field	Description
private final T	SlowCompositeCodecReaderWrapper.DocValuesSub.sub	The field for the sub record component.

Methods in org.apache.lucene.index that return KnnVectorValues

Modifier and Type	Method	Description
abstract KnnVectorValues	KnnVectorValues.copy()	Creates a new copy of this KnnVectorValues.

Methods in org.apache.lucene.index with parameters of type KnnVectorValues

Modifier and Type	Method	Description
static SortingCodecReader.SortingIteratorSupplier	SortingCodecReader.iteratorSupplier(KnnVectorValues values, Sorter.DocMap docMap)	Creates a factory for SortingValuesIterator.

Uses of KnnVectorValues in org.apache.lucene.index.memory

Subclasses of KnnVectorValues in org.apache.lucene.index.memory

Modifier and Type	Class	Description
private static final class	MemoryIndex.MemoryByteVectorValues
private static final class	MemoryIndex.MemoryFloatVectorValues

Uses of KnnVectorValues in org.apache.lucene.sandbox.codecs.quantization

Subclasses of KnnVectorValues in org.apache.lucene.sandbox.codecs.quantization

Modifier and Type	Class	Description
class	SampleReader	A reader of vector values that samples a subset of the vectors.

Uses of KnnVectorValues in org.apache.lucene.util.hnsw

Fields in org.apache.lucene.util.hnsw declared as KnnVectorValues

Modifier and Type	Field	Description
private final KnnVectorValues	RandomVectorScorer.AbstractRandomVectorScorer.values

Methods in org.apache.lucene.util.hnsw with parameters of type KnnVectorValues

Modifier and Type	Method	Description
protected HnswBuilder	ConcurrentHnswMerger.createBuilder(KnnVectorValues mergedVectorValues, int maxOrd)
protected HnswBuilder	IncrementalHnswGraphMerger.createBuilder(KnnVectorValues mergedVectorValues, int maxOrd)	Builds a new HnswGraphBuilder using the biggest graph from the merge state as a starting point.
protected final int[]	IncrementalHnswGraphMerger.getNewOrdMapping(KnnVectorValues mergedVectorValues, BitSet initializedNodes)	Creates a new mapping from old ordinals to new ordinals and returns the total number of vectors in the newly merged segment.
OnHeapHnswGraph	HnswGraphMerger.merge(KnnVectorValues mergedVectorValues, InfoStream infoStream, int maxOrd)	Merge and produce the on heap graph
OnHeapHnswGraph	IncrementalHnswGraphMerger.merge(KnnVectorValues mergedVectorValues, InfoStream infoStream, int maxOrd)

Constructors in org.apache.lucene.util.hnsw with parameters of type KnnVectorValues

Modifier	Constructor	Description
	AbstractRandomVectorScorer(KnnVectorValues values)	Creates a new scorer for the given vector values.

Uses of KnnVectorValues in org.apache.lucene.util.quantization

Subclasses of KnnVectorValues in org.apache.lucene.util.quantization

Modifier and Type	Class	Description
class	QuantizedByteVectorValues	A version of ByteVectorValues, but additionally retrieving score correction offset for Scalar quantization scores.