Struct MatrixReverse

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

A view over a matrix where some or all of the rows and columns are iterated in reverse order.

use easy_ml::matrices::Matrix;
use easy_ml::matrices::views::{MatrixView, MatrixReverse, Reverse};
let ab = Matrix::from(vec![
    vec![ 0, 1, 2 ],
    vec![ 3, 4, 5 ]
]);
let reversed = ab.reverse(Reverse { rows: true, ..Default::default() });
let also_reversed = MatrixView::from(
    MatrixReverse::from(&ab, Reverse { rows: true, columns: false })
);
assert_eq!(reversed, also_reversed);
assert_eq!(
    reversed,
    Matrix::from(vec![
        vec![ 3, 4, 5 ],
        vec![ 0, 1, 2 ]
    ])
);

Implementations

impl<T, S> MatrixReverse<T, S>

where S: MatrixRef<T>,

pub fn from(source: S, reverse: Reverse) -> MatrixReverse<T, S>

Creates a MatrixReverse from a source and a struct for which dimensions to reverse the order of iteration for. If either or both of rows and columns in Reverse are set to false the iteration order for that dimension will continue to iterate in its normal order.

pub fn source(self) -> S

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

pub fn source_ref(&self) -> &S

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

pub fn source_ref_mut(&mut self) -> &mut S

Gives a mutable reference to the MatrixReverse’s source (in which the data is not reversed).

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

where S: MatrixMut<T>,

A MatrixReverse implements MatrixMut, with the dimension names the MatrixReverse was created with iterating in reverse order compared to the dimension names in the original source.

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 MatrixReverse<T, S>

where S: MatrixRef<T>,

A MatrixReverse implements MatrixRef, with the dimension names the MatrixReverse was created with iterating in reverse order compared to the dimension names in the original source.

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 MatrixReverse<T, S>

where S: NoInteriorMutability,

A MatrixReverse of a NoInteriorMutability type implements NoInteriorMutability.