AnnoyIndex {BiocNeighbors} | R Documentation

## The AnnoyIndex class

### Description

A class to hold indexing structures for the Annoy algorithm for approximate nearest neighbor identification.

### Usage

    AnnoyIndex(data, path, search.mult=50, NAMES=NULL, distance="Euclidean")

    AnnoyIndex_path(x)

    ## S4 method for signature 'AnnoyIndex'
    show(object)

### Arguments

`data` | A numeric matrix with data points in columns and dimensions in rows.
`path` | A string specifying the path to the index file.
`search.mult` | Numeric scalar, multiplier for the number of points to search.
`NAMES` | A character vector of sample names or `NULL`.
`distance` | A string specifying the distance metric to use.
`x, object` | A AnnoyIndex object.

### Details

The AnnoyIndex class holds the indexing structure required to run the Annoy algorithm. Users should never need to call the constructor explicitly, but should generate instances of AnnoyIndex classes with `buildAnnoy`.

### Value

The `AnnoyIndex` constructor will return an instance of the AnnoyIndex class.

`AnnoyIndex_path` will return the path to the index file.

`AnnoyIndex_search_mult` will return the multiplier for the number of points to search.

### Author(s)

Aaron Lun

### See Also

`buildAnnoy`

### Examples

    example(buildAnnoy)
    str(AnnoyIndex_path(out))

[Package BiocNeighbors version 1.2.0 Index]