Struct matrixable::access::AccessMut

pub struct AccessMut<'a, M: MatrixExt, S: AccessStrategy<M>> { /* private fields */ }

A MatrixMutExt which provides mutable access to another matrix by following a certain access strategy.

This struct is created by the access_mut method on MatrixMutExt. See its documentation for more.

Implementations

impl<'a, M: MatrixMutExt, S: AccessStrategy<M>> AccessMut<'a, M, S>

pub fn clone_into(&self) -> M

where M: Clone, <M as MatrixExt>::Element: Clone,

Trait Implementations

impl<'a, M: Debug + MatrixExt, S: Debug + AccessStrategy<M>> Debug for AccessMut<'a, M, S>

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

Formats the value using the given formatter.

impl<'a, M: Hash + MatrixExt, S: Hash + AccessStrategy<M>> Hash for AccessMut<'a, M, S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, M: MatrixMutExt, S: AccessStrategy<M>> MatrixExt for AccessMut<'a, M, S>

type Element = <M as MatrixExt>::Element

The type of the elements of the matrix.

fn num_rows(&self) -> usize

Gets the number of rows of the matrix.

fn num_cols(&self) -> usize

Gets the number of columns of the matrix.

fn get(&self, row: usize, column: usize) -> Option<&Self::Element>

Returns a reference to an element inside the matrix, at the intersection of the i-th row and the j-th column.

unsafe fn get_unchecked(&self, row: usize, column: usize) -> &Self::Element

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

fn get_nth(&self, n: usize) -> Option<&Self::Element>

Gets a reference to an element inside a matrix, given its order of disposition in Row Major Order.

unsafe fn get_nth_unchecked(&self, n: usize) -> &Self::Element

Returns a reference to an element given its linear order, without doing bound checking.

fn size(&self) -> usize

Returns the size of the matrix

fn dimensions(&self) -> (usize, usize)

Returns the dimensions of the matrix

fn num_diags(&self) -> usize

Returns the number of diagonals.

fn row_len(&self) -> usize

Returns the length of a row.

fn col_len(&self) -> usize

Returns the length of a column.

fn check(&self, i: usize, j: usize) -> bool

Checks if the provided subscripts point to an element inside the matrix.

fn check_nth(&self, n: usize) -> bool

Checks if the provided linear index point to an element inside the matrix.

fn index_from(&self, (i, j): (usize, usize)) -> usize

Use matrix as a subscripts-to-index converter.

fn subscripts_from(&self, n: usize) -> (usize, usize)

Use matrix as a index-to-subscripts converter.

fn checked_index_from(&self, (i, j): (usize, usize)) -> Option<usize>

Checked index calculation.

fn checked_subscripts_from(&self, n: usize) -> Option<(usize, usize)>

Checked indexes calculation.

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

where Self: Sized,

Returns an iterator over the elements of the matrix.

fn row(&self, i: usize) -> Option<Row<'_, Self>>

where Self: Sized,

Returns an iterator over the elements of the i-th row.

fn col(&self, j: usize) -> Option<Column<'_, Self>>

where Self: Sized,

Returns an iterator over elements of the j-th column.

fn diag(&self, n: usize) -> Option<Diag<'_, Self>>

where Self: Sized,

Returns an iterator over element of the n-th diagonal of the matrix, starting from bottom-left to top-right.

fn main_diag(&self) -> Diag<'_, Self>

where Self: Sized,

Returns the main diagonal i.e. all elements at position (i, i).

fn enumerate(&self) -> Enumerator<Iter<'_, Self>>

where Self: Sized,

Returns an iterator which gives the current subscripts of the current element as well as its value.

fn rows(&self) -> Rows<'_, Self>

where Self: Sized,

Returns an iterator over the rows with immutable access to elements.

fn cols(&self) -> Columns<'_, Self>

where Self: Sized,

Returns an iterator over the columns with immutable access to elements.

fn diags(&self) -> Diags<'_, Self>

where Self: Sized,

Returns an iterator over the diagonals with immutable access to elements. Examples

