Struct MatrixPart

pub struct MatrixPart<'source, T> { /* private fields */ }

A mutably borrowed part of a matrix.

Rust’s borrow checker does not not permit overlapping exclusive references, so you cannot simply construct multiple views into a Matrix by creating each one sequentially as you can for immutable/shared references to a Matrix.

use easy_ml::matrices::Matrix;
use easy_ml::matrices::views::MatrixRange;
let matrix = Matrix::row(vec![1, 2, 3]);
let one = MatrixRange::from(&matrix, 0..1, 0..1);
let two = MatrixRange::from(&matrix, 0..1, 1..2);
let three = MatrixRange::from(&matrix, 0..1, 2..3);
let four = MatrixRange::from(&matrix, 0..1, 0..3);

MatrixPart instead holds only a mutable reference to a slice into a Matrix’s buffer. It does not borrow the entire Matrix, and thus is used as the container for Matrix APIs which partition a Matrix into multiple non overlapping parts. The Matrix can then be independently mutated by each of the MatrixParts.

See Matrix::partition_quadrants

Trait Implementations

impl<'source, T: Debug> Debug for MatrixPart<'source, T>

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

Formats the value using the given formatter.

impl<'a, T> MatrixMut<T> for MatrixPart<'a, T>

A MatrixPart 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<'a, T> MatrixRef<T> for MatrixPart<'a, T>

A MatrixPart 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<'a, T> NoInteriorMutability for MatrixPart<'a, T>

A MatrixPart implements NoInteriorMutability.