Struct splashsurf_lib::uniform_grid::Neighborhood

pub struct Neighborhood<'a, I: Index> { /* private fields */ }

Full neighborhood information of a point (denoted as origin point of the neighborhood)

Implementations

impl<'a, I: Index> Neighborhood<'a, I>

pub fn has_neighbor(&self, direction: DirectedAxis) -> bool

Returns if the origin point has a valid neighbor following the specified directed axis

pub fn get_neighbor(&self, direction: DirectedAxis) -> Option<&PointIndex<I>>

Get a specific neighbor in the given direction from the origin point of the neighborhood

pub fn get_neighbor_edge<'b>( &'b self, direction: DirectedAxis ) -> Option<NeighborEdge<'b, 'b, I>>

Get the edge to a specific neighbor in the given direction from the origin point of the neighborhood

pub fn neighbor_edge_iter<'b>( &'b self ) -> impl Iterator<Item = NeighborEdge<'b, 'b, I>>

Iterate over all valid neighbor points and the corresponding directed axis from the origin to the neighbor

Trait Implementations

impl<'a, I: Clone + Index> Clone for Neighborhood<'a, I>

fn clone(&self) -> Neighborhood<'a, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I: Debug + Index> Debug for Neighborhood<'a, I>

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

Formats the value using the given formatter.

impl<'a, I: PartialEq + Index> PartialEq<Neighborhood<'a, I>> for Neighborhood<'a, I>

fn eq(&self, other: &Neighborhood<'a, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, I: Copy + Index> Copy for Neighborhood<'a, I>

impl<'a, I: Eq + Index> Eq for Neighborhood<'a, I>

impl<'a, I: Index> StructuralEq for Neighborhood<'a, I>

impl<'a, I: Index> StructuralPartialEq for Neighborhood<'a, I>