fn access<S: AccessStrategy<Self>>(&self, strategy: S) -> Access<'_, Self, S>

where Self: Sized,

Creates a matrix to access elements of this matrix following an AccessStrategy.

fn transform<S: TransformStrategy<Self>>(self, strategy: &S) -> S::Output

where Self: Sized,

Consumes the matrix an returns an output defined by a TransformStrategy.

fn is_empty(&self) -> bool

Checks if the matrix is empty.

fn is_square(&self) -> bool

Checks if the matrix is a square matrix (a matrix with equal number of rows and columns).

fn is_one_dimension(&self) -> bool

Checks if the matrix has one dimension (number of columns is 1 or number of rows is 1)

fn is_singleton(&self) -> bool

Checks if the matrix is a singleton i.e. dimensions are equal to (1, 1).

fn is_horizontal(&self) -> bool

Checks if the matrix is horizontal (number of rows of the matrix is lower than number of columns).

fn is_vertical(&self) -> bool

Checks if the matrix is vertical (number of rows of the matrix is greater than number of columns).

impl<'a, M: MatrixMutExt, S: AccessStrategy<M>> MatrixMutExt for AccessMut<'a, M, S>

fn get_mut(&mut self, row: usize, column: usize) -> Option<&mut Self::Element>

Returns a mutable reference to a value inside the matrix, at the intersection of the i-th row and the j-th column.

unsafe fn get_unchecked_mut( &mut self, row: usize, column: usize ) -> &mut Self::Element

Returns a mutable reference to an element, without doing bounds checking.

fn get_nth_mut(&mut self, n: usize) -> Option<&mut Self::Element>

Example

unsafe fn get_nth_unchecked_mut(&mut self, n: usize) -> &mut Self::Element

Returns mutable a reference to an element given its linear order, without doing bound checking.

fn set( &mut self, (i, j): (usize, usize), val: Self::Element ) -> Result<(), &'static str>

Changes the value of an element at the intersection of the i-th row and the j-th column of the matrix.

fn set_nth(&mut self, n: usize, val: Self::Element) -> Result<(), &'static str>

Changes the value of the n-th element of the matrix.

fn swap(&mut self, a: (usize, usize), b: (usize, usize))

Swaps two elements in the matrix identified by their subscripts.

fn swapn(&mut self, a: usize, b: usize)

Swaps two elements in the matrix identified by their linear position following the Row Major Order.

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

where Self: Sized,

Returns an iterator that allows modifying each element.

fn row_mut(&mut self, i: usize) -> Option<RowMut<'_, Self>>

where Self: Sized,

Returns an iterator that allows modifying each element of the i-th row .

fn col_mut(&mut self, j: usize) -> Option<ColumnMut<'_, Self>>

where Self: Sized,

Returns an iterator over that allows modifying each element of the j-th column.

fn diag_mut(&mut self, n: usize) -> Option<DiagMut<'_, Self>>

where Self: Sized,

Returns an iterator over that allows modifying each element of the n-th diagonal.

fn main_diag_mut(&mut self) -> DiagMut<'_, Self>

where Self: Sized,

Returns the main diagonal (mutable).

fn enumerate_mut(&mut self) -> Enumerator<IterMut<'_, Self>>

where Self: Sized,

[.enumerate()] with mutable access to each element.

fn rows_mut(&mut self) -> RowsMut<'_, Self>

where Self: Sized,

Returns an iterator over the rows with mutable access to elements.

fn cols_mut(&mut self) -> ColumnsMut<'_, Self>

where Self: Sized,

Returns an iterator over the columns of the matrix with mutable access to elements.

fn diags_mut(&mut self) -> DiagsMut<'_, Self>

where Self: Sized,

Returns an iterator over the diagonals with mutable access to elements.

fn access_mut<S: AccessStrategy<Self>>( &mut self, strategy: S ) -> AccessMut<'_, Self, S>

where Self: Sized,

Creates a matrix to mutably access elements of this matrix following an AccessStrategy.

fn in_place<S: InPlace<Self>>(&mut self, strategy: &S)

where Self: Sized,

Modifies the matrix in place according to a certain strategy.