Struct KdTree 

pub struct KdTree<'a> { /* private fields */ }

A balanced static k-dimensional tree over selected atoms.

Construction uses linear-time median partitioning at each level, for O(n log n) total work and one flat node allocation.

Implementations

impl<'a> KdTree<'a>

pub fn build( positions: &'a [[f32; 3]], targets: &[u32], periodic: Option<PeriodicBox>, ) -> Result<Self, SpatialError>

Builds a balanced tree over finite target positions.

Errors

Returns an error when a target index is outside positions.

pub fn build_with_options( positions: &'a [[f32; 3]], targets: &[u32], periodic: Option<PeriodicBox>, periodic_options: KdPeriodicOptions, ) -> Result<Self, SpatialError>

Builds a balanced tree with an explicit periodic image budget.

Errors

Returns an error for invalid options or target indices.

pub fn pairs( &self, query: &[u32], cutoff: f32, ) -> Result<Vec<NeighborPair>, SpatialError>

Finds all indexed pairs within cutoff.

Errors

Returns an error for an invalid cutoff or query index.

pub fn k_nearest( &self, query: u32, count: usize, ) -> Result<Vec<(u32, f32)>, SpatialError>

Returns the nearest count targets in increasing distance order.

Errors

Returns an error when query is outside the coordinate array.

Trait Implementations

impl<'a> Debug for KdTree<'a>

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

Formats the value using the given formatter.