Module org.apache.lucene.core
Package org.apache.lucene.codecs
Class BufferingKnnVectorsWriter.BufferedByteVectorValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.ByteVectorValues
-
- org.apache.lucene.codecs.BufferingKnnVectorsWriter.BufferedByteVectorValues
-
- Enclosing class:
- BufferingKnnVectorsWriter
private static class BufferingKnnVectorsWriter.BufferedByteVectorValues extends ByteVectorValues
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
dimension
(package private) DocsWithFieldSet
docsWithField
(package private) DocIdSetIterator
docsWithFieldIter
(package private) int
ord
(package private) java.util.List<byte[]>
vectors
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description BufferedByteVectorValues(DocsWithFieldSet docsWithField, java.util.List<byte[]> vectors, int dimension)
-
Method Summary
All Methods Instance Methods Concrete Methods 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.BufferingKnnVectorsWriter.BufferedByteVectorValues
copy()
int
dimension()
Return the dimension of the vectorsint
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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(byte[] target)
Return aVectorScorer
for the given query vector.int
size()
Return the number of vectors for this field.byte[]
vectorValue()
Return the vector value for the current document ID.(package private) byte[]
vectorValue(int targetOrd)
-
Methods inherited from class org.apache.lucene.index.ByteVectorValues
checkField, cost
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
docsWithField
final DocsWithFieldSet docsWithField
-
vectors
final java.util.List<byte[]> vectors
-
dimension
final int dimension
-
docsWithFieldIter
DocIdSetIterator docsWithFieldIter
-
ord
int ord
-
-
Constructor Detail
-
BufferedByteVectorValues
BufferedByteVectorValues(DocsWithFieldSet docsWithField, java.util.List<byte[]> vectors, int dimension)
-
-
Method Detail
-
copy
public BufferingKnnVectorsWriter.BufferedByteVectorValues copy()
-
dimension
public int dimension()
Description copied from class:ByteVectorValues
Return the dimension of the vectors- Specified by:
dimension
in classByteVectorValues
-
size
public int size()
Description copied from class:ByteVectorValues
Return the number of vectors for this field.- Specified by:
size
in classByteVectorValues
- Returns:
- the number of vectors returned by this iterator
-
vectorValue
public byte[] vectorValue()
Description copied from class:ByteVectorValues
Return the vector value for the current document ID. It is illegal to call this method when the iterator is not positioned: before advancing, or after failing to advance. The returned array may be shared across calls, re-used, and modified as the iterator advances.- Specified by:
vectorValue
in classByteVectorValues
- Returns:
- the vector value
-
vectorValue
byte[] vectorValue(int targetOrd)
-
docID
public int docID()
Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.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 classDocIdSetIterator
-
nextDoc
public int nextDoc() throws java.io.IOException
Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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 classDocIdSetIterator
- Throws:
java.io.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 returnsDocIdSetIterator.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 classDocIdSetIterator
-
scorer
public VectorScorer scorer(byte[] target)
Description copied from class:ByteVectorValues
Return aVectorScorer
for the given query vector. The iterator for the scorer is not the same instance as the iterator for thisByteVectorValues
. It is a copy, and iteration over the scorer will not affect the iteration of thisByteVectorValues
.- Specified by:
scorer
in classByteVectorValues
- Parameters:
target
- the query vector- Returns:
- a
VectorScorer
instance or null
-
-