Struct ilyvion_util::multi_dimensional::Window2D

pub struct Window2D<T> { /* private fields */ }

This struct represents a two-dimensional window into a one-dimensional slice. This is accomplished through taking either a columns parameter, and dividing the size of the slice evenly into rows based on its length, or by taking rows and columns directly, trusting that the caller provided correct values. The latter option provides a zero-cost abstraction.

Example

let mut values = [0u32; 8];
let mut window = Window2D::new_mut(&mut values, 2);
window[0][1] = 1;
window[1][1] = 2;
window[2][1] = 3;
window[3][1] = 4;

assert_eq!(values, [0, 1, 0, 2, 0, 3, 0, 4]);

Implementations

impl<'b, T> Window2D<&'b mut [T]>

pub fn new_mut(raw: &'b mut [T], columns: usize) -> Self

Creates a new Window2D with rows divided into columns length. (I.e., w[rows][columns])

Panics

If the length of raw cannot be divided evenly into columns

pub fn new_mut_unchecked(raw: &'b mut [T], rows: usize, columns: usize) -> Self

Creates a new Window2D divided into rows number of slices with columns entries each.

Providing incorrect values for rows and columns will most likely lead to run-time panics due to indexing outside the range of the slice.

Using this constructor gives you an essentially zero-cost abstraction.

impl<'b, T> Window2D<&'b [T]>

pub fn new_ref(raw: &'b [T], columns: usize) -> Self

Creates a new Window2D with rows divided into columns length. (I.e., w[rows][columns])

Panics

If the length of raw cannot be divided evenly into columns

pub fn new_ref_unchecked(raw: &'b [T], rows: usize, columns: usize) -> Self

Creates a new Window2D divided into rows number of slices with columns entries each.

Providing incorrect values for rows and columns will most likely lead to run-time panics due to indexing outside the range of the slice.

Using this constructor gives you an essentially zero-cost abstraction.

Trait Implementations

impl<T: Debug> Debug for Window2D<T>

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

Formats the value using the given formatter.

impl<T> Index<(usize, usize)> for Window2D<&[T]>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, usize)> for Window2D<&mut [T]>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for Window2D<&[T]>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for Window2D<&mut [T]>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for Window2D<&mut [T]>

fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output

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

impl<T> IndexMut<usize> for Window2D<&mut [T]>

fn index_mut(&mut self, row: usize) -> &mut Self::Output

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