BiocNeighborIndex {BiocNeighbors} | R Documentation |
A virtual class for indexing structures of different nearest-neighbor search algorithms.
The BiocNeighborIndex class is a virtual base class on which other index objects are built. There are 2 concrete subclasses:
KmknnIndex
: exact nearest-neighbor search with the KMKNN algorithm.
AnnoyIndex
: approximate nearest-neighbor search with the Annoy algorithm.
These objects hold indexing structures for a given data set - see the associated documentation pages for more details. It also retains information about the dimensionality of the input data as well as the sample names.
show(object)
:Display the class and dimensions of a BiocNeighborIndex object
.
dimnames(x)
:Display the dimension names of a BiocNeighborIndex x
.
Aaron Lun
KmknnIndex
and AnnoyIndex
for direct constructors.
buildNNIndex
for construction on an actual data set.
findKNN
and queryKNN
for dispatch.