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

NeighborQueue

class NeighborQueue(initialSize: Int, maxHeap: Boolean)

NeighborQueue uses a LongHeap to store lists of arcs in an HNSW graph, represented as a neighbor node id with an associated score packed together as a sortable long, which is sorted primarily by score. The queue provides both fixed-size and unbounded operations via .insertWithOverflow and .add, and provides MIN and MAX heap subclasses.

Constructors

NeighborQueue

constructor(initialSize: Int, maxHeap: Boolean)

Functions

add

fun add(newNode: Int, newScore: Float)

Adds a new graph arc, extending the storage as needed.

clear

fun clear()

incomplete

fun incomplete(): Boolean

insertWithOverflow

fun insertWithOverflow(newNode: Int, newScore: Float): Boolean

If the heap is not full (size is less than the initialSize provided to the constructor), adds a new node-and-score element. If the heap is full, compares the score against the current top score, and replaces the top element if newScore is better than (greater than unless the heap is reversed), the current top score.

markIncomplete

fun markIncomplete()

nodes

fun nodes(): IntArray

pop

fun pop(): Int

Removes the top element and returns its node id.

setVisitedCount

fun setVisitedCount(visitedCount: Int)

size

fun size(): Int

topNode