Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.util.quantization.QuantizedByteVectorValues

org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues

Enclosing class:

Lucene99ScalarQuantizedVectorsWriter

static class Lucene99ScalarQuantizedVectorsWriter.QuantizedFloatVectorValues
extends QuantizedByteVectorValues

Field Summary

Fields

Modifier and Type	Field	Description
private final float[]	normalizedVector
private float	offsetValue
private final byte[]	quantizedVector
private final ScalarQuantizer	quantizer
private final FloatVectorValues	values
private final VectorSimilarityFunction	vectorSimilarityFunction

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
QuantizedFloatVectorValues(FloatVectorValues values, VectorSimilarityFunction vectorSimilarityFunction, ScalarQuantizer quantizer)

Method Summary

Modifier and Type	Method	Description
int	advance(int target)	Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
int	dimension()	Return the dimension of the vectors
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
float	getScoreCorrectionConstant()
int	nextDoc()	Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set. NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
private void	quantize()
VectorScorer	scorer(float[] target)	Return a VectorScorer for the given query vector.
int	size()	Return the number of vectors for this field.
byte[]	vectorValue()

Methods inherited from class org.apache.lucene.util.quantization.QuantizedByteVectorValues

cost

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

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

Field Details

values

private final FloatVectorValues values

quantizer

private final ScalarQuantizer quantizer

quantizedVector

private final byte[] quantizedVector

normalizedVector

private final float[] normalizedVector

offsetValue

private float offsetValue

vectorSimilarityFunction

private final VectorSimilarityFunction vectorSimilarityFunction

Constructor Details

QuantizedFloatVectorValues

public QuantizedFloatVectorValues(FloatVectorValues values,
 VectorSimilarityFunction vectorSimilarityFunction,
 ScalarQuantizer quantizer)

Method Details

getScoreCorrectionConstant

public float getScoreCorrectionConstant()

Specified by:

getScoreCorrectionConstant in class QuantizedByteVectorValues

dimension

public int dimension()

Description copied from class: QuantizedByteVectorValues

Return the dimension of the vectors

Specified by:

dimension in class QuantizedByteVectorValues

size

public int size()

Description copied from class: QuantizedByteVectorValues

Return the number of vectors for this field.

Specified by:

size in class QuantizedByteVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue()
                   throws IOException

Specified by:

vectorValue in class QuantizedByteVectorValues

Throws:

IOException

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
• DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
• Otherwise it should return the doc ID it is currently on.

Specified by:

docID in class DocIdSetIterator

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Specified by:

nextDoc in class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target ≤ current , or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it behaves as if written:

 int advance(int target) {
   int doc;
   while ((doc = nextDoc()) < target) {
   }
   return doc;
 }
 

Some implementations are considerably more efficient than that.

NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

Specified by:

advance in class DocIdSetIterator

Throws:

IOException

scorer

public VectorScorer scorer(float[] target)
                    throws IOException

Description copied from class: QuantizedByteVectorValues

Return a VectorScorer for the given query vector.

Specified by:

scorer in class QuantizedByteVectorValues

Parameters:

target - the query vector

Returns:

a VectorScorer instance or null

Throws:

IOException

quantize

private void quantize()
               throws IOException

Throws:

IOException