Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene99

Class Lucene99HnswVectorsWriter

java.lang.Object

org.apache.lucene.codecs.KnnVectorsWriter

org.apache.lucene.codecs.lucene99.Lucene99HnswVectorsWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

public final class Lucene99HnswVectorsWriter
extends KnnVectorsWriter

Writes vector values and knn graphs to index segments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Lucene99HnswVectorsWriter.FieldWriter<T>

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

KnnVectorsWriter.MergedVectorValues

Field Summary

Fields

Modifier and Type	Field	Description
private final int	beamWidth
private final List<Lucene99HnswVectorsWriter.FieldWriter<?>>	fields
private boolean	finished
private final FlatVectorsWriter	flatVectorWriter
private final int	M
private final TaskExecutor	mergeExec
private final IndexOutput	meta
private final int	numMergeWorkers
private final SegmentWriteState	segmentWriteState
private static final long	SHALLOW_RAM_BYTES_USED
private final IndexOutput	vectorIndex

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
Lucene99HnswVectorsWriter(SegmentWriteState state, int M, int beamWidth, FlatVectorsWriter flatVectorWriter, int numMergeWorkers, TaskExecutor mergeExec)

Method Summary

Modifier and Type	Method	Description
KnnFieldVectorsWriter<?>	addField(FieldInfo fieldInfo)	Add new field for indexing
void	close()
private HnswGraphMerger	createGraphMerger(FieldInfo fieldInfo, RandomVectorScorerSupplier scorerSupplier, TaskExecutor parallelMergeTaskExecutor, int numParallelMergeWorkers)
(package private) static int	distFuncToOrd(VectorSimilarityFunction func)
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
long	ramBytesUsed()	Return the memory usage of this object in bytes.
private HnswGraph	reconstructAndWriteGraph(OnHeapHnswGraph graph, int[] newToOldMap, int[] oldToNewMap, int[][] levelNodeOffsets)	Reconstructs the graph given the old and new node ids.
private void	reconstructAndWriteNeighbours(NeighborArray neighbors, int[] oldToNewMap, int maxOrd)
private void	writeField(Lucene99HnswVectorsWriter.FieldWriter<?> fieldData)
private int[][]	writeGraph(OnHeapHnswGraph graph)
private void	writeMeta(FieldInfo field, long vectorIndexOffset, long vectorIndexLength, int count, HnswGraph graph, int[][] graphLevelNodeOffsets)
private void	writeSortingField(Lucene99HnswVectorsWriter.FieldWriter<?> fieldData, Sorter.DocMap sortMap)

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

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

Field Details

SHALLOW_RAM_BYTES_USED

private static final long SHALLOW_RAM_BYTES_USED

segmentWriteState

private final SegmentWriteState segmentWriteState

meta

private final IndexOutput meta

vectorIndex

private final IndexOutput vectorIndex

M

private final int M

beamWidth

private final int beamWidth

flatVectorWriter

private final FlatVectorsWriter flatVectorWriter

numMergeWorkers

private final int numMergeWorkers

mergeExec

private final TaskExecutor mergeExec

fields

private final List<Lucene99HnswVectorsWriter.FieldWriter<?>> fields

finished

private boolean finished

Constructor Details

Lucene99HnswVectorsWriter

public Lucene99HnswVectorsWriter(SegmentWriteState state,
 int M,
 int beamWidth,
 FlatVectorsWriter flatVectorWriter,
 int numMergeWorkers,
 TaskExecutor mergeExec)
                          throws IOException

Throws:

IOException

Method Details

addField

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

Description copied from class: KnnVectorsWriter

Add new field for indexing

Specified by:

addField in class KnnVectorsWriter

Throws:

IOException

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

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

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

writeField

private void writeField(Lucene99HnswVectorsWriter.FieldWriter<?> fieldData)
                 throws IOException

Throws:

IOException

writeSortingField

private void writeSortingField(Lucene99HnswVectorsWriter.FieldWriter<?> fieldData,
 Sorter.DocMap sortMap)
                        throws IOException

Throws:

IOException

reconstructAndWriteGraph

private HnswGraph reconstructAndWriteGraph(OnHeapHnswGraph graph,
 int[] newToOldMap,
 int[] oldToNewMap,
 int[][] levelNodeOffsets)
                                    throws IOException

Reconstructs the graph given the old and new node ids.

Additionally, the graph node connections are written to the vectorIndex.

Parameters:

graph - The current on heap graph

newToOldMap - the new node ids indexed to the old node ids

oldToNewMap - the old node ids indexed to the new node ids

levelNodeOffsets - where to place the new offsets for the nodes in the vector index.

Returns:

The graph

Throws:

IOException - if writing to vectorIndex fails

reconstructAndWriteNeighbours

private void reconstructAndWriteNeighbours(NeighborArray neighbors,
 int[] oldToNewMap,
 int maxOrd)
                                    throws IOException

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

writeGraph

private int[][] writeGraph(OnHeapHnswGraph graph)
                    throws IOException

Parameters:

graph - Write the graph in a compressed format

Returns:

The non-cumulative offsets for the nodes. Should be used to create cumulative offsets.

Throws:

IOException - if writing to vectorIndex fails

writeMeta

private void writeMeta(FieldInfo field,
 long vectorIndexOffset,
 long vectorIndexLength,
 int count,
 HnswGraph graph,
 int[][] graphLevelNodeOffsets)
                throws IOException

Throws:

IOException

createGraphMerger

private HnswGraphMerger createGraphMerger(FieldInfo fieldInfo,
 RandomVectorScorerSupplier scorerSupplier,
 TaskExecutor parallelMergeTaskExecutor,
 int numParallelMergeWorkers)

close

public void close()
           throws IOException

Throws:

IOException

distFuncToOrd

static int distFuncToOrd(VectorSimilarityFunction func)