ExhaustiveIndex {BiocNeighbors} | R Documentation

## The ExhaustiveIndex class

### Description

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

### Usage

    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

    example(buildExhaustive)
    out[['distance']]
    bndistance(out)

[Package BiocNeighbors version 1.12.0 Index]