Struct KdTree

Source
pub struct KdTree<A, const K: usize> { /* private fields */ }

Implementations§

Source§

impl<A: Float + Zero + One, const K: usize> KdTree<A, K>

Source

pub fn new() -> Self

Source

pub fn with_per_node_capacity(capacity: usize) -> Result<Self, ErrorKind>

Source

pub fn size(&self) -> usize

Source

pub fn is_leaf(&self) -> bool

Source

pub fn best_n_within<F>( &self, point: &[A; K], radius: A, max_qty: usize, distance: &F, ) -> Result<Vec<&[A; K]>, ErrorKind>
where F: Fn(&[A; K], &[A; K]) -> A,

Source

pub fn add(&mut self, point: &[A; K]) -> Result<(), ErrorKind>

Add an element to the tree. The first argument specifies the location in kd space at which the element is located. The second argument is the data associated with that point in space.

§Examples
use kiddo::KdTree;

let mut tree: KdTree<f64, 3> = KdTree::new();

tree.add(&[1.0, 2.0, 5.0])?;
tree.add(&[1.1, 2.1, 5.1])?;

assert_eq!(tree.size(), 2);

Trait Implementations§

Source§

impl<A: Clone, const K: usize> Clone for KdTree<A, K>

Source§

fn clone(&self) -> KdTree<A, K>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Debug, const K: usize> Debug for KdTree<A, K>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<A, const K: usize> Freeze for KdTree<A, K>
where A: Freeze,

§

impl<A, const K: usize> RefUnwindSafe for KdTree<A, K>
where A: RefUnwindSafe,

§

impl<A, const K: usize> Send for KdTree<A, K>
where A: Send,

§

impl<A, const K: usize> Sync for KdTree<A, K>
where A: Sync,

§

impl<A, const K: usize> Unpin for KdTree<A, K>
where A: Unpin,

§

impl<A, const K: usize> UnwindSafe for KdTree<A, K>
where A: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.