Struct KDTree

pub struct KDTree<T, const N: usize>
where
    T: Copy + Default + NumOps + PartialOrd + Scalar + Zero,
{ /* private fields */ }

The Actual K-Dimensional Tree struct, contains it’s first node.

Generics

T: Either an f32 or f64 N: a const usize specifying how many dimensions should each point have.

Implementations

impl<T, const N: usize> KDTree<T, N>

where T: Copy + Default + NumOps + PartialOrd + Scalar + Zero,

pub fn insert(&mut self, data: Point<T, N>)

Inserts a new data points into the tree, taking into consideration it’s position.

Arguments

• data: a Point, to be inserted into the tree.

pub fn len(&self) -> usize

Returns the number of elements in the tree.

Returns

A usize representing the number of elements in the tree.

pub fn is_empty(&self) -> bool

Returns whether the tree is empty or not.

Returns

A bool representing whether the tree is empty or not.

pub fn nearest(&self, target: &Point<T, N>) -> Option<Point<T, N>>

Attempts to find the nearest point in the tree for the specified target point.

Arguments

• target: a Point, to search the closest point for.

Returns

None if the tree is empty, otherwise returns the closest Point.

pub fn traverse_tree<F: FnMut(&Point<T, N>)>(&self, func: F)

Allows traversal of the entire tree structure, calling the func closure on each branch’s data.

Arguments

• func: a closure of type Fn, it’s only parameter is a reference of the branch’s Point.

pub fn traverse_tree_mut<F: FnMut(&mut Point<T, N>)>(&mut self, func: F)

Allows traversal of the entire tree structure, calling the func closure on each branch’s data, possible mutating the data.

Arguments

• func: a closure of type FnMut, it’s only parameter is a reference of the branch’s Point.

Trait Implementations

impl<T, const N: usize> Clone for KDTree<T, N>

where T: Copy + Default + NumOps + PartialOrd + Scalar + Zero + Clone,

fn clone(&self) -> KDTree<T, N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, const N: usize> Debug for KDTree<T, N>

where T: Copy + Default + NumOps + PartialOrd + Scalar + Zero + Debug,

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

Formats the value using the given formatter.

impl<T, const N: usize> Default for KDTree<T, N>

where T: Copy + Default + NumOps + PartialOrd + Scalar + Zero + Default,

fn default() -> KDTree<T, N>

Returns the “default value” for a type.

impl<T, const N: usize> From<&[OPoint<T, Const<N>>]> for KDTree<T, N>

where T: Copy + Default + NumOps + PartialOrd + Scalar + Zero,

fn from(point_cloud: &[Point<T, N>]) -> Self

Converts to this type from the input type.