Struct flann::VecIndex

pub struct VecIndex<T: Indexable + 'static> { /* fields omitted */ }

Methods

impl<T: Indexable> VecIndex<T>

pub fn new<I, P>(
    point_len: usize,
    points: I,
    parameters: Parameters
) -> Result<Self, FlannError> where
    I: IntoIterator<Item = P>,
    P: IntoIterator<Item = T>, 

pub fn add(&mut self, point: Vec<T>) -> Result<(), FlannError>

Adds a point to the index.

pub fn add_many<I, P>(&mut self, points: I) -> Result<(), FlannError> where
    I: IntoIterator<Item = P>,
    P: IntoIterator<Item = T>, 

Adds multiple points to the index.

Methods from Deref<Target = SliceIndex<'static, T>>

pub fn add_slice(&mut self, point: &'a [T]) -> Result<(), FlannError>

Adds a point to the index.

pub fn add_many_slices(&mut self, points: &'a [T]) -> Result<(), FlannError>

Adds multiple points to the index.

pub fn get(&self, idx: usize) -> Option<&'a [T]>

Get the point that corresponds to this index idx.

pub fn remove(&mut self, idx: usize)

Removes a point at index idx.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn find_nearest_neighbor(
    &mut self,
    point: &[T]
) -> Result<Neighbor<T::ResultType>, FlannError>

Performs a search to find only the closest neighbor.

pub fn find_nearest_neighbors(
    &mut self,
    num: usize,
    point: &[T]
) -> Result<impl Iterator<Item = Neighbor<T::ResultType>>, FlannError>

Performs k-NN search for num neighbors. If there are less points in the set than num it returns that many neighbors.

pub fn find_nearest_neighbors_radius(
    &mut self,
    num: usize,
    radius_squared: f32,
    point: &[T]
) -> Result<impl Iterator<Item = Neighbor<T::ResultType>>, FlannError>

Performs k-NN search for num neighbors, limiting the search to radius distance. If there are less points in the set than num it returns that many neighbors.

The returned iterator is sorted by closest to furthest.

pub fn find_many_nearest_neighbors<I, P>(
    &mut self,
    num: usize,
    points: I
) -> Result<IntoChunks<impl Iterator<Item = Neighbor<T::ResultType>>>, FlannError> where
    I: IntoIterator<Item = P>,
    P: IntoIterator<Item = T>, 

Performs k-NN search for num neighbors for several points.

If there are less points in the set than num it returns that many neighbors for each point.

pub fn find_many_nearest_neighbors_flat(
    &mut self,
    num: usize,
    points: &[T]
) -> Result<IntoChunks<impl Iterator<Item = Neighbor<T::ResultType>>>, FlannError>

Performs k-NN search on num neighbors for several points.

If there are less points in the set than num it returns that many neighbors for each point.

This assumes points are already in a slice of memory in component order where there are point_len components (as specified in new or new_flat).

Trait Implementations

impl<T: Indexable> Drop for VecIndex<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Indexable> Deref for VecIndex<T>

type Target = SliceIndex<'static, T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Indexable> DerefMut for VecIndex<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.