QuantizedByteVectorValues (Lucene 9.11.1 core API)

java.lang.Object
- org.apache.lucene.search.DocIdSetIterator
- - org.apache.lucene.util.quantization.QuantizedByteVectorValues

Direct Known Subclasses:

OffHeapQuantizedByteVectorValues
```
public abstract class QuantizedByteVectorValues
extends DocIdSetIterator
```
A version of ByteVectorValues, but additionally retrieving score correction offset for Scalar quantization scores.

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
Constructor Description

QuantizedByteVectorValues()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`cost()`	Returns the estimated cost of this `DocIdSetIterator`.
`abstract int`	`dimension()`	Return the dimension of the vectors
`abstract float`	`getScoreCorrectionConstant()`
`abstract VectorScorer`	`scorer(float[] query)`	Return a `VectorScorer` for the given query vector.
`abstract int`	`size()`	Return the number of vectors for this field.
`abstract byte[]`	`vectorValue()`

Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, docID, empty, nextDoc, range, slowAdvance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QuantizedByteVectorValues
```
public QuantizedByteVectorValues()
```
- Method Detail
  - getScoreCorrectionConstant
```
public abstract float getScoreCorrectionConstant()
                                          throws IOException
```
    Throws:
    
    IOException
  - vectorValue
```
public abstract byte[] vectorValue()
                            throws IOException
```
    Throws:
    
    IOException
  - 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: 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
  - scorer
```
public abstract VectorScorer scorer(float[] query)
                             throws IOException
```
    Return a VectorScorer for the given query vector.
    
    Parameters:
    
    query - the query vector
    
    Returns:
    
    a VectorScorer instance or null
    
    Throws:
    
    IOException