VptreeParam {BiocNeighbors} | R Documentation

## The VptreeParam class

### Description

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

### Usage

    VptreeParam(distance = "Euclidean")

### Arguments

`distance` | A string specifying the distance metric to use.

### Value

An instance of the VptreeParam class.

### Author(s)

Aaron Lun

### See Also

`buildVptree`, for the index construction.

`findVptree` and related functions, for the actual search.

BiocNeighborParam, for the parent class and its available methods.

### Examples

    (out <- VptreeParam())

[Package BiocNeighbors version 1.10.0 Index]