Skip to main content

PointIndex

Struct PointIndex 

Source
pub struct PointIndex { /* private fields */ }
Expand description

A k-d tree over points, split at the median of each cell’s widest axis.

Holds its own copy of the points.

Implementations§

Source§

impl PointIndex

Source

pub fn build(points: &[Point]) -> OgeomResult<Self>

Build the tree over a cloud.

§Errors

OgeomError::Numeric if a point is not finite, and OgeomError::Range for a cloud of more than four billion points.

Source

pub fn len(&self) -> usize

How many points the tree holds.

Source

pub fn is_empty(&self) -> bool

Whether the tree holds no point.

Source

pub fn points(&self) -> Vec<Point>

The points the tree was built over, in their cloud order.

Source

pub fn nearest(&self, p: Point, max: f64) -> Option<Neighbour>

The point nearest p, no farther than max; the lowest index among equally near ones. max may be infinite.

Source

pub fn nearest_many(&self, points: &[Point], max: f64) -> Vec<Option<Neighbour>>

PointIndex::nearest for each point, in parallel, answers in point order.

Source

pub fn k_nearest(&self, p: Point, k: usize, max: f64) -> Vec<Neighbour>

The k points nearest p no farther than max, nearest first, ties in index order: fewer where fewer are that near.

Source

pub fn within_ball(&self, centre: Point, radius: f64) -> Vec<u32>

Every point within radius of centre, in index order.

Trait Implementations§

Source§

impl Clone for PointIndex

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PointIndex

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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)
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> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.