Package org.apache.lucene.codecs
Class KnnVectorsWriter.MergedVectorValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.VectorValues
-
- org.apache.lucene.codecs.KnnVectorsWriter.MergedVectorValues
-
- Enclosing class:
- KnnVectorsWriter
private static class KnnVectorsWriter.MergedVectorValues extends VectorValues
View over multiple VectorValues supporting iterator-style access via DocIdMerger.
-
-
Field Summary
Fields Modifier and Type Field Description private int
cost
private KnnVectorsWriter.VectorValuesSub
current
private int
docId
private DocIDMerger<KnnVectorsWriter.VectorValuesSub>
docIdMerger
private int
size
private java.util.List<KnnVectorsWriter.VectorValuesSub>
subs
-
Fields inherited from class org.apache.lucene.index.VectorValues
EMPTY, MAX_DIMENSIONS
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description private
MergedVectorValues(java.util.List<KnnVectorsWriter.VectorValuesSub> subs, MergeState mergeState)
-
Method Summary
All Methods Static 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.BytesRef
binaryValue()
Return the binary encoded vector value for the current document ID.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
dimension()
Return the dimension of the vectorsint
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.(package private) static KnnVectorsWriter.MergedVectorValues
mergeVectorValues(FieldInfo fieldInfo, MergeState mergeState)
Returns a merged view over all the segment'sVectorValues
.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.int
size()
TODO: should we use cost() for this? We rely on its always being exactly the number of documents having a value for this field, which is not guaranteed by the cost() contract, but in all the implementations so far they are the same.float[]
vectorValue()
Return the vector value for the current document ID.-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
subs
private final java.util.List<KnnVectorsWriter.VectorValuesSub> subs
-
docIdMerger
private final DocIDMerger<KnnVectorsWriter.VectorValuesSub> docIdMerger
-
cost
private final int cost
-
size
private final int size
-
docId
private int docId
-
current
private KnnVectorsWriter.VectorValuesSub current
-
-
Constructor Detail
-
MergedVectorValues
private MergedVectorValues(java.util.List<KnnVectorsWriter.VectorValuesSub> subs, MergeState mergeState) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
mergeVectorValues
static KnnVectorsWriter.MergedVectorValues mergeVectorValues(FieldInfo fieldInfo, MergeState mergeState) throws java.io.IOException
Returns a merged view over all the segment'sVectorValues
.- Throws:
java.io.IOException
-
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
-
vectorValue
public float[] vectorValue() throws java.io.IOException
Description copied from class:VectorValues
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 classVectorValues
- Returns:
- the vector value
- Throws:
java.io.IOException
-
binaryValue
public BytesRef binaryValue() throws java.io.IOException
Description copied from class:VectorValues
Return the binary encoded vector value for the current document ID. These are the bytes corresponding to the float array return byVectorValues.vectorValue()
. It is illegal to call this method when the iterator is not positioned: before advancing, or after failing to advance. The returned storage may be shared across calls, re-used and modified as the iterator advances.- Overrides:
binaryValue
in classVectorValues
- Returns:
- the binary value
- 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
-
size
public int size()
Description copied from class:VectorValues
TODO: should we use cost() for this? We rely on its always being exactly the number of documents having a value for this field, which is not guaranteed by the cost() contract, but in all the implementations so far they are the same.- Specified by:
size
in classVectorValues
- Returns:
- the number of vectors returned by this iterator
-
cost
public long cost()
Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
- Specified by:
cost
in classDocIdSetIterator
-
dimension
public int dimension()
Description copied from class:VectorValues
Return the dimension of the vectors- Specified by:
dimension
in classVectorValues
-
-