Package org.apache.lucene.codecs.lucene104

Class Lucene104ScalarQuantizedVectorsWriter

java.lang.Object

org.apache.lucene.codecs.KnnVectorsWriter

org.apache.lucene.codecs.hnsw.FlatVectorsWriter

org.apache.lucene.codecs.lucene104.Lucene104ScalarQuantizedVectorsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

public class Lucene104ScalarQuantizedVectorsWriter
extends FlatVectorsWriter

Writes quantized vector values and metadata to index segments in the format for Lucene 10.4.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.KnnVectorsWriter

KnnVectorsWriter.MergedVectorValues

Field Summary

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
Lucene104ScalarQuantizedVectorsWriter(SegmentWriteState state, Lucene104ScalarQuantizedVectorsFormat.ScalarEncoding encoding, FlatVectorsWriter rawVectorDelegate, Lucene104ScalarQuantizedVectorScorer vectorsScorer)	Sole constructor

Method Summary

Modifier and Type	Method	Description
FlatFieldVectorsWriter<?>	addField(FieldInfo fieldInfo)	Add a new field for indexing
void	close()
void	finish()	Called once at the end before close
void	flush(int maxDoc, Sorter.DocMap sortMap)	Flush all buffered data on disk *
void	mergeOneField(FieldInfo fieldInfo, MergeState mergeState)	Write field for merging
CloseableRandomVectorScorerSupplier	mergeOneFieldToIndex(FieldInfo fieldInfo, MergeState mergeState)	Write the field for merging, providing a scorer over the newly merged flat vectors.
long	ramBytesUsed()	Return the memory usage of this object in bytes.

Methods inherited from class org.apache.lucene.codecs.hnsw.FlatVectorsWriter

getFlatVectorScorer

Methods inherited from class org.apache.lucene.codecs.KnnVectorsWriter

mapOldOrdToNewOrd, merge

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

getChildResources

Constructor Details

Lucene104ScalarQuantizedVectorsWriter

public Lucene104ScalarQuantizedVectorsWriter(SegmentWriteState state,
 Lucene104ScalarQuantizedVectorsFormat.ScalarEncoding encoding,
 FlatVectorsWriter rawVectorDelegate,
 Lucene104ScalarQuantizedVectorScorer vectorsScorer)
                                      throws IOException

Sole constructor

Throws:

IOException

Method Details

addField

public FlatFieldVectorsWriter<?> addField(FieldInfo fieldInfo)
                                   throws IOException

Description copied from class: FlatVectorsWriter

Add a new field for indexing

Specified by:

addField in class FlatVectorsWriter

Parameters:

fieldInfo - fieldInfo of the field to add

Returns:

a writer for the field

Throws:

IOException - if an I/O error occurs when adding the field

flush

public void flush(int maxDoc,
 Sorter.DocMap sortMap)
           throws IOException

Description copied from class: KnnVectorsWriter

Flush all buffered data on disk *

Specified by:

flush in class KnnVectorsWriter

Throws:

IOException

finish

public void finish()
            throws IOException

Description copied from class: KnnVectorsWriter

Called once at the end before close

Specified by:

finish in class KnnVectorsWriter

Throws:

IOException

mergeOneField

public void mergeOneField(FieldInfo fieldInfo,
 MergeState mergeState)
                   throws IOException

Description copied from class: KnnVectorsWriter

Write field for merging

Overrides:

mergeOneField in class KnnVectorsWriter

Throws:

IOException

mergeOneFieldToIndex

public CloseableRandomVectorScorerSupplier mergeOneFieldToIndex(FieldInfo fieldInfo,
 MergeState mergeState)
                                                         throws IOException

Description copied from class: FlatVectorsWriter

Write the field for merging, providing a scorer over the newly merged flat vectors. This way any additional merging logic can be implemented by the user of this class.

Specified by:

mergeOneFieldToIndex in class FlatVectorsWriter

Parameters:

fieldInfo - fieldInfo of the field to merge

mergeState - mergeState of the segments to merge

Returns:

a scorer over the newly merged flat vectors, which should be closed as it holds a temporary file handle to read over the newly merged vectors

Throws:

IOException - if an I/O error occurs when merging

close

public void close()
           throws IOException

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.