Struct faer::mat::Mat

source ·

#[repr(C)]
pub struct Mat<E: Entity> { /* private fields */ }

Expand description

Heap allocated resizable matrix, similar to a 2D Vec.

§Note

The memory layout of Mat is guaranteed to be column-major, meaning that it has a row stride of 1, and an unspecified column stride that can be queried with Mat::col_stride.

This implies that while each individual column is stored contiguously in memory, the matrix as a whole may not necessarily be contiguous. The implementation may add padding at the end of each column when overaligning each column can provide a performance gain.

Let us consider a 3×4 matrix

 0 │ 3 │ 6 │  9
───┼───┼───┼───
 1 │ 4 │ 7 │ 10
───┼───┼───┼───
 2 │ 5 │ 8 │ 11

The memory representation of the data held by such a matrix could look like the following:

0 1 2 X 3 4 5 X 6 7 8 X 9 10 11 X

where X represents padding elements.

Struct faer::mat::Mat

§Note

Implementations§

impl<E: Conjugate> Mat<E>where E::Canonical: ComplexField,

pub fn solve_lower_triangular_in_place( &self, rhs: impl ColBatchMut<E::Canonical> )

pub fn solve_upper_triangular_in_place( &self, rhs: impl ColBatchMut<E::Canonical> )

pub fn solve_unit_lower_triangular_in_place( &self, rhs: impl ColBatchMut<E::Canonical> )

pub fn solve_unit_upper_triangular_in_place( &self, rhs: impl ColBatchMut<E::Canonical> )

pub fn solve_lower_triangular<ViewE: Conjugate<Canonical = E::Canonical>, B: ColBatch<ViewE>>( &self, rhs: B ) -> B::Owned

pub fn solve_upper_triangular<ViewE: Conjugate<Canonical = E::Canonical>, B: ColBatch<ViewE>>( &self, rhs: B ) -> B::Owned

pub fn solve_unit_lower_triangular<ViewE: Conjugate<Canonical = E::Canonical>, B: ColBatch<ViewE>>( &self, rhs: B ) -> B::Owned

pub fn solve_unit_upper_triangular<ViewE: Conjugate<Canonical = E::Canonical>, B: ColBatch<ViewE>>( &self, rhs: B ) -> B::Owned

pub fn cholesky( &self, side: Side ) -> Result<Cholesky<E::Canonical>, CholeskyError>

pub fn lblt(&self, side: Side) -> Lblt<E::Canonical>

pub fn partial_piv_lu(&self) -> PartialPivLu<E::Canonical>

pub fn full_piv_lu(&self) -> FullPivLu<E::Canonical>

pub fn qr(&self) -> Qr<E::Canonical>

pub fn col_piv_qr(&self) -> ColPivQr<E::Canonical>

pub fn svd(&self) -> Svd<E::Canonical>

pub fn thin_svd(&self) -> ThinSvd<E::Canonical>

pub fn selfadjoint_eigendecomposition( &self, side: Side ) -> SelfAdjointEigendecomposition<E::Canonical>

pub fn eigendecomposition<ComplexE: ComplexField<Real = <E::Canonical as ComplexField>::Real>>( &self ) -> Eigendecomposition<ComplexE>

pub fn complex_eigendecomposition(&self) -> Eigendecomposition<E::Canonical>

pub fn determinant(&self) -> E::Canonical

pub fn selfadjoint_eigenvalues( &self, side: Side ) -> Vec<<E::Canonical as ComplexField>::Real>

pub fn singular_values(&self) -> Vec<<E::Canonical as ComplexField>::Real>

pub fn eigenvalues<ComplexE: ComplexField<Real = <E::Canonical as ComplexField>::Real>>( &self ) -> Vec<ComplexE>

pub fn complex_eigenvalues(&self) -> Vec<E::Canonical>

impl<E: Entity> Mat<E>

pub fn new() -> Self

pub fn with_capacity(row_capacity: usize, col_capacity: usize) -> Self

§Panics

pub fn from_fn( nrows: usize, ncols: usize, f: impl FnMut(usize, usize) -> E ) -> Self

§Panics

pub fn zeros(nrows: usize, ncols: usize) -> Self

§Panics

pub fn identity(nrows: usize, ncols: usize) -> Selfwhere E: ComplexField,

§Panics

pub fn nrows(&self) -> usize

pub fn ncols(&self) -> usize

pub unsafe fn set_dims(&mut self, nrows: usize, ncols: usize)

§Safety

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

