Struct acap::exhaustive::ExhaustiveSearch

pub struct ExhaustiveSearch<T>(_);

A NearestNeighbors implementation that does exhaustive search.

Implementations

impl<T> ExhaustiveSearch<T>

pub fn new() -> Self

Create an empty ExhaustiveSearch index.

pub fn push(&mut self, item: T)

Add a new item to the index.

pub fn len(&self) -> usize

Get the size of this index.

pub fn is_empty(&self) -> bool

Check if this index is empty.

Trait Implementations

impl<T: Debug> Debug for ExhaustiveSearch<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Default for ExhaustiveSearch<T>

fn default() -> Self

Returns the "default value" for a type.

impl<K: Proximity<V>, V> ExactNeighbors<K, V> for ExhaustiveSearch<V>

impl<T> Extend<T> for ExhaustiveSearch<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> FromIterator<T> for ExhaustiveSearch<T>

fn from_iter<I: IntoIterator<Item = T>>(items: I) -> Self

Creates a value from an iterator.

impl<T> IntoIterator for ExhaustiveSearch<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Proximity<V>, V> NearestNeighbors<K, V> for ExhaustiveSearch<V>

fn search<'k, 'v, N>(&'v self, neighborhood: N) -> N where
    K: 'k,
    V: 'v,
    N: Neighborhood<&'k K, &'v V>, 

Search for nearest neighbors and add them to a neighborhood.

fn nearest(&self, target: &K) -> Option<Neighbor<&V, K::Distance>>

Returns the nearest neighbor to target (or None if this index is empty).

fn nearest_within<D>(
    &self,
    target: &K,
    threshold: D
) -> Option<Neighbor<&V, K::Distance>> where
    D: TryInto<K::Distance>, 

Returns the nearest neighbor to target within the distance threshold, if one exists.

fn k_nearest(&self, target: &K, k: usize) -> Vec<Neighbor<&V, K::Distance>>

Returns the up to k nearest neighbors to target.

fn k_nearest_within<D>(
    &self,
    target: &K,
    k: usize,
    threshold: D
) -> Vec<Neighbor<&V, K::Distance>> where
    D: TryInto<K::Distance>, 

Returns the up to k nearest neighbors to target within the distance threshold.