Struct Submatrix 

pub struct Submatrix<'a, V, T>
where
    V: 'a + AsPointerToSlice<T>,
{ /* private fields */ }

Immutable view on a matrix that stores elements of type T.

Note that a Submatrix never owns the data, but always behaves like a reference. In particular, this means that Submatrix is Copy, unconditionally. The equivalent to a mutable reference is given by SubmatrixMut.

This view is designed to work with various underlying representations of the matrix, as described by AsPointerToSlice.

Implementations

impl<'a, V, T> Submatrix<'a, V, T>

where V: 'a + AsPointerToSlice<T>,

pub fn submatrix(self, rows: Range<usize>, cols: Range<usize>) -> Self

Returns the submatrix that references only the entries whose row resp. column indices are within the given ranges.

pub fn restrict_rows(self, rows: Range<usize>) -> Self

Returns the submatrix that references only the entries whose row indices are within the given range.

pub fn into_at(self, i: usize, j: usize) -> &'a T

Consumes the submatrix and produces a reference to its (i, j)-th entry.

In most cases, you will use Submatrix::at() instead, but in rare occasions, into_at() might be necessary to provide a reference whose lifetime is not coupled to the lifetime of the submatrix object.

pub fn at<'b>(&'b self, i: usize, j: usize) -> &'b T

Returns a reference to the (i, j)-th entry of this matrix.

pub fn restrict_cols(self, cols: Range<usize>) -> Self

Returns the submatrix that references only the entries whose column indices are within the given range.

pub fn row_iter(self) -> impl 'a + Clone + ExactSizeIterator<Item = &'a [T]>

Returns an iterator over all rows of the matrix.

pub fn col_iter( self, ) -> impl 'a + Clone + ExactSizeIterator<Item = Column<'a, V, T>>

Returns an iterator over all columns of the matrix.

pub fn into_row_at(self, i: usize) -> &'a [T]

Consumes the submatrix and produces a reference to its i-th row.

In most cases, you will use Submatrix::row_at() instead, but in rare occasions, into_row_at() might be necessary to provide a reference whose lifetime is not coupled to the lifetime of the submatrix object.

pub fn row_at<'b>(&'b self, i: usize) -> &'b [T]

Returns a view on the i-th row of this matrix.

pub fn into_col_at(self, j: usize) -> Column<'a, V, T>

Consumes the submatrix and produces a reference to its j-th column.

In most cases, you will use Submatrix::col_at() instead, but in rare occasions, into_col_at() might be necessary to provide a reference whose lifetime is not coupled to the lifetime of the submatrix object.

pub fn col_at<'b>(&'b self, j: usize) -> Column<'b, V, T>

Returns a view on the j-th column of this matrix.

pub fn col_count(&self) -> usize

Returns the number of columns of this matrix.

pub fn row_count(&self) -> usize

Returns the number of rows of this matrix.

impl<'a, T> Submatrix<'a, AsFirstElement<T>, T>

pub fn from_1d(data: &'a [T], row_count: usize, col_count: usize) -> Self

Creates a view on the given data slice, interpreting it as a matrix of given shape. Assumes row-major order, i.e. contigous subslices of data will be the rows of the resulting matrix.

pub fn from_ndarray<S>(data: &'a ArrayBase<S, Ix2>) -> Self

where S: DataMut<Elem = T>,

Available on crate feature ndarray only.

impl<'a, V: AsPointerToSlice<T> + Deref<Target = [T]>, T> Submatrix<'a, V, T>

pub fn from_2d(data: &'a [V]) -> Self

Interprets the given slice of slices as a matrix, by using the elements of the outer slice as the rows of the matrix.

Trait Implementations

impl<'a, V, T> Clone for Submatrix<'a, V, T>

where V: 'a + AsPointerToSlice<T>,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, V, T: Debug> Debug for Submatrix<'a, V, T>

where V: 'a + AsPointerToSlice<T>,

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

Formats the value using the given formatter.

impl<'a, V: AsPointerToSlice<T>, T> From<Submatrix<'a, V, T>> for TransposableSubmatrix<'a, V, T, false>

fn from(value: Submatrix<'a, V, T>) -> Self

Converts to this type from the input type.

impl<'a, V: AsPointerToSlice<T>, T> MatrixCompare<T> for Submatrix<'a, V, T>

fn col_count(&self) -> usize

Returns the number of columns of the matrix.

fn row_count(&self) -> usize

Returns the number of rows of the matrix.

fn at(&self, i: usize, j: usize) -> &T

Returns a reference to the element at the given position.

impl<'a, V, T> Copy for Submatrix<'a, V, T>

where V: 'a + AsPointerToSlice<T>,