Package org.apache.lucene.index
Class FloatVectorValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.FloatVectorValues
-
- Direct Known Subclasses:
OffHeapFloatVectorValues,VectorValues
public abstract class FloatVectorValues extends DocIdSetIterator
This class provides access to per-document floating point vector values indexed asKnnFloatVectorField.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFloatVectorValues()Sole constructor
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description longcost()Returns the estimated cost of thisDocIdSetIterator.abstract intdimension()Return the dimension of the vectorsabstract intsize()Return the number of vectors for this field.abstract float[]vectorValue()Return the vector value for the current document ID.-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, docID, empty, nextDoc, range, slowAdvance
-
-
-
-
Method Detail
-
dimension
public abstract int dimension()
Return the dimension of the vectors
-
size
public abstract int size()
Return the number of vectors for this field.- Returns:
- the number of vectors returned by this iterator
-
cost
public final long cost()
Description copied from class:DocIdSetIteratorReturns 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:
costin classDocIdSetIterator
-
vectorValue
public abstract float[] vectorValue() throws IOExceptionReturn 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.- Returns:
- the vector value
- Throws:
IOException
-
-