VptreeIndex: The VptreeIndex class

In BiocNeighbors: Nearest Neighbor Detection for Bioconductor Packages

Description

A class to hold the vantage point tree for exact nearest neighbor identification.

Usage

VptreeIndex(data, nodes, order, NAMES=NULL, distance="Euclidean")

VptreeIndex_nodes(x)

Arguments

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 ncol(data), specifying the order of observations.
NAMES	A character vector of sample names or NULL.
distance	A string specifying the distance metric to use.
x	A VptreeIndex object.

Details

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.

Value

The VptreeIndex constructor will return an instance of the VptreeIndex class.

VptreeIndex_nodes will return the corresponding slots of x.

Author(s)

Aaron Lun

See Also

buildVptree

Examples

example(buildVptree)
str(VptreeIndex_nodes(out))

BiocNeighbors documentation built on Dec. 9, 2020, 2:01 a.m.