Struct linfa_nn::BallTreeIndex
source · pub struct BallTreeIndex<'a, F: Float, D: Distance<F>> { /* private fields */ }
Expand description
Spatial indexing structure created by BallTree
Implementations§
Trait Implementations§
source§impl<'a, F: Clone + Float, D: Clone + Distance<F>> Clone for BallTreeIndex<'a, F, D>
impl<'a, F: Clone + Float, D: Clone + Distance<F>> Clone for BallTreeIndex<'a, F, D>
source§fn clone(&self) -> BallTreeIndex<'a, F, D>
fn clone(&self) -> BallTreeIndex<'a, F, D>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<'a, F: Float, D: Distance<F>> NearestNeighbourIndex<F> for BallTreeIndex<'a, F, D>
impl<'a, F: Float, D: Distance<F>> NearestNeighbourIndex<F> for BallTreeIndex<'a, F, D>
source§fn k_nearest<'b>(
&self,
point: ArrayView1<'b, F>,
k: usize
) -> Result<Vec<(ArrayView1<'_, F>, usize)>, NnError>
fn k_nearest<'b>( &self, point: ArrayView1<'b, F>, k: usize ) -> Result<Vec<(ArrayView1<'_, F>, usize)>, NnError>
Returns the
k
points in the index that are the closest to the provided point, along with
their positions in the original dataset. Points are returned in ascending order of the
distance away from the provided points, and less than k
points will be returned if the
index contains fewer than k
. Read moresource§fn within_range<'b>(
&self,
point: ArrayView1<'b, F>,
range: F
) -> Result<Vec<(ArrayView1<'_, F>, usize)>, NnError>
fn within_range<'b>( &self, point: ArrayView1<'b, F>, range: F ) -> Result<Vec<(ArrayView1<'_, F>, usize)>, NnError>
Returns all the points in the index that are within the specified distance to the provided
point, along with their positions in the original dataset. The points are not guaranteed to
be in any order, though many algorithms return the points in order of distance. Read more
source§impl<'a, F: PartialEq + Float, D: PartialEq + Distance<F>> PartialEq for BallTreeIndex<'a, F, D>
impl<'a, F: PartialEq + Float, D: PartialEq + Distance<F>> PartialEq for BallTreeIndex<'a, F, D>
source§fn eq(&self, other: &BallTreeIndex<'a, F, D>) -> bool
fn eq(&self, other: &BallTreeIndex<'a, F, D>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl<'a, F: Float, D: Distance<F>> StructuralPartialEq for BallTreeIndex<'a, F, D>
Auto Trait Implementations§
impl<'a, F, D> RefUnwindSafe for BallTreeIndex<'a, F, D>where
D: RefUnwindSafe,
F: RefUnwindSafe,
impl<'a, F, D> Send for BallTreeIndex<'a, F, D>
impl<'a, F, D> Sync for BallTreeIndex<'a, F, D>
impl<'a, F, D> Unpin for BallTreeIndex<'a, F, D>
impl<'a, F, D> UnwindSafe for BallTreeIndex<'a, F, D>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more