Struct ilyvion_util::multi_dimensional::Vec2D

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

This struct represents a two-dimensional window into a one-dimensional Vec. This is accomplished through taking either a columns parameter, and dividing the size of the Vec 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 window = Vec2D::from(vec![0u32; 8], 2);
window[0][1] = 1;
window[1][1] = 2;
window[2][1] = 3;
window[3][1] = 4;

let values = window.into_inner();

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

Implementations

impl<T> Vec2D<T>

pub fn new_with<F>(rows: usize, columns: usize, func: F) -> Selfwhere F: FnMut(usize, usize) -> T,

Creates a new Vec2D with rows divided into columns length (i.e., w[rows][columns]) placing the result of func in each respective entry.

Panics

If rows * columns > usize::MAX.

Examples

let v = Vec2D::new_with(2, 2, |y, x| 100 * y + 10 * x);
let values = v.into_inner();

assert_eq!(values, [0, 10, 100, 110]);

pub fn from(raw: Vec<T>, columns: usize) -> Self

Creates a new Vec2D 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 from_unchecked(raw: Vec<T>, rows: usize, columns: usize) -> Self

Creates a new Vec2D 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 Vec.

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

pub fn into_inner(self) -> Vec<T>

Unwraps this Vec2D<T>, returning the underlying Vec.

impl<T: Default> Vec2D<T>

pub fn new(rows: usize, columns: usize) -> Self

Creates a new Vec2D with rows divided into columns length (i.e., w[rows][columns]) with T::default() in every entry.

Panics

If rows * columns > usize::MAX.

Trait Implementations

impl<T: Debug> Debug for Vec2D<T>

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

Formats the value using the given formatter.

impl<T> Index<(usize, usize)> for Vec2D<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 Vec2D<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 Vec2D<T>

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

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

impl<T> IndexMut<usize> for Vec2D<T>

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

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