Struct ParticleNeighborList 

pub struct ParticleNeighborList { /* private fields */ }

Cutoff-filtered neighbor helper for canonical massive-particle objects.

Implementations

impl ParticleNeighborList

pub fn from_bounds( min: &[f64], max: &[f64], cutoff: f64, ) -> Result<Self, ParticleNeighborListError>

Builds a particle neighbor list over explicit rectangular bounds.

pub fn from_box( dimensions: &[f64], cutoff: f64, ) -> Result<Self, ParticleNeighborListError>

Builds a particle neighbor list over [0, dimensions[k]] on each axis.

pub fn dim(&self) -> usize

Returns spatial dimension.

pub fn cutoff(&self) -> f64

Returns the physical cutoff distance.

pub fn rebuild( &mut self, objects: &PhysObj, ) -> Result<(), ParticleNeighborListError>

Rebuilds nearby-cell candidates from objects.core[ATTR_R].

pub fn collect_pairs( &self, objects: &PhysObj, selection: ParticleSelection, ) -> Result<Vec<(usize, usize)>, ParticleNeighborListError>

Collects physical neighbor pairs within cutoff.

Requires unchanged positions since rebuild; prefer rebuild_and_collect. The result contains unique unordered pairs (i, j) with i < j. With ParticleSelection::AliveOnly, pairs touching dead particles are skipped. Use ParticleSelection::All only when intentionally debugging or inspecting all allocated slots.

pub fn rebuild_and_collect( &mut self, objects: &PhysObj, selection: ParticleSelection, ) -> Result<Vec<(usize, usize)>, ParticleNeighborListError>

Rebuilds and queries current positions, preventing stale candidate use. Distance is strictly between zero and cutoff, with no periodic minimum image. Positions may be clipped into cells, but distance uses raw values.

pub fn rebuild_and_collect_into( &mut self, objects: &PhysObj, selection: ParticleSelection, output: &mut Vec<(usize, usize)>, ) -> Result<(), ParticleNeighborListError>

Rebuilds current positions and replaces a caller-owned pair buffer. Retains buffer capacity. Geometry/state errors leave output unchanged.

pub fn collect_pairs_into( &self, objects: &PhysObj, selection: ParticleSelection, output: &mut Vec<(usize, usize)>, ) -> Result<(), ParticleNeighborListError>

Queries a previously rebuilt list into a reusable output buffer. Positions and particle count must remain unchanged since rebuild; alive flags are read at query time. Rebuild-and-query is the normal safe path. Shape and mask errors are validated before replacing the output.

pub fn for_each_pair( &self, objects: &PhysObj, selection: ParticleSelection, visitor: impl FnMut(usize, usize), ) -> Result<(), ParticleNeighborListError>

Visits unique cutoff-filtered pairs without allocating a pair vector. Requires unchanged positions since the last rebuild. Queries before the first rebuild or after count changes fail; arbitrary position edits cannot be detected because particle attributes remain publicly mutable.

Trait Implementations

impl Clone for ParticleNeighborList

fn clone(&self) -> ParticleNeighborList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParticleNeighborList

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

Formats the value using the given formatter.