ExhaustiveIndex: The ExhaustiveIndex class

Description Usage Arguments Details Value See Also Examples

View source: R/ExhaustiveIndex-class.R

Description

A class to hold the data for exact nearest neighbor identification.

Usage

1
ExhaustiveIndex(data, NAMES = NULL, distance = "Euclidean")

Arguments

data

A numeric matrix with data points in columns and dimensions in rows.

NAMES

A character vector of sample names or NULL.

distance

A string specifying the distance metric to use.

Details

Users should never need to call the constructor explicitly, but should generate instances of ExhaustiveIndex classes with buildExhaustive.

Users can get values from an ExhaustiveIndex object with the usual [[ syntax. All parameters listed in the constructor can be extracted in this manner.

Value

An ExhaustiveIndex object.

See Also

buildExhaustive, for the index construction.

BiocNeighborIndex, for the parent class and its available methods.

Examples

1
2
3
example(buildExhaustive)
out[['distance']]
bndistance(out)

LTLA/BiocNeighbors documentation built on Sept. 18, 2021, 8:19 p.m.