Quadtree

Struct Quadtree 

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

The Quadtree data structure for 2D spatial searches

Implementations§

Source§

impl Quadtree

Source

pub fn new(points: &ArrayView2<'_, f64>) -> SpatialResult<Self>

Create a new quadtree from a set of 2D points

§Arguments
  • points - An array of 2D points
§Returns

A new Quadtree containing the points

§Errors

Returns an error if the points array is empty or if points don’t have 2 dimensions

Source

pub fn query_nearest( &self, query: &ArrayView1<'_, f64>, k: usize, ) -> SpatialResult<(Vec<usize>, Vec<f64>)>

Query the k nearest neighbors to a given point

§Arguments
  • query - The query point
  • k - The number of nearest neighbors to find
§Returns

A tuple of (indices, distances) where:

  • indices: Indices of the k nearest points in the original data
  • distances: Squared distances to those points
§Errors

Returns an error if the query point doesn’t have 2 dimensions or if k is 0

Source

pub fn query_radius( &self, query: &ArrayView1<'_, f64>, radius: f64, ) -> SpatialResult<(Vec<usize>, Vec<f64>)>

Query all points within a given radius of a point

§Arguments
  • query - The query point
  • radius - The search radius
§Returns

A tuple of (indices, distances) where:

  • indices: Indices of the points within the radius in the original data
  • distances: Squared distances to those points
§Errors

Returns an error if the query point doesn’t have 2 dimensions or if radius is negative

Source

pub fn points_in_region(&self, region: &BoundingBox2D) -> bool

Check if any points lie within a given region

§Arguments
  • region - A bounding box defining the region
§Returns

True if any points are in the region, false otherwise

Source

pub fn get_points_in_region(&self, region: &BoundingBox2D) -> Vec<usize>

Get all points that lie within a given region

§Arguments
  • region - A bounding box defining the region
§Returns

Indices of points that lie inside the region

Source

pub fn get_point(&self, index: usize) -> Option<Array1<f64>>

Retrieve the original coordinates of a point by its index

§Arguments
  • index - The index of the point in the original data
§Returns

The point coordinates, or None if the index is invalid

Source

pub fn size(&self) -> usize

Get the total number of points in the quadtree

§Returns

The number of points

Source

pub fn bounds(&self) -> Option<BoundingBox2D>

Get the bounding box of the quadtree

§Returns

The bounding box of the entire quadtree, or None if the tree is empty

Source

pub fn max_depth(&self) -> usize

Get the maximum depth of the quadtree

§Returns

The maximum depth of the tree

Trait Implementations§

Source§

impl Debug for Quadtree

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V