Uses of Enum Class
org.apache.lucene.index.VectorEncoding
Packages that use VectorEncoding
Package
Description
Lucene 9.4 file format.
Lucene 9.5 file format.
Codecs API: API for customization of the encoding and structure of the index.
Lucene 9.4 file format.
Lucene 9.5 file format.
Lucene 9.9 file format.
Simpletext Codec: writes human readable postings.
The logical representation of a
Document
for indexing and
searching.Code to maintain and access indices.
A variety of functions to use with FunctionQuery.
-
Uses of VectorEncoding in org.apache.lucene.backward_codecs.lucene94
Fields in org.apache.lucene.backward_codecs.lucene94 declared as VectorEncodingModifier and TypeFieldDescriptionprivate final VectorEncoding
Lucene94HnswVectorsReader.FieldEntry.vectorEncoding
The field for thevectorEncoding
record component.Methods in org.apache.lucene.backward_codecs.lucene94 that return VectorEncodingModifier and TypeMethodDescriptionprivate VectorEncoding
Lucene94HnswVectorsReader.readVectorEncoding
(DataInput input) Lucene94HnswVectorsReader.FieldEntry.vectorEncoding()
Returns the value of thevectorEncoding
record component.Methods in org.apache.lucene.backward_codecs.lucene94 with parameters of type VectorEncodingModifier and TypeMethodDescription(package private) static Lucene94HnswVectorsReader.FieldEntry
Lucene94HnswVectorsReader.FieldEntry.create
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) Lucene94HnswVectorsReader.getFieldEntry
(String field, VectorEncoding expectedEncoding) Constructors in org.apache.lucene.backward_codecs.lucene94 with parameters of type VectorEncodingModifierConstructorDescription(package private)
FieldEntry
(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength) Creates an instance of aFieldEntry
record class. -
Uses of VectorEncoding in org.apache.lucene.backward_codecs.lucene95
Fields in org.apache.lucene.backward_codecs.lucene95 declared as VectorEncodingModifier and TypeFieldDescriptionprivate final VectorEncoding
Lucene95HnswVectorsReader.FieldEntry.vectorEncoding
The field for thevectorEncoding
record component.Methods in org.apache.lucene.backward_codecs.lucene95 that return VectorEncodingModifier and TypeMethodDescriptionprivate VectorEncoding
Lucene95HnswVectorsReader.readVectorEncoding
(DataInput input) Lucene95HnswVectorsReader.FieldEntry.vectorEncoding()
Returns the value of thevectorEncoding
record component.Methods in org.apache.lucene.backward_codecs.lucene95 with parameters of type VectorEncodingModifier and TypeMethodDescription(package private) static Lucene95HnswVectorsReader.FieldEntry
Lucene95HnswVectorsReader.FieldEntry.create
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) Lucene95HnswVectorsReader.getFieldEntry
(String field, VectorEncoding expectedEncoding) Constructors in org.apache.lucene.backward_codecs.lucene95 with parameters of type VectorEncodingModifierConstructorDescription(package private)
FieldEntry
(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, DirectMonotonicReader.Meta offsetsMeta, long offsetsOffset, int offsetsBlockShift, long offsetsLength, OrdToDocDISIReaderConfiguration ordToDocVectorValues) Creates an instance of aFieldEntry
record class. -
Uses of VectorEncoding in org.apache.lucene.codecs
Methods in org.apache.lucene.codecs with parameters of type VectorEncodingModifier and TypeMethodDescriptionprivate static void
KnnVectorsWriter.MergedVectorValues.validateFieldEncoding
(FieldInfo fieldInfo, VectorEncoding expected) -
Uses of VectorEncoding in org.apache.lucene.codecs.lucene94
Methods in org.apache.lucene.codecs.lucene94 that return VectorEncodingModifier and TypeMethodDescriptionprivate static VectorEncoding
Lucene94FieldInfosFormat.getVectorEncoding
(IndexInput input, byte b) -
Uses of VectorEncoding in org.apache.lucene.codecs.lucene95
Methods in org.apache.lucene.codecs.lucene95 with parameters of type VectorEncodingModifier and TypeMethodDescriptionstatic OffHeapByteVectorValues
OffHeapByteVectorValues.load
(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData) static OffHeapFloatVectorValues
OffHeapFloatVectorValues.load
(VectorSimilarityFunction vectorSimilarityFunction, FlatVectorsScorer flatVectorsScorer, OrdToDocDISIReaderConfiguration configuration, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, IndexInput vectorData) -
Uses of VectorEncoding in org.apache.lucene.codecs.lucene99
Fields in org.apache.lucene.codecs.lucene99 declared as VectorEncodingModifier and TypeFieldDescriptionprivate final VectorEncoding
Lucene99FlatVectorsReader.FieldEntry.vectorEncoding
The field for thevectorEncoding
record component.private final VectorEncoding
Lucene99HnswVectorsReader.FieldEntry.vectorEncoding
The field for thevectorEncoding
record component.private final VectorEncoding
Lucene99ScalarQuantizedVectorsReader.FieldEntry.vectorEncoding
The field for thevectorEncoding
record component.Methods in org.apache.lucene.codecs.lucene99 that return VectorEncodingModifier and TypeMethodDescriptionstatic VectorEncoding
Lucene99HnswVectorsReader.readVectorEncoding
(DataInput input) Lucene99FlatVectorsReader.FieldEntry.vectorEncoding()
Returns the value of thevectorEncoding
record component.Lucene99HnswVectorsReader.FieldEntry.vectorEncoding()
Returns the value of thevectorEncoding
record component.Lucene99ScalarQuantizedVectorsReader.FieldEntry.vectorEncoding()
Returns the value of thevectorEncoding
record component.Methods in org.apache.lucene.codecs.lucene99 with parameters of type VectorEncodingModifier and TypeMethodDescription(package private) static Lucene99HnswVectorsReader.FieldEntry
Lucene99HnswVectorsReader.FieldEntry.create
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) (package private) static Lucene99ScalarQuantizedVectorsReader.FieldEntry
Lucene99ScalarQuantizedVectorsReader.FieldEntry.create
(IndexInput input, int versionMeta, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) Lucene99FlatVectorsReader.getFieldEntry
(String field, VectorEncoding expectedEncoding) Lucene99HnswVectorsReader.getFieldEntry
(String field, VectorEncoding expectedEncoding) Constructors in org.apache.lucene.codecs.lucene99 with parameters of type VectorEncodingModifierConstructorDescription(package private)
FieldEntry
(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, int dimension, int size, OrdToDocDISIReaderConfiguration ordToDoc, FieldInfo info) Creates an instance of aFieldEntry
record class.private
FieldEntry
(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, DirectMonotonicReader.Meta offsetsMeta, long offsetsOffset, int offsetsBlockShift, long offsetsLength) Creates an instance of aFieldEntry
record class.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. -
Uses of VectorEncoding in org.apache.lucene.codecs.simpletext
Methods in org.apache.lucene.codecs.simpletext that return VectorEncodingModifier and TypeMethodDescriptionSimpleTextFieldInfosFormat.vectorEncoding
(String vectorEncoding) -
Uses of VectorEncoding in org.apache.lucene.document
Fields in org.apache.lucene.document declared as VectorEncodingMethods in org.apache.lucene.document that return VectorEncodingMethods in org.apache.lucene.document with parameters of type VectorEncodingModifier and TypeMethodDescriptionvoid
FieldType.setVectorAttributes
(int numDimensions, VectorEncoding encoding, VectorSimilarityFunction similarity) Enable vector indexing, with the specified number of dimensions and distance function. -
Uses of VectorEncoding in org.apache.lucene.index
Fields in org.apache.lucene.index declared as VectorEncodingModifier and TypeFieldDescriptionprivate final VectorEncoding
FieldInfo.vectorEncoding
private final VectorEncoding
FieldInfos.FieldVectorProperties.vectorEncoding
The field for thevectorEncoding
record component.private VectorEncoding
IndexingChain.FieldSchema.vectorEncoding
Methods in org.apache.lucene.index that return VectorEncodingModifier and TypeMethodDescriptionByteVectorValues.getEncoding()
FloatVectorValues.getEncoding()
abstract VectorEncoding
KnnVectorValues.getEncoding()
The vector encoding of these values.FieldInfo.getVectorEncoding()
Returns the number of dimensions of the vector valuestatic VectorEncoding
Returns the enum constant of this class with the specified name.static VectorEncoding[]
VectorEncoding.values()
Returns an array containing the constants of this enum class, in the order they are declared.FieldInfos.FieldVectorProperties.vectorEncoding()
Returns the value of thevectorEncoding
record component.IndexableFieldType.vectorEncoding()
TheVectorEncoding
of the field's vector valueMethods in org.apache.lucene.index with parameters of type VectorEncodingModifier and TypeMethodDescriptionprivate void
IndexingChain.indexVectorValue
(int docID, IndexingChain.PerField pf, VectorEncoding vectorEncoding, IndexableField field) (package private) void
IndexingChain.FieldSchema.setVectors
(VectorEncoding encoding, VectorSimilarityFunction similarityFunction, int dimension) (package private) static void
FieldInfo.verifySameVectorOptions
(String fieldName, int vd1, VectorEncoding ve1, VectorSimilarityFunction vsf1, int vd2, VectorEncoding ve2, VectorSimilarityFunction vsf2) Verify that the provided vector indexing options are the sameConstructors in org.apache.lucene.index with parameters of type VectorEncodingModifierConstructorDescriptionFieldInfo
(String name, int number, boolean storeTermVector, boolean omitNorms, boolean storePayloads, IndexOptions indexOptions, DocValuesType docValues, DocValuesSkipIndexType docValuesSkipIndex, long dvGen, Map<String, String> attributes, int pointDimensionCount, int pointIndexDimensionCount, int pointNumBytes, int vectorDimension, VectorEncoding vectorEncoding, VectorSimilarityFunction vectorSimilarityFunction, boolean softDeletesField, boolean isParentField) Sole constructor.private
FieldVectorProperties
(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) Creates an instance of aFieldVectorProperties
record class. -
Uses of VectorEncoding in org.apache.lucene.queries.function.valuesource
Methods in org.apache.lucene.queries.function.valuesource with parameters of type VectorEncodingModifier and TypeMethodDescription(package private) static void
VectorFieldFunction.checkField
(LeafReader in, String field, VectorEncoding expectedEncoding) Checks the Vector Encoding of a field