Struct flann::Index

pub struct Index<T: Indexable, N: ArrayLength<T>> { /* fields omitted */ }

Methods

impl<T: Indexable, N: ArrayLength<T>> Index<T, N>

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

pub fn add(&mut self, point: GenericArray<T, N>)

Adds a point to the index.

pub fn add_multiple<I>(&mut self, points: I) where
    I: IntoIterator<Item = GenericArray<T, N>>, 

Adds multiple points to the index.

pub fn get(&self, idx: usize) -> Option<&GenericArray<T, N>>

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: &GenericArray<T, N>
) -> Neighbor<T::ResultType>

Performs a search to find only the closest neighbor.

pub fn find_nearest_neighbors(
    &mut self,
    num: usize,
    point: &GenericArray<T, N>
) -> impl Iterator<Item = Neighbor<T::ResultType>>

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: &GenericArray<T, N>
) -> impl Iterator<Item = Neighbor<T::ResultType>>

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_many_nearest_neighbors(
    &mut self,
    num: usize,
    points: &[GenericArray<T, N>]
) -> IntoChunks<impl Iterator<Item = Neighbor<T::ResultType>>>

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.

Trait Implementations

impl<T: Indexable, N: ArrayLength<T>> Drop for Index<T, N>

fn drop(&mut self)

Executes the destructor for this type.