View source: R/VptreeIndex-class.R
VptreeIndex | R Documentation |
A class to hold the vantage point tree for exact nearest neighbor identification.
VptreeIndex(data, nodes, order, NAMES = NULL, distance = "Euclidean")
data |
A numeric matrix with data points in columns and dimensions in rows. |
nodes |
A list of vectors specifying the structure of the VP tree. |
order |
An integer vector of length equal to |
NAMES |
A character vector of sample names or |
distance |
A string specifying the distance metric to use. |
The VptreeIndex class holds the indexing structure required to run the VP tree algorithm.
Users should never need to call the constructor explicitly, but should generate instances of VptreeIndex classes with buildVptree
.
Users can get values from a VptreeIndex object with the usual [[
syntax.
All parameters listed in the constructor can be extracted in this manner.
An instance of the VptreeIndex class.
Aaron Lun
buildVptree
, for the index construction.
BiocNeighborIndex, for the parent class and its available methods.
example(buildVptree)
str(out[["nodes"]])
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.