Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues

java.lang.Object

org.apache.lucene.index.KnnVectorValues

org.apache.lucene.index.FloatVectorValues

org.apache.lucene.codecs.simpletext.SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues

Enclosing class:

SimpleTextKnnVectorsReader

private static class SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues
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) int	curOrd
private final SimpleTextKnnVectorsReader.FieldEntry	entry
private final IndexInput	in
private final BytesRefBuilder	scratch
private final float[][]	values

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	SimpleTextFloatVectorValues(SimpleTextKnnVectorsReader.FieldEntry entry, IndexInput in)
private	SimpleTextFloatVectorValues(SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues other)

Method Summary

Modifier and Type	Method	Description
SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues	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.
private void	readAllVectors()
private void	readVector(float[] value)
VectorScorer	scorer(float[] target)	Return a VectorScorer for the given query vector and the current FloatVectorValues.
int	size()	Return the number of vectors for this field.
float[]	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.FloatVectorValues

checkField, fromFloats, getEncoding

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

scratch

private final BytesRefBuilder scratch

entry

private final SimpleTextKnnVectorsReader.FieldEntry entry

in

private final IndexInput in

values

private final float[][] values

curOrd

int curOrd

Constructor Details

SimpleTextFloatVectorValues

SimpleTextFloatVectorValues(SimpleTextKnnVectorsReader.FieldEntry entry,
 IndexInput in)
                     throws IOException

Throws:

IOException

SimpleTextFloatVectorValues

private SimpleTextFloatVectorValues(SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues other)

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 float[] vectorValue(int ord)

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

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

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(float[] target)

Description copied from class: FloatVectorValues

Return a VectorScorer for the given query vector and the current FloatVectorValues.

Overrides:

scorer in class FloatVectorValues

Parameters:

target - the query vector

Returns:

a VectorScorer instance or null

readAllVectors

private void readAllVectors()
                     throws IOException

Throws:

IOException

readVector

private void readVector(float[] value)
                 throws IOException

Throws:

IOException

copy

public SimpleTextKnnVectorsReader.SimpleTextFloatVectorValues 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 FloatVectorValues