Type Alias faer_core::MatRef

pub type MatRef<'a, E> = Matrix<DenseRef<'a, E>>;

Immutable view over a matrix, similar to an immutable reference to a 2D strided slice.

Note

Unlike a slice, the data pointed to by MatRef<'_, E> is allowed to be partially or fully uninitialized under certain conditions. In this case, care must be taken to not perform any operations that read the uninitialized values, or form references to them, either directly through MatRef::read, or indirectly through any of the numerical library routines, unless it is explicitly permitted.

Aliased Type

struct MatRef<'a, E> { /* private fields */ }

Implementations

impl<'a, E: Entity> MatRef<'a, E>

pub fn nrows(&self) -> usize

Returns the number of rows of the matrix.

pub fn ncols(&self) -> usize

Returns the number of columns of the matrix.

pub fn as_ptr(self) -> GroupFor<E, *const E::Unit>

Returns pointers to the matrix data.

pub fn row_stride(&self) -> isize

Returns the row stride of the matrix, specified in number of elements, not in bytes.

pub fn col_stride(&self) -> isize

Returns the column stride of the matrix, specified in number of elements, not in bytes.

pub fn ptr_at(self, row: usize, col: usize) -> GroupFor<E, *const E::Unit>

Returns raw pointers to the element at the given indices.

pub unsafe fn ptr_inbounds_at( self, row: usize, col: usize ) -> GroupFor<E, *const E::Unit>

Returns raw pointers to the element at the given indices, assuming the provided indices are within the matrix dimensions.

Safety

The behavior is undefined if any of the following conditions are violated:

• row < self.nrows().
• col < self.ncols().

pub unsafe fn split_at_unchecked( self, row: usize, col: usize ) -> (Self, Self, Self, Self)

Splits the matrix horizontally and vertically at the given indices into four corners and returns an array of each submatrix, in the following order:

• top left.
• top right.
• bottom left.
• bottom right.

Safety

The behavior is undefined if any of the following conditions are violated:

• row <= self.nrows().
• col <= self.ncols().

pub fn split_at(self, row: usize, col: usize) -> (Self, Self, Self, Self)

Splits the matrix horizontally and vertically at the given indices into four corners and returns an array of each submatrix, in the following order:

• top left.
• top right.
• bottom left.
• bottom right.

Panics

The function panics if any of the following conditions are violated:

• row <= self.nrows().
• col <= self.ncols().

pub unsafe fn split_at_row_unchecked(self, row: usize) -> (Self, Self)

Splits the matrix horizontally at the given row into two parts and returns an array of each submatrix, in the following order:

• top.
• bottom.

Safety

The behavior is undefined if the following condition is violated:

• row <= self.nrows().

pub fn split_at_row(self, row: usize) -> (Self, Self)

Splits the matrix horizontally at the given row into two parts and returns an array of each submatrix, in the following order:

• top.
• bottom.

Panics

The function panics if the following condition is violated:

• row <= self.nrows().

pub unsafe fn split_at_col_unchecked(self, col: usize) -> (Self, Self)

Splits the matrix vertically at the given row into two parts and returns an array of each submatrix, in the following order:

• left.
• right.

Safety

The behavior is undefined if the following condition is violated:

• col <= self.ncols().

pub fn split_at_col(self, col: usize) -> (Self, Self)

Splits the matrix vertically at the given row into two parts and returns an array of each submatrix, in the following order:

• left.
• right.

Panics

The function panics if the following condition is violated:

• col <= self.ncols().

pub unsafe fn get_unchecked<RowRange, ColRange>( self, row: RowRange, col: ColRange ) -> <Self as MatIndex<RowRange, ColRange>>::Target

where Self: MatIndex<RowRange, ColRange>,

Returns references to the element at the given indices, or submatrices if either row or col is a range.

Note

The values pointed to by the references are expected to be initialized, even if the pointed-to value is not read, otherwise the behavior is undefined.

