Struct Vec2d

pub struct Vec2d<T, const RMAJ: bool = true> { /* private fields */ }

Available on crate feature alloc only.

📦 A 2-dimensional Vec.

It is generic in respect to its elements (T), and storage order (RMAJ).

The storage order is row-major by default (RMAJ = true). It can be column-major if set to false.

Methods

Implementations

impl<T: Clone, const RMAJ: bool> Vec2d<T, RMAJ>

pub fn with_cloned( element: T, rows: usize, cols: usize, ) -> Result<Self, IndexOutOfBounds>

Returns a 2-dimensional grid, allocated in the stack, using element to fill the remaining free data.

Errors

Returns IndexOutOfBounds if rows * cols > usize::MAX.

Examples

let g = Vec2d::<char, true>::with_cloned('.', 4, 4);

impl<T, const RMAJ: bool> Vec2d<T, RMAJ>

pub const fn len(&self) -> usize

Returns the total length of the array, equals C * R.

pub const fn x_len(&self) -> usize

Returns the length of the cols axis. (AKA width, number of columns or row length).

pub const fn y_len(&self) -> usize

Returns the length of the rows axis (AKA height, number of rows or column length).

pub const fn is_empty(&self) -> bool

Returns true if the stack is empty (has 0 length).

Examples

let g2 = Vec2d::<i32>::default();
assert![g2.is_empty()];

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

Returns the inner Vec.

pub fn as_slice(&self) -> &[T]

Returns a slice containing the full grid.

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns the stack as an exclusive slice.

impl<T: Clone, const RMAJ: bool> Vec2d<T, RMAJ>

pub fn fill(&mut self, element: T)

Fills all elements of the grid with the given element.

impl<T: PartialEq, const RMAJ: bool> Vec2d<T, RMAJ>

pub fn contains(&self, element: &T) -> bool

Returns true if the array contains element.

Examples

Trait Implementations

impl<T: Clone, const RMAJ: bool> Clone for Vec2d<T, RMAJ>

fn clone(&self) -> Vec2d<T, RMAJ>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const RMAJ: bool> Debug for Vec2d<T, RMAJ>

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

Formats the value using the given formatter.

impl<T: Default, const RMAJ: bool> Default for Vec2d<T, RMAJ>

fn default() -> Vec2d<T, RMAJ>

Returns the “default value” for a type.