Struct cell_map::CellMap

pub struct CellMap<L, T> where
    L: Layer,  { /* fields omitted */ }

Provides a many-layer 2D map of cellular data.

Implementations

impl<L, T> CellMap<L, T> where
    L: Layer, 

pub fn cell_size(&self) -> Vector2<f64>

Returns the size of the cells in the map.

pub fn num_cells(&self) -> Vector2<usize>

Returns the number of cells in each direction of the map.

pub fn iter(&self) -> CellMapIter<'_, L, T, Many<L>, Cells>

Returns an iterator over each cell in all layers of the map.

pub fn iter_mut(&mut self) -> CellMapIterMut<'_, L, T, Many<L>, Cells>

Returns a mutable iterator over each cell in all layers of the map.

pub fn window_iter(
    &self,
    semi_width: Vector2<usize>
) -> Result<CellMapIter<'_, L, T, Many<L>, Windows>, CellMapError>

Returns an iterator over windows of cells in the map.

The semi_width is half the size of the window in the x and y axes, not including the central cell. E.g. to have a window which is in total 5x5, the semi_window_size needs to be Vector2::new(2, 2).

pub fn window_iter_mut(
    &mut self,
    semi_width: Vector2<usize>
) -> Result<CellMapIterMut<'_, L, T, Many<L>, Windows>, CellMapError>

Returns a mutable iterator over windows of cells in the map.

The semi_width is half the size of the window in the x and y axes, not including the central cell. E.g. to have a window which is in total 5x5, the semi_window_size needs to be Vector2::new(2, 2).

impl<L, T> CellMap<L, T> where
    L: Layer,
    T: Clone, 

pub fn new_from_elem(params: CellMapParams, elem: T) -> Self

Creates a new CellMap from the given params, filling each cell with elem.

impl<L, T> CellMap<L, T> where
    L: Layer,
    T: Default + Clone, 

pub fn new(params: CellMapParams) -> Self

Creates a new CellMap from the given params, filling each cell with T::default().

Trait Implementations

impl<L: Clone, T: Clone> Clone for CellMap<L, T> where
    L: Layer, 

fn clone(&self) -> CellMap<L, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Debug, T: Debug> Debug for CellMap<L, T> where
    L: Layer, 

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

Formats the value using the given formatter.

impl<'de, L, T> Deserialize<'de> for CellMap<L, T> where
    L: Layer,
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<L, T> Index<L> for CellMap<L, T> where
    L: Layer, 

type Output = Array2<T>

The returned type after indexing.

fn index(&self, index: L) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<L, T> Serialize for CellMap<L, T> where
    L: Layer,
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.