Module org.apache.lucene.memory

Package org.apache.lucene.index.memory

Class MemoryIndex.MemoryByteVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.index.memory.MemoryIndex.MemoryByteVectorValues

Enclosing class:

MemoryIndex

private static final class MemoryIndex.MemoryByteVectorValues
extends ByteVectorValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.KnnVectorValues

KnnVectorValues.DocIndexIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final MemoryIndex.Info	info

Constructor Summary

Constructors

Constructor	Description
MemoryByteVectorValues(MemoryIndex.Info info)

Method Summary

Modifier and Type	Method	Description
MemoryIndex.MemoryByteVectorValues	copy()	Creates a new copy of this KnnVectorValues.
int	dimension()	Return the dimension of the vectors
KnnVectorValues.DocIndexIterator	iterator()	Create an iterator for this instance.
VectorScorer	scorer(byte[] query)	Return a VectorScorer for the given query vector.
int	size()	Return the number of vectors for this field.
byte[]	vectorValue(int ord)	Return the vector value for the given vector ordinal which must be in [0, size() - 1], otherwise IndexOutOfBoundsException is thrown.

Methods inherited from class org.apache.lucene.index.ByteVectorValues

checkField, fromBytes, getEncoding

Methods inherited from class org.apache.lucene.index.KnnVectorValues

createDenseIterator, createSparseIterator, fromDISI, getAcceptOrds, getVectorByteLength, ordToDoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

info

private final MemoryIndex.Info info

Constructor Details

MemoryByteVectorValues

MemoryByteVectorValues(MemoryIndex.Info info)

Method Details

dimension

public int dimension()

Description copied from class: KnnVectorValues

Return the dimension of the vectors

Specified by:

dimension in class KnnVectorValues

size

public int size()

Description copied from class: KnnVectorValues

Return the number of vectors for this field.

Specified by:

size in class KnnVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue(int ord)

Description copied from class: ByteVectorValues

Return the vector value for the given vector ordinal which must be in [0, size() - 1], otherwise IndexOutOfBoundsException is thrown. The returned array may be shared across calls.

Specified by:

vectorValue in class ByteVectorValues

Returns:

the vector value

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues

scorer

public VectorScorer scorer(byte[] query)

Description copied from class: ByteVectorValues

Return a VectorScorer for the given query vector.

Overrides:

scorer in class ByteVectorValues

Parameters:

query - the query vector

Returns:

a VectorScorer instance or null

copy

public MemoryIndex.MemoryByteVectorValues copy()

Description copied from class: KnnVectorValues

Creates a new copy of this KnnVectorValues. This is helpful when you need to access different values at once, to avoid overwriting the underlying vector returned.

Specified by:

copy in class ByteVectorValues