Struct dynamic_grid::DynamicGrid

pub struct DynamicGrid<T> { /* fields omitted */ }

Dynamic Grid

Implementations

impl<T> DynamicGrid<T> where
    T: Clone, 

pub fn new() -> Self

Constructor, Returns a dynamic grid

pub fn init(row: usize, col: usize, value: T) -> Self

Init a grid of size rows x columns with the given data element

Arguments

• row - number of rows
• col - number columns
• value - default value

pub fn from_vec(vec: Vec<Vec<T>>) -> Self

Returns a grid from a vector of vector

Arguments

• vec - Vector which represent a grid

pub fn rows(&self) -> usize

Returns number of rows of the grid

pub fn row_size(&self, index_row: usize) -> Option<usize>

Returns the size of the row indicate by the index

Arguments

• index - rows index

pub fn row_size_unchecked(&self, index_row: usize) -> usize

Returns the size of the row indicate by the index, without bound checking

Arguments

• index - rows index

pub fn push(&mut self, value: T) -> (usize, usize)

push value in the last position of last row

• value - value to push

pub fn push_at_row(
    &mut self,
    index_row: usize,
    value: T
) -> Option<(usize, usize)>

push value in the last position at row mentioned

Argument

• index_row - index of row
• value - value to push

pub fn insert(&mut self, index_row: usize, index_col: usize, value: T)

insert value at position

Argument

• index_row - index of row
• index_col - index of col
• value - value to insert

Panics

Panics if the row and the col index are out of bounds.

pub fn swap(
    &mut self,
    first_position: (usize, usize),
    second_position: (usize, usize)
)

swap two element in the grid

Argument

• first_position - position of the first element
• second_position - position of the second element

Panics

Panics if the row and the col index are out of bounds.

pub fn push_new_row(&mut self, value: T) -> (usize, usize)

push a new empty row

pub fn remove(&mut self)

remove the last value of the last row

pub fn remove_row(&mut self, index_row: usize)

remove the last row

pub unsafe fn get_unchecked(&self, index_row: usize, index_col: usize) -> &T

Returns a reference to an element, without doing bound checking.

Arguments

index_row - index of row index_col - index of column

Example

pub unsafe fn get_unchecked_mut(
    &mut self,
    index_row: usize,
    index_col: usize
) -> &mut T

Return a mutable reference to an element, without doing bound checking.

Arguments

index_row - index of row index_col - index of column

Example

pub fn get(&self, index_row: usize, index_col: usize) -> Option<&T>

Returns a reference to an element.

Arguments

index_row - index of row index_col - index of column

Example

pub fn get_mut(&mut self, index_row: usize, index_col: usize) -> Option<&mut T>

Returns a reference to an element.

Arguments

index_row - index of row index_col - index of column

Example

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the whole grid, starting from the first row and column.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns an mutable iterator over the whole grid that allows modifying each value.

pub fn iter_row(&self, index_row: usize) -> Iter<'_, T>

Returns a row Iterator

Panics

Panics if the row index is out of bounds.

pub fn iter_row_mut(&mut self, index_row: usize) -> IterMut<'_, T>

Returns a mutable row Iterator

Panics

Panics if the row index is out of bounds.

Trait Implementations

impl<T: Clone> Clone for DynamicGrid<T>

fn clone(&self) -> DynamicGrid<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DynamicGrid<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for DynamicGrid<T>

fn default() -> DynamicGrid<T>

Returns the “default value” for a type.

impl<T> Display for DynamicGrid<T> where
    T: Clone + ToString, 

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

Formats the value using the given formatter.