Safety

The behavior is undefined if any of the following conditions are violated:

• row must be contained in [0, self.nrows()).
• col must be contained in [0, self.ncols()).

pub fn get<RowRange, ColRange>( self, row: RowRange, col: ColRange ) -> <Self as MatIndex<RowRange, ColRange>>::Target

where Self: MatIndex<RowRange, ColRange>,

Returns references to the element at the given indices, or submatrices if either row or col is a range, with bound checks.

Note

The values pointed to by the references are expected to be initialized, even if the pointed-to value is not read, otherwise the behavior is undefined.

Panics

The function panics if any of the following conditions are violated:

• row must be contained in [0, self.nrows()).
• col must be contained in [0, self.ncols()).

pub unsafe fn read_unchecked(&self, row: usize, col: usize) -> E

Reads the value of the element at the given indices.

Safety

The behavior is undefined if any of the following conditions are violated:

• row < self.nrows().
• col < self.ncols().

pub fn read(&self, row: usize, col: usize) -> E

Reads the value of the element at the given indices, with bound checks.

Panics

The function panics if any of the following conditions are violated:

• row < self.nrows().
• col < self.ncols().

pub fn transpose(self) -> Self

Returns a view over the transpose of self.

Example

use faer_core::mat;

let matrix = mat![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
let view = matrix.as_ref();
let transpose = view.transpose();

let expected = mat![[1.0, 4.0], [2.0, 5.0], [3.0, 6.0]];
assert_eq!(expected.as_ref(), transpose);

pub fn conjugate(self) -> MatRef<'a, E::Conj>

where E: Conjugate,

Returns a view over the conjugate of self.

pub fn adjoint(self) -> MatRef<'a, E::Conj>

where E: Conjugate,

Returns a view over the conjugate transpose of self.

pub fn canonicalize(self) -> (MatRef<'a, E::Canonical>, Conj)

where E: Conjugate,

Returns a view over the canonical representation of self, as well as a flag declaring whether self is implicitly conjugated or not.

pub fn reverse_rows(self) -> Self

Returns a view over the self, with the rows in reversed order.

Example

use faer_core::mat;

let matrix = mat![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
let view = matrix.as_ref();
let reversed_rows = view.reverse_rows();

let expected = mat![[4.0, 5.0, 6.0], [1.0, 2.0, 3.0]];
assert_eq!(expected.as_ref(), reversed_rows);

pub fn reverse_cols(self) -> Self

Returns a view over the self, with the columns in reversed order.

Example

use faer_core::mat;

let matrix = mat![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
let view = matrix.as_ref();
let reversed_cols = view.reverse_cols();

let expected = mat![[3.0, 2.0, 1.0], [6.0, 5.0, 4.0]];
assert_eq!(expected.as_ref(), reversed_cols);

pub fn reverse_rows_and_cols(self) -> Self

Returns a view over the self, with the rows and the columns in reversed order.

Example

use faer_core::mat;

let matrix = mat![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
let view = matrix.as_ref();
let reversed = view.reverse_rows_and_cols();

let expected = mat![[6.0, 5.0, 4.0], [3.0, 2.0, 1.0]];
assert_eq!(expected.as_ref(), reversed);

pub unsafe fn submatrix_unchecked( self, row_start: usize, col_start: usize, nrows: usize, ncols: usize ) -> Self

Returns a view over the submatrix starting at indices (row_start, col_start), and with dimensions (nrows, ncols).

Safety

The behavior is undefined if any of the following conditions are violated:

• row_start <= self.nrows().
• col_start <= self.ncols().
• nrows <= self.nrows() - row_start.
• ncols <= self.ncols() - col_start.

pub fn submatrix( self, row_start: usize, col_start: usize, nrows: usize, ncols: usize ) -> Self

Returns a view over the submatrix starting at indices (row_start, col_start), and with dimensions (nrows, ncols).

Panics

The function panics if any of the following conditions are violated:

• row_start <= self.nrows().
• col_start <= self.ncols().
• nrows <= self.nrows() - row_start.
• ncols <= self.ncols() - col_start.

Example

use faer_core::mat;

let matrix = mat![
    [1.0, 5.0, 9.0],
    [2.0, 6.0, 10.0],
    [3.0, 7.0, 11.0],
    [4.0, 8.0, 12.0f64],
];

let view = matrix.as_ref();
let submatrix = view.submatrix(2, 1, 2, 2);

let expected = mat![[7.0, 11.0], [8.0, 12.0f64]];
assert_eq!(expected.as_ref(), submatrix);

pub unsafe fn subrows_unchecked(self, row_start: usize, nrows: usize) -> Self

Returns a view over the submatrix starting at row row_start, and with number of rows nrows.

Safety

The behavior is undefined if any of the following conditions are violated:

• row_start <= self.nrows().
• nrows <= self.nrows() - row_start.

pub fn subrows(self, row_start: usize, nrows: usize) -> Self

Returns a view over the submatrix starting at row row_start, and with number of rows nrows.

Panics

The function panics if any of the following conditions are violated:

• row_start <= self.nrows().
• nrows <= self.nrows() - row_start.

Example

use faer_core::mat;

let matrix = mat![
    [1.0, 5.0, 9.0],
    [2.0, 6.0, 10.0],
    [3.0, 7.0, 11.0],
    [4.0, 8.0, 12.0f64],
];

let view = matrix.as_ref();
let subrows = view.subrows(1, 2);

let expected = mat![[2.0, 6.0, 10.0], [3.0, 7.0, 11.0],];
assert_eq!(expected.as_ref(), subrows);

pub unsafe fn subcols_unchecked(self, col_start: usize, ncols: usize) -> Self

Returns a view over the submatrix starting at column col_start, and with number of columns ncols.

Safety

The behavior is undefined if any of the following conditions are violated:

• col_start <= self.ncols().
• ncols <= self.ncols() - col_start.

pub fn subcols(self, col_start: usize, ncols: usize) -> Self

Returns a view over the submatrix starting at column col_start, and with number of columns ncols.

Panics

The function panics if any of the following conditions are violated:

• col_start <= self.ncols().
• ncols <= self.ncols() - col_start.

Example

use faer_core::mat;

let matrix = mat![
    [1.0, 5.0, 9.0],
    [2.0, 6.0, 10.0],
    [3.0, 7.0, 11.0],
    [4.0, 8.0, 12.0f64],
];

let view = matrix.as_ref();
let subcols = view.subcols(2, 1);

let expected = mat![[9.0], [10.0], [11.0], [12.0f64]];
assert_eq!(expected.as_ref(), subcols);

pub unsafe fn row_unchecked(self, row_idx: usize) -> RowRef<'a, E>

Returns a view over the row at the given index.

Safety

The function panics if any of the following conditions are violated:

• row_idx < self.nrows().

pub fn row(self, row_idx: usize) -> RowRef<'a, E>

Returns a view over the row at the given index.

Panics

The function panics if any of the following conditions are violated:

• row_idx < self.nrows().

pub unsafe fn col_unchecked(self, col_idx: usize) -> ColRef<'a, E>

Returns a view over the column at the given index.

Safety

The behavior is undefined if any of the following conditions are violated:

• col_idx < self.ncols().

pub fn col(self, col_idx: usize) -> ColRef<'a, E>

Returns a view over the column at the given index.

Panics

The function panics if any of the following conditions are violated:

• col_idx < self.ncols().

pub fn column_vector_as_diagonal(self) -> Matrix<DiagRef<'a, E>>

Given a matrix with a single column, returns an object that interprets the column as a diagonal matrix, whoes diagonal elements are values in the column.

pub fn diagonal(self) -> Matrix<DiagRef<'a, E>>

Returns the diagonal of the matrix.

pub fn to_owned(&self) -> Mat<E::Canonical>

where E: Conjugate,

Returns an owning Mat of the data.

pub fn has_nan(&self) -> bool

where E: ComplexField,

Returns true if any of the elements is NaN, otherwise returns false.

pub fn is_all_finite(&self) -> bool

where E: ComplexField,

Returns true if all of the elements are finite, otherwise returns false.

pub fn norm_max(&self) -> E::Real

where E: ComplexField,

Returns the maximum norm of self.

pub fn norm_l2(&self) -> E::Real

where E: ComplexField,

Returns the L2 norm of self.

pub fn sum(&self) -> E

where E: ComplexField,

Returns the sum of self.

pub fn kron(&self, rhs: impl As2D<E>) -> Mat<E>

where E: ComplexField,

Kroneckor product of self and rhs.

This is an allocating operation; see kron for the allocation-free version or more info in general.

pub fn as_ref(&self) -> MatRef<'_, E>

Returns a view over the matrix.

pub fn col_chunks( self, chunk_size: usize ) -> impl 'a + DoubleEndedIterator<Item = MatRef<'a, E>>

Returns an iterator that provides successive chunks of the columns of this matrix, with each having at most chunk_size columns.

If the number of columns is a multiple of chunk_size, then all chunks have chunk_size columns.

pub fn row_chunks( self, chunk_size: usize ) -> impl 'a + DoubleEndedIterator<Item = MatRef<'a, E>>

Returns an iterator that provides successive chunks of the rows of this matrix, with each having at most chunk_size rows.

If the number of rows is a multiple of chunk_size, then all chunks have chunk_size rows.

pub fn par_col_chunks( self, chunk_size: usize ) -> impl 'a + IndexedParallelIterator<Item = MatRef<'a, E>>

Available on crate feature rayon only.

Returns a parallel iterator that provides successive chunks of the columns of this matrix, with each having at most chunk_size columns.

If the number of columns is a multiple of chunk_size, then all chunks have chunk_size columns.

Only available with the rayon feature.

pub fn par_row_chunks( self, chunk_size: usize ) -> impl 'a + IndexedParallelIterator<Item = MatRef<'a, E>>

Available on crate feature rayon only.

Returns a parallel iterator that provides successive chunks of the rows of this matrix, with each having at most chunk_size rows.

If the number of rows is a multiple of chunk_size, then all chunks have chunk_size rows.

Only available with the rayon feature.

pub fn into_par_row_chunks( self, chunk_size: usize ) -> impl 'a + IndexedParallelIterator<Item = MatRef<'a, E>>

👎Deprecated: replaced by MatRef::par_row_chunks

Available on crate feature rayon only.

Returns a parallel iterator that provides successive chunks of the rows of this matrix, with each having at most chunk_size rows.

If the number of rows is a multiple of chunk_size, then all chunks have chunk_size rows.

Only available with the rayon feature.

impl<'a, E: RealField> MatRef<'a, Complex<E>>

pub fn real_imag(self) -> Complex<MatRef<'a, E>>

Returns the real and imaginary components of self.

Trait Implementations

impl<E: Entity> As2D<E> for &MatRef<'_, E>

fn as_2d_ref(&self) -> MatRef<'_, E>

Convert to a 2D matrix view.

impl<E: Entity> As2D<E> for MatRef<'_, E>

fn as_2d_ref(&self) -> MatRef<'_, E>

Convert to a 2D matrix view.

impl<E: Entity> AsMatRef<E> for &MatRef<'_, E>

fn as_mat_ref(&self) -> MatRef<'_, E>

Convert to a matrix view.

impl<E: Entity> AsMatRef<E> for MatRef<'_, E>

fn as_mat_ref(&self) -> MatRef<'_, E>

Convert to a matrix view.

impl<'a, FromE: Entity, ToE: Entity> Coerce<Matrix<DenseRef<'a, ToE>>> for MatRef<'a, FromE>

fn coerce(self) -> MatRef<'a, ToE>

impl<'a, E: Entity> Debug for MatRef<'a, E>

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

Formats the value using the given formatter.

impl<E: Entity> DenseAccess<E> for MatRef<'_, E>

Available on crate feature std only.

fn fetch_single(&self, row: usize, col: usize) -> E

impl<E: SimpleEntity> Index<(usize, usize)> for MatRef<'_, E>

type Output = E

The returned type after indexing.

fn index(&self, (row, col): (usize, usize)) -> &E

Performs the indexing (container[index]) operation.

impl<'a, E: Entity> IntoConst for MatRef<'a, E>

type Target = Matrix<DenseRef<'a, E>>

fn into_const(self) -> Self::Target

impl<'a, E: Entity> MatIndex<'a> for MatRef<'_, E>

type Item = Read<'a, E>

Item produced by the zipped views.

unsafe fn get_unchecked(&'a mut self, (i, j): Self::Index) -> Self::Item

Get the item at the given index, skipping bound checks.

unsafe fn get_from_slice_unchecked( slice: &'a mut Self::Slice, idx: usize ) -> Self::Item

Get the item at the given slice position, skipping bound checks.

fn is_contiguous(&self) -> bool

Checks if the zipped matrices are contiguous.

fn preferred_layout(&self) -> Self::LayoutTransform

Computes the preferred iteration layout of the matrices.

fn with_layout(self, layout: Self::LayoutTransform) -> Self

Applies the layout transformation to the matrices.

impl<E: Entity> MatIndex<Range<usize>, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: Range<usize>, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<Range<usize>, usize> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: Range<usize>, col: usize) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeFrom<usize>, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeFrom<usize>, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeFrom<usize>, usize> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeFrom<usize>, col: usize) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeFull, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeFull, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<'a, E: Entity> MatIndex<RangeFull, usize> for MatRef<'a, E>

type Target = Matrix<DenseColRef<'a, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeFull, col: usize) -> Self::Target

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeInclusive<usize>, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeInclusive<usize>, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeInclusive<usize>, usize> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeInclusive<usize>, col: usize) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeTo<usize>, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeTo<usize>, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeTo<usize>, usize> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeTo<usize>, col: usize) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeToInclusive<usize>, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeToInclusive<usize>, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<RangeToInclusive<usize>, usize> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: RangeToInclusive<usize>, col: usize) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity, RowRange> MatIndex<RowRange, RangeFrom<usize>> for MatRef<'_, E>

where Self: MatIndex<RowRange, Range<usize>>,

type Target = <Matrix<DenseRef<'_, E>> as MatIndex<RowRange, Range<usize>>>::Target

Resulting type of the indexing operation.

fn get( this: Self, row: RowRange, col: RangeFrom<usize> ) -> <Self as MatIndex<RowRange, Range<usize>>>::Target

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity, RowRange> MatIndex<RowRange, RangeFull> for MatRef<'_, E>

where Self: MatIndex<RowRange, Range<usize>>,

type Target = <Matrix<DenseRef<'_, E>> as MatIndex<RowRange, Range<usize>>>::Target

Resulting type of the indexing operation.

fn get( this: Self, row: RowRange, col: RangeFull ) -> <Self as MatIndex<RowRange, Range<usize>>>::Target

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity, RowRange> MatIndex<RowRange, RangeInclusive<usize>> for MatRef<'_, E>

where Self: MatIndex<RowRange, Range<usize>>,

type Target = <Matrix<DenseRef<'_, E>> as MatIndex<RowRange, Range<usize>>>::Target

Resulting type of the indexing operation.

fn get( this: Self, row: RowRange, col: RangeInclusive<usize> ) -> <Self as MatIndex<RowRange, Range<usize>>>::Target

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity, RowRange> MatIndex<RowRange, RangeTo<usize>> for MatRef<'_, E>

where Self: MatIndex<RowRange, Range<usize>>,

type Target = <Matrix<DenseRef<'_, E>> as MatIndex<RowRange, Range<usize>>>::Target

Resulting type of the indexing operation.

fn get( this: Self, row: RowRange, col: RangeTo<usize> ) -> <Self as MatIndex<RowRange, Range<usize>>>::Target

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity, RowRange> MatIndex<RowRange, RangeToInclusive<usize>> for MatRef<'_, E>

where Self: MatIndex<RowRange, Range<usize>>,

type Target = <Matrix<DenseRef<'_, E>> as MatIndex<RowRange, Range<usize>>>::Target

Resulting type of the indexing operation.

fn get( this: Self, row: RowRange, col: RangeToInclusive<usize> ) -> <Self as MatIndex<RowRange, Range<usize>>>::Target

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<E: Entity> MatIndex<usize, Range<usize>> for MatRef<'_, E>

type Target = Matrix<DenseRef<'_, E>>

Resulting type of the indexing operation.

fn get(this: Self, row: usize, col: Range<usize>) -> Self

Index the matrix at (row, col).

unsafe fn get_unchecked( this: Self, row: RowRange, col: ColRange ) -> Self::Target

Index the matrix at (row, col), without bound checks.

impl<'a, E: Entity> MatIndex<usize, usize> for MatRef<'a, E>

type Target = <<E as Entity>::Group as ForType>::FaerOf<&'a <E as Entity>::Unit>

Resulting type of the indexing operation.

unsafe fn get_unchecked(this: Self, row: usize, col: usize) -> Self::Target

Index the matrix at (row, col), without bound checks.

fn get(this: Self, row: usize, col: usize) -> Self::Target

Index the matrix at (row, col).

impl<E: Entity> MatShape for MatRef<'_, E>

type Rows = usize

Type of rows.

type Cols = usize

Type of columns.

fn nrows(&self) -> Self::Rows

Returns the number of rows.

fn ncols(&self) -> Self::Cols

Returns the number of columns.

impl<E: Entity> Matrix<E> for MatRef<'_, E>

Available on crate feature std only.

fn rows(&self) -> usize

fn cols(&self) -> usize

fn access(&self) -> Access<'_, E>

Expose dense or sparse access to the matrix.

impl<E: Entity> MaybeContiguous for MatRef<'_, E>

type Index = (usize, usize)

Indexing type.

type Slice = <<E as Entity>::Group as ForType>::FaerOf<&'static [MaybeUninit<<E as Entity>::Unit>]>

Contiguous slice type.

type LayoutTransform = MatLayoutTransform

Layout transformation type.

unsafe fn get_slice_unchecked( &mut self, (i, j): Self::Index, n_elems: usize ) -> Self::Slice

Returns slice at index of length n_elems.

impl<'short, 'a, E: Entity> Reborrow<'short> for MatRef<'a, E>

type Target = Matrix<DenseRef<'short, E>>

fn rb(&'short self) -> Self::Target

impl<'short, 'a, E: Entity> ReborrowMut<'short> for MatRef<'a, E>

type Target = Matrix<DenseRef<'short, E>>

fn rb_mut(&'short mut self) -> Self::Target

impl<E: Entity> ViewMut for &MatRef<'_, E>

type Target<'a> = Matrix<DenseRef<'a, E>> where Self: 'a

View type.

fn view_mut(&mut self) -> Self::Target<'_>

Returns the view over self.

impl<E: Entity> ViewMut for &mut MatRef<'_, E>

type Target<'a> = Matrix<DenseRef<'a, E>> where Self: 'a

View type.

fn view_mut(&mut self) -> Self::Target<'_>

Returns the view over self.

impl<E: Entity> ViewMut for MatRef<'_, E>

type Target<'a> = Matrix<DenseRef<'a, E>> where Self: 'a

View type.

fn view_mut(&mut self) -> Self::Target<'_>

Returns the view over self.