Package org.apache.lucene.backward_codecs.lucene91

Class Lucene91HnswVectorsReader.OffHeapVectorValues

    • Constructor Summary

      Constructors 
      Constructor Description
      OffHeapVectorValues​(int dimension, int size, int[] ordToDoc, IndexInput dataIn)  

    • Method Summary

      All 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.
      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.
      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.
      RandomAccessVectorValues randomAccess()
      Return a random access interface over this iterator's vectors.
      private void readValue​(int targetOrd)  
      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 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • dimension

        private final int dimension

      • size

        private final int size

      • ordToDoc

        private final int[] ordToDoc

      • ordToDocOperator

        private final java.util.function.IntUnaryOperator ordToDocOperator

      • binaryValue

        private final BytesRef binaryValue

      • byteBuffer

        private final java.nio.ByteBuffer byteBuffer

      • byteSize

        private final int byteSize

      • value

        private final float[] value

      • ord

        private int ord

      • doc

        private int doc

    • Constructor Detail

      • OffHeapVectorValues

        OffHeapVectorValues​(int dimension,
                    int size,
                    int[] ordToDoc,
                    IndexInput dataIn)

    • Method Detail

      • 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
        Specified by:
        size in class VectorValues
        Returns:
        the number of vectors returned by this iterator

      • 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 class VectorValues
        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 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:
        java.io.IOException

      • nextDoc

        public int nextDoc()
        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

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

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

        Specified by:
        cost in class DocIdSetIterator

      • readValue

        private void readValue​(int targetOrd)
                throws java.io.IOException
        Throws:
        java.io.IOException