Package org.apache.lucene.index
Class VectorValues.SortingVectorValues
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.VectorValues
org.apache.lucene.index.VectorValues.SortingVectorValues
- Enclosing class:
- VectorValues
Sorting VectorValues that iterate over documents in the order of the provided sortMap
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.VectorValues
VectorValues.SortingVectorValues
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private final int[]
private final RandomAccessVectorValues
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 -
Method Summary
Modifier and TypeMethodDescriptionint
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.Return the binary encoded vector value for the current document ID.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
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.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[]
Return the vector value for the current document ID.Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
randomAccess
-
docIdOffsets
private final int[] docIdOffsets -
docId
private int docId
-
-
Constructor Details
-
SortingVectorValues
SortingVectorValues(VectorValues delegate, Sorter.DocMap sortMap) throws IOException - Throws:
IOException
-
-
Method Details
-
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
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:
IOException
-
binaryValue
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:
IOException
-
vectorValue
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:
IOException
-
dimension
public int dimension()Description copied from class:VectorValues
Return the dimension of the vectors- Specified by:
dimension
in classVectorValues
-
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
-
advance
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
- Throws:
IOException
-
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
-