Package org.apache.lucene.backward_codecs.lucene90

Class Lucene90HnswVectorsReader.OffHeapHnswGraph

java.lang.Object

org.apache.lucene.util.hnsw.HnswGraph

org.apache.lucene.backward_codecs.lucene90.Lucene90HnswVectorsReader.OffHeapHnswGraph

Enclosing class:

Lucene90HnswVectorsReader

private static final class Lucene90HnswVectorsReader.OffHeapHnswGraph
extends HnswGraph

Read the nearest-neighbors graph from the index input

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.hnsw.HnswGraph

HnswGraph.NodesIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	arc
(package private) int	arcCount
(package private) int	arcUpTo
(package private) IndexInput	dataIn
(package private) Lucene90HnswVectorsReader.FieldEntry	entry

Fields inherited from class org.apache.lucene.util.hnsw.HnswGraph

EMPTY

Constructor Summary

Constructors

Constructor	Description
OffHeapHnswGraph(Lucene90HnswVectorsReader.FieldEntry entry, IndexInput dataIn)

Method Summary

Modifier and Type	Method	Description
int	entryNode()	Returns graph's entry point on the top level *
HnswGraph.NodesIterator	getNodesOnLevel(int level)	Get all nodes on a given level as node 0th ordinals
int	nextNeighbor()	Iterates over the neighbor list.
int	numLevels()	Returns the number of levels of the graph
void	seek(int level, int targetOrd)	Move the pointer to exactly the given level's target.
int	size()	Returns the number of nodes in the graph

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entry

final Lucene90HnswVectorsReader.FieldEntry entry

dataIn

final IndexInput dataIn

arcCount

int arcCount

arcUpTo

int arcUpTo

arc

int arc

Constructor Detail

OffHeapHnswGraph

OffHeapHnswGraph(Lucene90HnswVectorsReader.FieldEntry entry,
                 IndexInput dataIn)

Method Detail

seek

public void seek(int level,
                 int targetOrd)
          throws java.io.IOException

Description copied from class: HnswGraph

Move the pointer to exactly the given level's target. After this method returns, call HnswGraph.nextNeighbor() to return successive (ordered) connected node ordinals.

Specified by:

seek in class HnswGraph

Parameters:

level - level of the graph

targetOrd - ordinal of a node in the graph, must be ≥ 0 and < VectorValues.size().

Throws:

java.io.IOException

size

public int size()

Description copied from class: HnswGraph

Returns the number of nodes in the graph

Specified by:

size in class HnswGraph

nextNeighbor

public int nextNeighbor()
                 throws java.io.IOException

Description copied from class: HnswGraph

Iterates over the neighbor list. It is illegal to call this method after it returns NO_MORE_DOCS without calling HnswGraph.seek(int, int), which resets the iterator.

Specified by:

nextNeighbor in class HnswGraph

Returns:

a node ordinal in the graph, or NO_MORE_DOCS if the iteration is complete.

Throws:

java.io.IOException

numLevels

public int numLevels()

Description copied from class: HnswGraph

Returns the number of levels of the graph

Specified by:

numLevels in class HnswGraph

entryNode

public int entryNode()

Description copied from class: HnswGraph

Returns graph's entry point on the top level *

Specified by:

entryNode in class HnswGraph

getNodesOnLevel

public HnswGraph.NodesIterator getNodesOnLevel(int level)

Description copied from class: HnswGraph

Get all nodes on a given level as node 0th ordinals

Specified by:

getNodesOnLevel in class HnswGraph

Parameters:

level - level for which to get all nodes

Returns:

an iterator over nodes where nextInt returns a next node on the level