ExhaustiveParam: The ExhaustiveParam class

Description Usage Arguments Value Author(s) See Also Examples

View source: R/ExhaustiveParam-class.R

Description

A class to hold parameters for the exhaustive algorithm for exact nearest neighbor identification.

Usage

1
ExhaustiveParam(distance = "Euclidean")

Arguments

distance

A string specifying the distance metric to use.

Value

An instance of the ExhaustiveParam class.

Author(s)

Allison Vuong

See Also

buildExhaustive, for the index construction.

findExhaustive and related functions, for the actual search.

BiocNeighborParam, for the parent class and its available methods.

Examples

1
(out <- ExhaustiveParam())

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