Struct MatrixRange

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

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

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

For non overlapping mutable ranges into a single matrix see partition.

See also: MatrixMask

Implementations

impl<T, S> MatrixRange<T, S>

where S: MatrixRef<T>,

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

where R: Into<IndexRange>,

Creates a new MatrixRange giving a view of only the data within the row and column IndexRanges.

Examples

Creating a view and manipulating a matrix from it.

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

Various ways to construct a MatrixRange

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

NOTE: In previous versions (<=1.8.1), this erroneously did not clip the IndexRange input to not exceed the rows and columns of the source, which led to the possibility to create MatrixRanges that reported a greater number of rows and columns in their shape than their actual data. This function will now correctly clip any ranges that exceed their sources.

pub fn source(self) -> S

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

pub fn source_ref(&self) -> &S

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

Trait Implementations

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

fn clone(&self) -> MatrixRange<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 MatrixRange<T, S>

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

Formats the value using the given formatter.

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

where S: MatrixMut<T>,

A MatrixRange 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 MatrixRange<T, S>

where S: MatrixRef<T>,

A MatrixRange 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 MatrixRange<T, S>

where S: NoInteriorMutability,

A MatrixRange of a NoInteriorMutability type implements NoInteriorMutability.