Module org.apache.lucene.core

Package org.apache.lucene.codecs

Class BufferingKnnVectorsWriter.BufferedFloatVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.FloatVectorValues

org.apache.lucene.codecs.BufferingKnnVectorsWriter.BufferedFloatVectorValues

Enclosing class:

BufferingKnnVectorsWriter

private static class BufferingKnnVectorsWriter.BufferedFloatVectorValues
extends FloatVectorValues

Nested Class Summary

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

KnnVectorValues.DocIndexIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	dimension
private final DocIdSet	docsWithField
private final KnnVectorValues.DocIndexIterator	iterator
(package private) final List<float[]>	vectors

Constructor Summary

Constructors

Constructor	Description
BufferedFloatVectorValues(List<float[]> vectors, int dimension, DocIdSet docsWithField)

Method Summary

Modifier and Type	Method	Description
BufferingKnnVectorsWriter.BufferedFloatVectorValues	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	ordToDoc(int ord)	Return the docid of the document indexed with the given vector ordinal.
int	size()	Return the number of vectors for this field.
float[]	vectorValue(int targetOrd)	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.FloatVectorValues

checkField, fromFloats, getEncoding, scorer

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

createDenseIterator, createSparseIterator, fromDISI, getAcceptOrds, getVectorByteLength

Methods inherited from class java.lang.Object

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

Field Details

vectors

final List<float[]> vectors

dimension

final int dimension

docsWithField

private final DocIdSet docsWithField

iterator

private final KnnVectorValues.DocIndexIterator iterator

Constructor Details

BufferedFloatVectorValues

BufferedFloatVectorValues(List<float[]> vectors,
 int dimension,
 DocIdSet docsWithField)
                   throws IOException

Throws:

IOException

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

ordToDoc

public int ordToDoc(int ord)

Description copied from class: KnnVectorValues

Return the docid of the document indexed with the given vector ordinal. This default implementation returns the argument and is appropriate for dense values implementations where every doc has a single value.

Overrides:

ordToDoc in class KnnVectorValues

vectorValue

public float[] vectorValue(int targetOrd)

Description copied from class: FloatVectorValues

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 FloatVectorValues

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

copy

public BufferingKnnVectorsWriter.BufferedFloatVectorValues copy()
                                                         throws IOException

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 FloatVectorValues

Throws:

IOException