View source: R/HnswIndex-class.R
HnswIndex | R Documentation |
A class to hold indexing structures for the HNSW algorithm for approximate nearest neighbor identification.
HnswIndex(data, path, ef.search = 10, NAMES = NULL, distance = "Euclidean")
data |
A numeric matrix with data points in columns and dimensions in rows. |
path |
A string specifying the path to the index file. |
ef.search |
Integer scalar specifying the size of the dynamic list at run time. |
NAMES |
A character vector of sample names or |
distance |
A string specifying the distance metric to use. |
The HnswIndex class holds the indexing structure required to run the HNSW algorithm.
Users should never need to call the constructor explicitly, but should generate instances of HnswIndex classes with buildHnsw
.
Users can get values from an HnswIndex object with the usual [[
syntax.
All parameters listed in the constructor can be extracted in this manner.
An instance of the HnswIndex class.
Aaron Lun
buildHnsw
, to build the index.
BiocNeighborIndex, for the parent class and its available methods.
example(buildHnsw)
out[['path']]
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.