core/org.gnit.lucenekmp.util.hnsw/NeighborArray

NeighborArray

class NeighborArray(maxSize: Int, scoresDescOrder: Boolean)

NeighborArray encodes the neighbors of a node and their mutual scores in the HNSW graph as a pair of growable arrays. Nodes are arranged in the sorted order of their scores in descending order (if scoresDescOrder is true), or in the ascending order of their scores (if scoresDescOrder is false)

Constructors

constructor(maxSize: Int, scoresDescOrder: Boolean)

Functions

addAndEnsureDiversity

fun addAndEnsureDiversity(newNode: Int, newScore: Float, nodeId: Int, scorer: UpdateableRandomVectorScorer)

In addition to .addOutOfOrder, this function will also remove the least-diverse node if the node array is full after insertion

fun addInOrder(newNode: Int, newScore: Float)

Add a new node to the NeighborArray. The new node must be worse than all previously stored nodes. This cannot be called after .addOutOfOrder

fun addOutOfOrder(newNode: Int, newScore: Float)

Add node and newScore but do not insert as sorted

fun clear()

fun insertSorted(newNode: Int, newScore: Float)

This method is for test only.

fun nodes(): IntArray

Direct access to the internal list of node ids; provided for efficient writing of the graph

fun removeIndex(idx: Int)

fun removeLast()

fun scores(): FloatArray

fun size(): Int

fun sort(scorer: RandomVectorScorer): IntArray?

Sort the array according to scores, and return the sorted indexes of previous unsorted nodes (unchecked nodes)

open override fun toString(): String