Struct MatrixMask

pub struct MatrixMask<T, S> { /* private fields */ }

A 2 dimensional mask over a matrix, hiding the values inside the range from view.

The entire source is still owned by the MatrixMask however, so this does not permit creating multiple mutable masks into a single matrix even if they wouldn’t overlap.

See also: MatrixRange

Implementations

impl<T, S> MatrixMask<T, S>

where S: MatrixRef<T>,

pub fn from<R>(source: S, rows: R, columns: R) -> MatrixMask<T, S>

where R: Into<IndexRange>,

Creates a new MatrixMask giving a view of only the data outside the row and column IndexRanges. If the index range given for rows or columns exceeds the size of the matrix, they will be clipped to fit the actual size without an error.

Examples

Creating a view and manipulating a matrix from it.

use easy_ml::matrices::Matrix;
use easy_ml::matrices::views::{MatrixView, MatrixMask};
let mut matrix = Matrix::from(vec![
    vec![ 2, 3, 4 ],
    vec![ 5, 1, 8 ]]);
{
    let mut view = MatrixView::from(MatrixMask::from(&mut matrix, 0..1, 2..3));
    assert_eq!(vec![5, 1], view.row_major_iter().collect::<Vec<_>>());
    view.map_mut(|x| x + 10);
}
assert_eq!(matrix, Matrix::from(vec![
    vec![ 2,   3,  4 ],
    vec![ 15, 11,  8 ]]));

Various ways to construct a MatrixMask

use easy_ml::matrices::Matrix;
use easy_ml::matrices::views::{IndexRange, MatrixMask};
let matrix = Matrix::from(vec![vec![1]]);
let index_range = MatrixMask::from(&matrix, IndexRange::new(0, 4), IndexRange::new(1, 3));
let tuple = MatrixMask::from(&matrix, (0, 4), (1, 3));
let array = MatrixMask::from(&matrix, [0, 4], [1, 3]);
// Note std::ops::Range is start..end not start and length!
let range = MatrixMask::from(&matrix, 0..4, 1..4);

pub fn source(self) -> S

Consumes the MatrixMask, yielding the source it was created from.

pub fn source_ref(&self) -> &S

Gives a reference to the MatrixMask’s source (in which the data is not masked).

Trait Implementations

impl<T: Clone, S: Clone> Clone for MatrixMask<T, S>

fn clone(&self) -> MatrixMask<T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, S: Debug> Debug for MatrixMask<T, S>

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

Formats the value using the given formatter.

impl<T, S> MatrixMut<T> for MatrixMask<T, S>

where S: MatrixMut<T>,

A MatrixMask of a MatrixMut type implements MatrixMut.

fn try_get_reference_mut(&mut self, row: Row, column: Column) -> Option<&mut T>

Gets a mutable reference to the value at the index, if the index is in range. Otherwise returns None.

unsafe fn get_reference_unchecked_mut( &mut self, row: Row, column: Column, ) -> &mut T

Gets a mutable reference to the value at the index without doing any bounds checking. For a safe alternative see try_get_reference_mut.

impl<T, S> MatrixRef<T> for MatrixMask<T, S>

where S: MatrixRef<T>,

A MatrixMask of a MatrixRef type implements MatrixRef.

fn try_get_reference(&self, row: Row, column: Column) -> Option<&T>

Gets a reference to the value at the index if the index is in range. Otherwise returns None.

fn view_rows(&self) -> Row

The number of rows that this reference can view. This may be less than the actual number of rows of data stored in the matrix implementation, and could be 0.

fn view_columns(&self) -> Column

The number of columns that this reference can view. This may be less than the actual number of columns of data stored in the matrix implementation, and could be 0.

unsafe fn get_reference_unchecked(&self, row: Row, column: Column) -> &T

Gets a reference to the value at the index without doing any bounds checking. For a safe alternative see try_get_reference.

fn data_layout(&self) -> DataLayout

A hint for the data layout this MatrixView uses to store its data.

impl<T, S> NoInteriorMutability for MatrixMask<T, S>

where S: NoInteriorMutability,

A MatrixMask of a NoInteriorMutability type implements NoInteriorMutability.