Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.util.quantization.QuantizedByteVectorValues

org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues

Enclosing class:

Lucene99ScalarQuantizedVectorsWriter

static class Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues
extends QuantizedByteVectorValues

Returns a merged view over all the segment's QuantizedByteVectorValues.

Field Summary

Fields

Modifier and Type	Field	Description
private Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub	current
private int	docId
private final DocIDMerger<Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub>	docIdMerger
private final int	size
private final List<Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub>	subs

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

NO_MORE_DOCS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MergedQuantizedVectorValues(List<Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub> subs, MergeState mergeState)

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()
static Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues	mergeQuantizedByteVectorValues(FieldInfo fieldInfo, MergeState mergeState, ScalarQuantizer scalarQuantizer)
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.
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

subs

private final List<Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub> subs

docIdMerger

private final DocIDMerger<Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub> docIdMerger

size

private final int size

docId

private int docId

current

private Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub current

Constructor Details

MergedQuantizedVectorValues

private MergedQuantizedVectorValues(List<Lucene99ScalarQuantizedVectorsWriter.QuantizedByteVectorValueSub> subs,
 MergeState mergeState)
                             throws IOException

Throws:

IOException

Method Details

mergeQuantizedByteVectorValues

public static Lucene99ScalarQuantizedVectorsWriter.MergedQuantizedVectorValues mergeQuantizedByteVectorValues(FieldInfo fieldInfo,
 MergeState mergeState,
 ScalarQuantizer scalarQuantizer)
                                                                                                       throws IOException

Throws:

IOException

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)

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

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

dimension

public int dimension()

Description copied from class: QuantizedByteVectorValues

Return the dimension of the vectors

Specified by:

dimension in class QuantizedByteVectorValues

getScoreCorrectionConstant

public float getScoreCorrectionConstant()
                                 throws IOException

Specified by:

getScoreCorrectionConstant in class QuantizedByteVectorValues

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