Struct CubeSphereGrid

pub struct CubeSphereGrid<T, const S: usize> { /* private fields */ }

A grid that wraps a cube around a sphere in order to determine grid positions.

Type Parameters.

• T - The type of element stored in each grid cell.

Constant Parameters

• S - The size of each side of each face.

Trait Implementations

impl<T: Clone, const S: usize> Clone for CubeSphereGrid<T, S>

fn clone(&self) -> CubeSphereGrid<T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const S: usize> Debug for CubeSphereGrid<T, S>

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

Formats the value using the given formatter.

impl<T: Default, const S: usize> Default for CubeSphereGrid<T, S>

fn default() -> CubeSphereGrid<T, S>

Returns the “default value” for a type.

impl<T: Hash, const S: usize> Hash for CubeSphereGrid<T, S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, const S: usize> Index<CubeSpherePoint<S>> for CubeSphereGrid<T, S>

type Output = T

The returned type after indexing.

fn index(&self, index: CubeSpherePoint<S>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, const S: usize> IndexMut<CubeSpherePoint<S>> for CubeSphereGrid<T, S>

fn index_mut(&mut self, index: CubeSpherePoint<S>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, const S: usize> IntoIterator for CubeSphereGrid<T, S>

type Item = (CubeSpherePoint<S>, T)

The type of the elements being iterated over.

type IntoIter = IntoIter<<CubeSphereGrid<T, S> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq, const S: usize> PartialEq for CubeSphereGrid<T, S>

fn eq(&self, other: &CubeSphereGrid<T, S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Debug, const S: usize> SurfaceGrid<T> for CubeSphereGrid<T, S>

type Point = CubeSpherePoint<S>

The type of a point on this grid.

fn from_fn<F: FnMut(&Self::Point) -> T>(f: F) -> Self

Creates a new surface grid by calling the specified function for each point in the grid.

fn from_fn_par<F: Fn(&Self::Point) -> T + Send + Sync>(f: F) -> Self

where T: Send + Sync,

Creates a new surface grid by calling the specified function in parallel for each point in the grid.

fn set_from_fn<F: FnMut(&Self::Point) -> T>(&mut self, f: F)

Updates this surface grid by calling the specified function for each point in the grid.

fn set_from_fn_par<F: Fn(&Self::Point) -> T + Send + Sync>(&mut self, f: F)

where T: Send + Sync,

Updates this surface grid by calling the specified function for each point in the grid in parallel.

fn iter<'a>(&'a self) -> impl Iterator<Item = (Self::Point, &'a T)>

where T: 'a,

Iterates over the points in this grid and their values.

fn par_iter<'a>(&'a self) -> impl ParallelIterator<Item = (Self::Point, &'a T)>

where T: 'a + Send + Sync,

Iterates over the points in this grid and their values in parallel.

fn points(&self) -> impl Iterator<Item = Self::Point>

Iterates over the points in this grid.

fn par_points(&self) -> impl ParallelIterator<Item = Self::Point>

Iterates over the points in this grid in parallel.

fn for_each(&mut self, f: impl FnMut(&mut T))

Calls a function for each element on this grid.

fn for_each_with_position(&mut self, f: impl FnMut(&Self::Point, &mut T))

Calls a function for each element on this grid with the position.

fn par_for_each(&mut self, f: impl Fn(&mut T) + Sync)

where T: Send + Sync,

Calls a function for each element on this grid in parallel.

fn par_for_each_with_position( &mut self, f: impl Fn(&Self::Point, &mut T) + Sync, )

where T: Send + Sync,

Calls a function for each element on this grid with the position in parallel.

fn map_neighbours<F: FnMut(&T, &T, &T, &T, &T) -> T>(&self, f: F) -> Self

where Self: Sized,

Applies a function to each cell and its direct neighbours.

fn map_neighbours_diagonals<F: FnMut(&T, &T, &T, &T, &T, &T, &T, &T, &T) -> T>( &self, f: F, ) -> Self

where Self: Sized,

Applies a function to each cell and its direct neighbours including diagonals.

fn map_neighbours_par<F: Fn(&T, &T, &T, &T, &T) -> T + Send + Sync>( &self, f: F, ) -> Self

where Self: Sized + Sync, T: Send + Sync,

Applies a function in parallel to each cell and its direct neighbours.

fn map_neighbours_diagonals_par<F: Fn(&T, &T, &T, &T, &T, &T, &T, &T, &T) -> T + Send + Sync>( &self, f: F, ) -> Self

where Self: Sized + Sync, T: Send + Sync,

Applies a function in parallel to each cell and its direct neighbours including diagonals.

fn map_neighbours_with_position<F: FnMut(&T, &Self::Point, &T, &T, &T, &T) -> T>( &self, f: F, ) -> Self

where Self: Sized,

Applies a function to each cell and its direct neighbours providing the current point.

fn map_neighbours_diagonals_with_position<F: FnMut(&Self::Point, &T, &T, &T, &T, &T, &T, &T, &T, &T) -> T>( &self, f: F, ) -> Self

where Self: Sized,

Applies a function to each cell and its direct neighbours including diagonals providing the current point.

fn map_neighbours_par_with_position<F: Fn(&T, &Self::Point, &T, &T, &T, &T) -> T + Send + Sync>( &self, f: F, ) -> Self

where Self: Sized + Sync, T: Send + Sync,

Applies a function in parallel to each cell and its direct neighbours providing the current point.

fn map_neighbours_diagonals_par_with_position<F: Fn(&Self::Point, &T, &T, &T, &T, &T, &T, &T, &T, &T) -> T + Send + Sync>( &self, f: F, ) -> Self

where Self: Sized + Sync, T: Send + Sync,

Applies a function in parallel to each cell and its direct neighbours including diagonals providing the current point.

fn set_from_neighbours<U, G: SurfaceGrid<U, Point = Self::Point>, F: FnMut(&U, &U, &U, &U, &U) -> T>( &mut self, source: &G, f: F, )

Applies a function to each cell and its direct neighbours.

fn set_from_neighbours_diagonals<U, G: SurfaceGrid<U, Point = Self::Point>, F: FnMut(&U, &U, &U, &U, &U, &U, &U, &U, &U) -> T>( &mut self, source: &G, f: F, )

Applies a function to each cell and its direct neighbours including diagonals.

fn set_from_neighbours_par<U, G: SurfaceGrid<U, Point = Self::Point> + Sync, F: Fn(&U, &U, &U, &U, &U) -> T + Send + Sync>( &mut self, source: &G, f: F, )

where T: Send + Sync,

Applies a function to each cell and its direct neighbours in parallel.

fn set_from_neighbours_diagonals_par<U, G: SurfaceGrid<U, Point = Self::Point> + Sync, F: Fn(&U, &U, &U, &U, &U, &U, &U, &U, &U) -> T + Send + Sync>( &mut self, source: &G, f: F, )

where T: Send + Sync,

Applies a function to each cell and its direct neighbours including diagonals in parallel.

fn set_from_neighbours_with_position<U, G: SurfaceGrid<U, Point = Self::Point>, F: FnMut(&U, &Self::Point, &U, &U, &U, &U) -> T>( &mut self, source: &G, f: F, )

Applies a function to each cell and its direct neighbours providing the position.

fn set_from_neighbours_diagonals_with_position<U, G: SurfaceGrid<U, Point = Self::Point>, F: FnMut(&Self::Point, &U, &U, &U, &U, &U, &U, &U, &U, &U) -> T>( &mut self, source: &G, f: F, )

Applies a function to each cell and its direct neighbours including diagonals.

fn set_from_neighbours_par_with_position<U, G: SurfaceGrid<U, Point = Self::Point> + Sync, F: Fn(&U, &Self::Point, &U, &U, &U, &U) -> T + Send + Sync>( &mut self, source: &G, f: F, )

where T: Send + Sync,

Applies a function to each cell and its direct neighbours in parallel.

fn set_from_neighbours_diagonals_par_with_position<U, G: SurfaceGrid<U, Point = Self::Point> + Sync, F: Fn(&Self::Point, &U, &U, &U, &U, &U, &U, &U, &U, &U) -> T + Send + Sync>( &mut self, source: &G, f: F, )

where T: Send + Sync,

Applies a function to each cell and its direct neighbours including diagonals in parallel.

impl<T: Eq, const S: usize> Eq for CubeSphereGrid<T, S>

impl<T, const S: usize> StructuralPartialEq for CubeSphereGrid<T, S>