Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99ScalarQuantizedVectorsWriter.FieldWriter

java.lang.Object

org.apache.lucene.codecs.KnnFieldVectorsWriter<float[]>

org.apache.lucene.codecs.hnsw.FlatFieldVectorsWriter<float[]>

org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsWriter.FieldWriter

All Implemented Interfaces:

Accountable

Enclosing class:

Lucene99ScalarQuantizedVectorsWriter

static class Lucene99ScalarQuantizedVectorsWriter.FieldWriter
extends FlatFieldVectorsWriter<float[]>

Field Summary

Fields

Modifier and Type	Field	Description
private final byte	bits
private final boolean	compress
private final Float	confidenceInterval
private final FieldInfo	fieldInfo
private boolean	finished
private final FlatFieldVectorsWriter<float[]>	flatFieldVectorsWriter
private final InfoStream	infoStream
private final boolean	normalize
private static final long	SHALLOW_SIZE

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
FieldWriter(Float confidenceInterval, byte bits, boolean compress, FieldInfo fieldInfo, InfoStream infoStream, FlatFieldVectorsWriter<float[]> indexWriter)

Method Summary

Modifier and Type	Method	Description
void	addValue(int docID, float[] vectorValue)	Add new docID with its vector value to the given field for indexing.
float[]	copyValue(float[] vectorValue)	Used to copy values being indexed to internal storage.
(package private) ScalarQuantizer	createQuantizer()
void	finish()	indicates that this writer is done and no new vectors are allowed to be added
DocsWithFieldSet	getDocsWithFieldSet()
List<float[]>	getVectors()
boolean	isFinished()
long	ramBytesUsed()	Return the memory usage of this object in bytes.

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

Field Details

SHALLOW_SIZE

private static final long SHALLOW_SIZE

fieldInfo

private final FieldInfo fieldInfo

confidenceInterval

private final Float confidenceInterval

bits

private final byte bits

compress

private final boolean compress

infoStream

private final InfoStream infoStream

normalize

private final boolean normalize

finished

private boolean finished

flatFieldVectorsWriter

private final FlatFieldVectorsWriter<float[]> flatFieldVectorsWriter

Constructor Details

FieldWriter

FieldWriter(Float confidenceInterval,
 byte bits,
 boolean compress,
 FieldInfo fieldInfo,
 InfoStream infoStream,
 FlatFieldVectorsWriter<float[]> indexWriter)

Method Details

isFinished

public boolean isFinished()

Specified by:

isFinished in class FlatFieldVectorsWriter<float[]>

Returns:

true if the writer is done and no new vectors are allowed to be added

finish

public void finish()
            throws IOException

Description copied from class: FlatFieldVectorsWriter

indicates that this writer is done and no new vectors are allowed to be added

Specified by:

finish in class FlatFieldVectorsWriter<float[]>

Throws:

IOException - if an I/O error occurs

createQuantizer

ScalarQuantizer createQuantizer()
                         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.

addValue

public void addValue(int docID,
 float[] vectorValue)
              throws IOException

Description copied from class: KnnFieldVectorsWriter

Add new docID with its vector value to the given field for indexing. Doc IDs must be added in increasing order.

Specified by:

addValue in class KnnFieldVectorsWriter<float[]>

Throws:

IOException

copyValue

public float[] copyValue(float[] vectorValue)

Description copied from class: KnnFieldVectorsWriter

Used to copy values being indexed to internal storage.

Specified by:

copyValue in class KnnFieldVectorsWriter<float[]>

Parameters:

vectorValue - an array containing the vector value to add

Returns:

a copy of the value; a new array

getVectors

public List<float[]> getVectors()

Specified by:

getVectors in class FlatFieldVectorsWriter<float[]>

Returns:

a list of vectors to be written

getDocsWithFieldSet

public DocsWithFieldSet getDocsWithFieldSet()

Specified by:

getDocsWithFieldSet in class FlatFieldVectorsWriter<float[]>

Returns:

the docsWithFieldSet for the field writer