pub fn as_ptr_mut(&mut self) -> GroupFor<E, *mut E::Unit>

pub fn row_capacity(&self) -> usize

pub fn col_capacity(&self) -> usize

pub fn row_stride(&self) -> isize

pub fn col_stride(&self) -> isize

pub fn reserve_exact(&mut self, row_capacity: usize, col_capacity: usize)

§Panics

pub fn resize_with( &mut self, new_nrows: usize, new_ncols: usize, f: impl FnMut(usize, usize) -> E )

pub fn truncate(&mut self, new_nrows: usize, new_ncols: usize)

§Panics

pub fn col_as_slice(&self, col: usize) -> GroupFor<E, &[E::Unit]>

pub fn col_as_slice_mut(&mut self, col: usize) -> GroupFor<E, &mut [E::Unit]>

pub fn col_ref(&self, col: usize) -> GroupFor<E, &[E::Unit]>

pub fn col_mut(&mut self, col: usize) -> GroupFor<E, &mut [E::Unit]>

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

pub fn as_mut(&mut self) -> MatMut<'_, E>

pub unsafe fn get_unchecked<RowRange, ColRange>( &self, row: RowRange, col: ColRange ) -> <MatRef<'_, E> as MatIndex<RowRange, ColRange>>::Targetwhere for<'a> MatRef<'a, E>: MatIndex<RowRange, ColRange>,

§Note

§Safety

pub fn get<RowRange, ColRange>( &self, row: RowRange, col: ColRange ) -> <MatRef<'_, E> as MatIndex<RowRange, ColRange>>::Targetwhere for<'a> MatRef<'a, E>: MatIndex<RowRange, ColRange>,

§Note

§Panics

pub unsafe fn get_mut_unchecked<RowRange, ColRange>( &mut self, row: RowRange, col: ColRange ) -> <MatMut<'_, E> as MatIndex<RowRange, ColRange>>::Targetwhere for<'a> MatMut<'a, E>: MatIndex<RowRange, ColRange>,

§Note

§Safety

pub fn get_mut<RowRange, ColRange>( &mut self, row: RowRange, col: ColRange ) -> <MatMut<'_, E> as MatIndex<RowRange, ColRange>>::Targetwhere for<'a> MatMut<'a, E>: MatIndex<RowRange, ColRange>,

§Note

§Panics

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

§Safety

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

§Panics

pub unsafe fn write_unchecked(&mut self, row: usize, col: usize, value: E)

§Safety

pub fn write(&mut self, row: usize, col: usize, value: E)

§Panics

pub fn copy_from(&mut self, other: impl AsMatRef<E>)

impl<E: Conjugate> Mat<E>
where E::Canonical: ComplexField,

pub fn identity(nrows: usize, ncols: usize) -> Self
where E: ComplexField,

pub unsafe fn get_unchecked<RowRange, ColRange>( &self, row: RowRange, col: ColRange ) -> <MatRef<'_, E> as MatIndex<RowRange, ColRange>>::Target
where for<'a> MatRef<'a, E>: MatIndex<RowRange, ColRange>,

pub fn get<RowRange, ColRange>( &self, row: RowRange, col: ColRange ) -> <MatRef<'_, E> as MatIndex<RowRange, ColRange>>::Target
where for<'a> MatRef<'a, E>: MatIndex<RowRange, ColRange>,

pub unsafe fn get_mut_unchecked<RowRange, ColRange>( &mut self, row: RowRange, col: ColRange ) -> <MatMut<'_, E> as MatIndex<RowRange, ColRange>>::Target
where for<'a> MatMut<'a, E>: MatIndex<RowRange, ColRange>,

pub fn get_mut<RowRange, ColRange>( &mut self, row: RowRange, col: ColRange ) -> <MatMut<'_, E> as MatIndex<RowRange, ColRange>>::Target
where for<'a> MatMut<'a, E>: MatIndex<RowRange, ColRange>,

pub fn fill_zero(&mut self)
where E: ComplexField,

pub fn conjugate(&self) -> MatRef<'_, E::Conj>
where E: Conjugate,

pub fn adjoint(&self) -> MatRef<'_, E::Conj>
where E: Conjugate,

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

pub fn has_nan(&self) -> bool
where E: ComplexField,

pub fn is_all_finite(&self) -> bool
where E: ComplexField,

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

pub fn norm_l1(&self) -> E::Real
where E: ComplexField,

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

pub fn squared_norm_l2(&self) -> E::Real
where E: ComplexField,

pub fn sum(&self) -> E
where E: ComplexField,

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