Package io.github.jbellis.jvector.graph

Class SearchResult

java.lang.Object

io.github.jbellis.jvector.graph.SearchResult

public final class SearchResult
extends Object

Container class for results of an ANN search, along with associated metrics about the behavior of the search.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchResult.NodeScore

Constructor Summary

Constructors

Constructor	Description
SearchResult(SearchResult.NodeScore[] nodes, BitSet visited, int visitedCount)

Method Summary

Modifier and Type	Method	Description
SearchResult.NodeScore[]	getNodes()
int	getVisitedCount()

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResult

public SearchResult(SearchResult.NodeScore[] nodes,
 BitSet visited,
 int visitedCount)

Method Details

getNodes

public SearchResult.NodeScore[] getNodes()

Returns:

the closest neighbors discovered by the search, sorted best-first

getVisitedCount

public int getVisitedCount()

Returns:

the total number of graph nodes visited while performing the search