README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

`acap`
======

[![crates.io](https://img.shields.io/crates/v/acap.svg)](https://crates.io/crates/acap)
[![Documentation](https://docs.rs/acap/badge.svg)](https://docs.rs/acap)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/tavianator/knn/blob/main/LICENSE)
[![CI Status](https://github.com/tavianator/acap/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/tavianator/acap/actions/workflows/ci.yml)

As Close As Possible — [nearest neighbor search] in Rust.

[nearest neighbor search]: https://en.wikipedia.org/wiki/Nearest_neighbor_search


Example
-------

```rust
use acap::euclid::Euclidean;
use acap::vp::VpTree;
use acap::NearestNeighbors;

let tree = VpTree::balanced(vec![
    Euclidean([3, 4]),
    Euclidean([5, 12]),
    Euclidean([8, 15]),
    Euclidean([7, 24]),
]);

let nearest = tree.nearest(&[7, 7]).unwrap();
assert_eq!(nearest.item, &Euclidean([3, 4]));
assert_eq!(nearest.distance, 5);
```