Package org.apache.lucene.codecs.lucene92

Class OffHeapVectorValues.DenseOffHeapVectorValues

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.DenseOffHeapVectorValues
All Implemented Interfaces:
RandomAccessVectorValues, RandomAccessVectorValuesProducer
Enclosing class:
OffHeapVectorValues
static class OffHeapVectorValues.DenseOffHeapVectorValues extends OffHeapVectorValues

  • Field Details

    • doc

      private int doc

  • Constructor Details

    • DenseOffHeapVectorValues

      public DenseOffHeapVectorValues(int dimension, int size, IndexInput slice)

  • Method Details

    • 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:
      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

    • 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

    • ordToDoc

      public int ordToDoc(int ord)
      Specified by:
      ordToDoc in class OffHeapVectorValues

    • getAcceptOrds

      Bits getAcceptOrds(Bits acceptDocs)
      Specified by:
      getAcceptOrds in class OffHeapVectorValues