Module org.apache.lucene.core

Package org.apache.lucene.codecs

Class BufferingKnnVectorsWriter.SortingByteVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.codecs.BufferingKnnVectorsWriter.SortingByteVectorValues

Enclosing class:

BufferingKnnVectorsWriter

private static class BufferingKnnVectorsWriter.SortingByteVectorValues
extends ByteVectorValues

Sorting ByteVectorValues that iterate over documents in the order of the provided sortMap

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 BufferingKnnVectorsWriter.BufferedByteVectorValues	delegate
private final Supplier<SortingCodecReader.SortingValuesIterator>	iteratorSupplier

Constructor Summary

Constructors

Constructor	Description
SortingByteVectorValues(BufferingKnnVectorsWriter.BufferedByteVectorValues delegate, DocsWithFieldSet docsWithField, Sorter.DocMap sortMap)

Method Summary

Modifier and Type	Method	Description
BufferingKnnVectorsWriter.SortingByteVectorValues	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.
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, scorer

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

delegate

private final BufferingKnnVectorsWriter.BufferedByteVectorValues delegate

iteratorSupplier

private final Supplier<SortingCodecReader.SortingValuesIterator> iteratorSupplier

Constructor Details

SortingByteVectorValues

SortingByteVectorValues(BufferingKnnVectorsWriter.BufferedByteVectorValues delegate,
 DocsWithFieldSet docsWithField,
 Sorter.DocMap sortMap)
                 throws IOException

Throws:

IOException

Method Details

vectorValue

public byte[] vectorValue(int ord)
                   throws IOException

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

Throws:

IOException

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

copy

public BufferingKnnVectorsWriter.SortingByteVectorValues 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

iterator

public KnnVectorValues.DocIndexIterator iterator()

Description copied from class: KnnVectorValues

Create an iterator for this instance.

Overrides:

iterator in class KnnVectorValues