Module org.apache.lucene.backward_codecs

Package org.apache.lucene.backward_codecs.lucene94

Class OffHeapByteVectorValues.EmptyOffHeapVectorValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.ByteVectorValues

org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues.EmptyOffHeapVectorValues

All Implemented Interfaces:

RandomAccessVectorValues, RandomAccessVectorValues.Bytes

Enclosing class:

OffHeapByteVectorValues

private static class OffHeapByteVectorValues.EmptyOffHeapVectorValues
extends OffHeapByteVectorValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

OffHeapByteVectorValues.DenseOffHeapVectorValues

Nested classes/interfaces inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues

RandomAccessVectorValues.Bytes, RandomAccessVectorValues.Floats

Field Summary

Fields

Modifier and Type	Field	Description
private int	doc

Fields inherited from class org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

binaryValue, byteBuffer, byteSize, dimension, lastOrd, size, slice, vectorSimilarityFunction

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.
OffHeapByteVectorValues	copy()	Creates a new copy of this RandomAccessVectorValues.
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.
Bits	getAcceptOrds(Bits acceptDocs)	Returns the Bits representing live documents.
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)	Translates vector ordinal to the correct document ID.
VectorScorer	scorer(byte[] query)	Return a VectorScorer 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.
byte[]	vectorValue(int targetOrd)	Return the vector value indexed at the given ordinal.

Methods inherited from class org.apache.lucene.backward_codecs.lucene94.OffHeapByteVectorValues

load

Methods inherited from class org.apache.lucene.index.ByteVectorValues

checkField, 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

Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues

getSlice

Methods inherited from interface org.apache.lucene.util.hnsw.RandomAccessVectorValues.Bytes

getVectorByteLength

Field Details

doc

private int doc

Constructor Details

EmptyOffHeapVectorValues

public EmptyOffHeapVectorValues(int dimension)

Method Details

dimension

public int dimension()

Description copied from class: ByteVectorValues

Return the dimension of the vectors

Specified by:

dimension in interface RandomAccessVectorValues

Overrides:

dimension in class OffHeapByteVectorValues

size

public int size()

Description copied from class: ByteVectorValues

Return the number of vectors for this field.

Specified by:

size in interface RandomAccessVectorValues

Overrides:

size in class OffHeapByteVectorValues

Returns:

the number of vectors returned by this iterator

vectorValue

public byte[] vectorValue()
                   throws IOException

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 class ByteVectorValues

Returns:

the vector 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

copy

public OffHeapByteVectorValues copy()
                             throws IOException

Description copied from interface: RandomAccessVectorValues

Creates a new copy of this RandomAccessVectorValues. This is helpful when you need to access different values at once, to avoid overwriting the underlying vector returned.

Throws:

IOException

vectorValue

public byte[] vectorValue(int targetOrd)
                   throws IOException

Description copied from interface: RandomAccessVectorValues.Bytes

Return the vector value indexed at the given ordinal.

Specified by:

vectorValue in interface RandomAccessVectorValues.Bytes

Overrides:

vectorValue in class OffHeapByteVectorValues

Parameters:

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

Throws:

IOException

ordToDoc

public int ordToDoc(int ord)

Description copied from interface: RandomAccessVectorValues

Translates vector ordinal to the correct document ID. By default, this is an identity function.

Parameters:

ord - the vector ordinal

Returns:

the document Id for that vector ordinal

getAcceptOrds

public Bits getAcceptOrds(Bits acceptDocs)

Description copied from interface: RandomAccessVectorValues

Returns the Bits representing live documents. By default, this is an identity function.

Parameters:

acceptDocs - the accept docs

Returns:

the accept docs

scorer

public VectorScorer scorer(byte[] query)

Description copied from class: ByteVectorValues

Return a VectorScorer for the given query vector. The iterator for the scorer is not the same instance as the iterator for this ByteVectorValues. It is a copy, and iteration over the scorer will not affect the iteration of this ByteVectorValues.

Specified by:

scorer in class ByteVectorValues

Parameters:

query - the query vector

Returns:

a VectorScorer instance or null