Struct matrixable::access::Observer

pub struct Observer { /* private fields */ }

Used by AccessStrategySet.

Implementations

impl Observer

pub fn new(dimensions: (usize, usize)) -> Self

pub fn update_dimensions(&mut self, s: &dyn AccessStrategy<Self>)

Trait Implementations

impl Clone for Observer

fn clone(&self) -> Observer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Observer

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

Formats the value using the given formatter.

impl Default for Observer

fn default() -> Observer

Returns the “default value” for a type.

impl Hash for Observer

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 MatrixExt for Observer

type 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, i: usize, j: usize) -> Option<&()>

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_symmetric(&self) -> bool

where Self::Element: PartialEq,

Checks if the matrix is symmetric i.e. it does not change when transposed.

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).

fn is_diagonal(&self) -> (bool, Option<&Self::Element>)

where Self: Sized, for<'a> &'a Self::Element: PartialEq,

Returns a boolean indicating if the matrix looks like a diagonal matrix (a matrix which entries outside the main diagonal are all zero), along with the reference to the element that may serve as zero in that matrix if the check was correct.

fn is_scalar(&self) -> (bool, Option<&Self::Element>, Option<&Self::Element>)

where Self: Sized, for<'a> &'a Self::Element: PartialEq,

Returns a boolean indicating if matrix is a square diagonal matrix having the same elements on its diagonal (assumed to be the first element of the matrix, at (0, 0)), along with that element and the element considered as zero (that is the second element of matrix, at index 0, 1).

fn is_constant(&self) -> (bool, Option<&Self::Element>)

where Self::Element: PartialEq,

Returns a boolean indicating if all elements of the matrix are equal, and that element if it the check value is true.

impl Ord for Observer

fn cmp(&self, other: &Observer) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Observer

fn eq(&self, other: &Observer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Observer

fn partial_cmp(&self, other: &Observer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Observer

impl Eq for Observer

impl StructuralPartialEq for Observer