Package org.apache.lucene.codecs.lucene92

Class OffHeapVectorValues.EmptyOffHeapVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.VectorValues

org.apache.lucene.codecs.lucene92.OffHeapVectorValues

org.apache.lucene.codecs.lucene92.OffHeapVectorValues.EmptyOffHeapVectorValues

All Implemented Interfaces:

RandomAccessVectorValues, RandomAccessVectorValuesProducer

Enclosing class:

OffHeapVectorValues

private static class OffHeapVectorValues.EmptyOffHeapVectorValues
extends OffHeapVectorValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues

OffHeapVectorValues.DenseOffHeapVectorValues

Field Summary

Fields

Modifier and Type	Field	Description
private int	doc

Fields inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues

binaryValue, byteBuffer, byteSize, dimension, size, slice, value

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

Constructor	Description
EmptyOffHeapVectorValues(int dimension)

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.
BytesRef	binaryValue()	Return the binary encoded vector value for the current document ID.
BytesRef	binaryValue(int targetOrd)	Return the vector indexed at the given ordinal value as an array of bytes in a BytesRef; these are the bytes corresponding to the float array.
long	cost()	Returns the estimated cost of this DocIdSetIterator.
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.
(package private) Bits	getAcceptOrds(Bits acceptDocs)
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.
int	ordToDoc(int ord)
RandomAccessVectorValues	randomAccess()	Return a random access interface over this iterator's vectors.
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.
float[]	vectorValue(int targetOrd)	Return the vector value indexed at the given ordinal.

Methods inherited from class org.apache.lucene.codecs.lucene92.OffHeapVectorValues

load

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

doc

private int doc

Constructor Details

EmptyOffHeapVectorValues

public EmptyOffHeapVectorValues(int dimension)

Method Details

dimension

public int dimension()

Description copied from class: VectorValues

Return the dimension of the vectors

Specified by:

dimension in interface RandomAccessVectorValues

Overrides:

dimension in class OffHeapVectorValues

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 interface RandomAccessVectorValues

Overrides:

size in class OffHeapVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public float[] vectorValue()
                    throws 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 class VectorValues

Returns:

the vector value

Throws:

IOException

binaryValue

public BytesRef binaryValue()
                     throws 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 by VectorValues.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 class VectorValues

Returns:

the binary value

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

cost

public long cost()

Description copied from class: DocIdSetIterator

Returns the estimated cost of this DocIdSetIterator.

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.

Overrides:

cost in class OffHeapVectorValues

randomAccess

public RandomAccessVectorValues randomAccess()
                                      throws IOException

Description copied from interface: RandomAccessVectorValuesProducer

Return a random access interface over this iterator's vectors. Calling the RandomAccess methods will have no effect on the progress of the iteration or the values returned by this iterator. Successive calls will retrieve independent copies that do not overwrite each others' returned values.

Throws:

IOException

vectorValue

public float[] vectorValue(int targetOrd)
                    throws IOException

Description copied from interface: RandomAccessVectorValues

Return the vector value indexed at the given ordinal. The provided floating point array may be shared and overwritten by subsequent calls to this method and RandomAccessVectorValues.binaryValue(int).

Specified by:

vectorValue in interface RandomAccessVectorValues

Overrides:

vectorValue in class OffHeapVectorValues

Parameters:

targetOrd - a valid ordinal, ≥ 0 and < RandomAccessVectorValues.size().

Throws:

IOException

binaryValue

public BytesRef binaryValue(int targetOrd)
                     throws IOException

Description copied from interface: RandomAccessVectorValues

Return the vector indexed at the given ordinal value as an array of bytes in a BytesRef; these are the bytes corresponding to the float array. The provided bytes may be shared and overwritten by subsequent calls to this method and RandomAccessVectorValues.vectorValue(int).

Specified by:

binaryValue in interface RandomAccessVectorValues

Overrides:

binaryValue in class OffHeapVectorValues

Parameters:

targetOrd - a valid ordinal, ≥ 0 and < RandomAccessVectorValues.size().

Throws:

IOException

ordToDoc

public int ordToDoc(int ord)

Specified by:

ordToDoc in class OffHeapVectorValues

getAcceptOrds

Bits getAcceptOrds(Bits acceptDocs)

Specified by:

getAcceptOrds in class OffHeapVectorValues