Uses of Enum Class
org.apache.lucene.index.VectorEncoding

Packages that use VectorEncoding

Package	Description
org.apache.lucene.backward_codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.codecs.lucene95	Lucene 9.5 file format.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.util.hnsw	Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.

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

Fields in org.apache.lucene.backward_codecs.lucene94 declared as VectorEncoding

Modifier and Type	Field	Description
(package private) final VectorEncoding	Lucene94HnswVectorsReader.FieldEntry.vectorEncoding

Methods in org.apache.lucene.backward_codecs.lucene94 that return VectorEncoding

Modifier and Type	Method	Description
private VectorEncoding	Lucene94HnswVectorsReader.readVectorEncoding(DataInput input)

Constructors in org.apache.lucene.backward_codecs.lucene94 with parameters of type VectorEncoding

Modifier	Constructor	Description
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

Uses of VectorEncoding in org.apache.lucene.codecs.lucene94

Methods in org.apache.lucene.codecs.lucene94 that return VectorEncoding

Modifier and Type	Method	Description
private static VectorEncoding	Lucene94FieldInfosFormat.getVectorEncoding(IndexInput input, byte b)

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

Fields in org.apache.lucene.codecs.lucene95 declared as VectorEncoding

Modifier and Type	Field	Description
(package private) final VectorEncoding	Lucene95HnswVectorsReader.FieldEntry.vectorEncoding

Methods in org.apache.lucene.codecs.lucene95 that return VectorEncoding

Modifier and Type	Method	Description
private VectorEncoding	Lucene95HnswVectorsReader.readVectorEncoding(DataInput input)

Constructors in org.apache.lucene.codecs.lucene95 with parameters of type VectorEncoding

Modifier	Constructor	Description
(package private)	FieldEntry(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

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

Methods in org.apache.lucene.codecs.simpletext that return VectorEncoding

Modifier and Type	Method	Description
VectorEncoding	SimpleTextFieldInfosFormat.vectorEncoding(String vectorEncoding)

Uses of VectorEncoding in org.apache.lucene.document

Fields in org.apache.lucene.document declared as VectorEncoding

Modifier and Type	Field	Description
private VectorEncoding	FieldType.vectorEncoding

Methods in org.apache.lucene.document that return VectorEncoding

Modifier and Type	Method	Description
VectorEncoding	FieldType.vectorEncoding()

Methods in org.apache.lucene.document with parameters of type VectorEncoding

Modifier and Type	Method	Description
void	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 VectorEncoding

Modifier and Type	Field	Description
private final VectorEncoding	FieldInfo.vectorEncoding
(package private) final VectorEncoding	FieldInfos.FieldVectorProperties.vectorEncoding
private VectorEncoding	IndexingChain.FieldSchema.vectorEncoding

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

Modifier and Type	Method	Description
VectorEncoding	FieldInfo.getVectorEncoding()	Returns the number of dimensions of the vector value
static VectorEncoding	VectorEncoding.valueOf(String name)	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.
VectorEncoding	IndexableFieldType.vectorEncoding()	The VectorEncoding of the field's vector value

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

Modifier and Type	Method	Description
private 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 same

Constructors in org.apache.lucene.index with parameters of type VectorEncoding

Modifier	Constructor	Description
	FieldInfo(String name, int number, boolean storeTermVector, boolean omitNorms, boolean storePayloads, IndexOptions indexOptions, DocValuesType docValues, long dvGen, Map<String,String> attributes, int pointDimensionCount, int pointIndexDimensionCount, int pointNumBytes, int vectorDimension, VectorEncoding vectorEncoding, VectorSimilarityFunction vectorSimilarityFunction, boolean softDeletesField)	Sole constructor.
(package private)	FieldVectorProperties(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)

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

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

Modifier and Type	Field	Description
private final VectorEncoding	HnswGraphBuilder.vectorEncoding
private final VectorEncoding	HnswGraphSearcher.vectorEncoding

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

Modifier and Type	Method	Description
static <T> HnswGraphBuilder<T>	HnswGraphBuilder.create(RandomAccessVectorValues<T> vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, int M, int beamWidth, long seed)
static NeighborQueue	HnswGraphSearcher.search(byte[] query, int topK, RandomAccessVectorValues<byte[]> vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, HnswGraph graph, Bits acceptOrds, int visitedLimit)	Searches HNSW graph for the nearest neighbors of a query vector.
static NeighborQueue	HnswGraphSearcher.search(float[] query, int topK, RandomAccessVectorValues<float[]> vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, HnswGraph graph, Bits acceptOrds, int visitedLimit)	Searches HNSW graph for the nearest neighbors of a query vector.

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

Modifier	Constructor	Description
private	HnswGraphBuilder(RandomAccessVectorValues<T> vectors, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, int M, int beamWidth, long seed)	Reads all the vectors from vector values, builds a graph connecting them by their dense ordinals, using the given hyperparameter settings, and returns the resulting graph.
	HnswGraphSearcher(VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction, NeighborQueue candidates, BitSet visited)	Creates a new graph searcher.