Type Alias SparseColMat 

pub type SparseColMat<I, T, Rows = usize, Cols = usize> = SparseColMat<Own<I, T, Rows, Cols>>;

owning sparse column major matrix

see SymbolicSparseColMatRef

Aliased Type

#[repr(transparent)]
pub struct SparseColMat<I, T, Rows = usize, Cols = usize>(/* private fields */);

Implementations

impl<Rows: Shape, Cols: Shape, I: Index, T> SparseColMat<I, T, Rows, Cols>

pub fn new(symbolic: SymbolicSparseColMat<I, Rows, Cols>, val: Vec<T>) -> Self

see [SparseColMatRef::new]

pub fn parts(&self) -> (SymbolicSparseColMatRef<'_, I, Rows, Cols>, &[T])

see [SparseColMatRef::parts]

pub fn parts_mut( &mut self, ) -> (SymbolicSparseColMatRef<'_, I, Rows, Cols>, &mut [T])

see [SparseColMatRef::parts]

pub fn into_parts(self) -> (SymbolicSparseColMat<I, Rows, Cols>, Vec<T>)

see [SparseColMatRef::parts]

pub fn symbolic(&self) -> SymbolicSparseColMatRef<'_, I, Rows, Cols>

see [SparseColMatRef::symbolic]

pub fn val(&self) -> &[T]

see [SparseColMatRef::val]

pub fn val_mut(&mut self) -> &mut [T]

see [SparseColMatRef::val]

pub fn val_of_col(&self, j: Idx<Cols>) -> &[T]

see [SparseColMatRef::val_of_col]

pub fn val_of_col_mut(&mut self, j: Idx<Cols>) -> &mut [T]

see [SparseColMatRef::val_of_col]

pub fn as_shape<V: Shape, H: Shape>( &self, nrows: V, ncols: H, ) -> SparseColMatRef<'_, I, T, V, H>

see [SparseColMatRef::as_shape]

pub fn as_shape_mut<V: Shape, H: Shape>( &mut self, nrows: V, ncols: H, ) -> SparseColMatMut<'_, I, T, V, H>

see [SparseColMatRef::as_shape]

pub fn into_shape<V: Shape, H: Shape>( self, nrows: V, ncols: H, ) -> SparseColMat<I, T, V, H>

see [SparseColMatRef::as_shape]

pub fn as_dyn(&self) -> SparseColMatRef<'_, I, T>

see [SparseColMatRef::as_dyn]

pub fn as_dyn_mut(&mut self) -> SparseColMatMut<'_, I, T>

see [SparseColMatRef::as_dyn]

pub fn into_dyn(self) -> SparseColMat<I, T>

see [SparseColMatRef::as_dyn]

pub fn as_ref(&self) -> SparseColMatRef<'_, I, T, Rows, Cols>

see [SparseColMatRef::as_ref]

pub fn transpose(&self) -> SparseRowMatRef<'_, I, T, Cols, Rows>

see [SparseColMatRef::transpose]

pub fn transpose_mut(&mut self) -> SparseRowMatMut<'_, I, T, Cols, Rows>

see [SparseColMatRef::transpose]

pub fn into_transpose(self) -> SparseRowMat<I, T, Cols, Rows>

see [SparseColMatRef::transpose]

pub fn conjugate(&self) -> SparseColMatRef<'_, I, T::Conj, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::conjugate]

pub fn conjugate_mut(&mut self) -> SparseColMatMut<'_, I, T::Conj, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::conjugate]

pub fn into_conjugate(self) -> SparseColMat<I, T::Conj, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::conjugate]

pub fn adjoint(&self) -> SparseRowMatRef<'_, I, T::Conj, Cols, Rows>

where T: Conjugate,

see [SparseColMatRef::adjoint]

pub fn adjoint_mut(&mut self) -> SparseRowMatMut<'_, I, T::Conj, Cols, Rows>

where T: Conjugate,

see [SparseColMatRef::adjoint]

pub fn into_adjoint(self) -> SparseRowMat<I, T::Conj, Cols, Rows>

where T: Conjugate,

see [SparseColMatRef::adjoint]

pub fn canonical(&self) -> SparseColMatRef<'_, I, T::Canonical, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::canonical]

pub fn canonical_mut( &mut self, ) -> SparseColMatMut<'_, I, T::Canonical, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::canonical]

pub fn into_canonical(self) -> SparseColMat<I, T::Canonical, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::canonical]

pub fn to_row_major( &self, ) -> Result<SparseRowMat<I, T::Canonical, Rows, Cols>, FaerError>

where T: Conjugate,

see [SparseColMatRef::to_row_major]

pub fn to_dense(&self) -> Mat<T::Canonical, Rows, Cols>

where T: Conjugate,

see [SparseColMatRef::to_dense]

pub fn new_from_argsort( symbolic: SymbolicSparseColMat<I, Rows, Cols>, argsort: &Argsort<I>, val: &[T], ) -> Result<Self, FaerError>

where T: ComplexField,

create a new matrix from a previously created symbolic structure and value order

the provided values must correspond to the same indices that were provided in the function call from which the order was created

pub fn try_new_from_triplets( nrows: Rows, ncols: Cols, entries: &[Triplet<Idx<Rows, I>, Idx<Cols, I>, T>], ) -> Result<Self, CreationError>

where T: ComplexField,

create a new matrix from triplets

pub fn try_new_from_nonnegative_triplets( nrows: Rows, ncols: Cols, entries: &[Triplet<MaybeIdx<Rows, I>, MaybeIdx<Cols, I>, T>], ) -> Result<Self, CreationError>

where T: ComplexField,

create a new matrix from triplets

negative indices are ignored

pub fn get(&self, row: Idx<Rows>, col: Idx<Cols>) -> Option<&T>

see [SparseColMatRef::get]

pub fn get_mut(&mut self, row: Idx<Rows>, col: Idx<Cols>) -> Option<&mut T>

see [SparseColMatRef::get]

pub fn triplet_iter( &self, ) -> impl '_ + Iterator<Item = Triplet<Idx<Rows>, Idx<Cols>, &T>>

see [SparseColMatRef::triplet_iter]

Trait Implementations

impl<I: Index, T: ComplexField, ViewT: Conjugate<Canonical = T>> BiLinOp<T> for SparseColMat<I, ViewT>

fn transpose_apply_scratch(&self, rhs_ncols: usize, par: ParShape) -> StackReq

computes the workspace layout required to apply the transpose or adjoint o self to a matrix with rhs_ncols columns

fn transpose_apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies the transpose of self to rhs, and stores the result in out

fn adjoint_apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies the adjoint of self to rhs, and stores the result in out

impl<I: Index, T: ComplexField, ViewT: Conjugate<Canonical = T>> BiPrecond<T> for SparseColMat<I, ViewT>

fn transpose_apply_in_place_scratch( &self, rhs_ncols: usize, par: ParShape, ) -> StackReq

computes the workspace layout required to apply the transpose or adjoint of self to a matrix with rhs_ncols columns in place

fn transpose_apply_in_place( &self, rhs: MatMut<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies the transpose of self to rhs, and stores the result in rhs

fn adjoint_apply_in_place( &self, rhs: MatMut<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies the adjoint of self to rhs, and stores the result in rhs

impl<Rows: Shape, Cols: Shape, I: Index, T: Debug> Debug for SparseColMat<I, T, Rows, Cols>

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

Formats the value using the given formatter.

impl<Rows: Shape, Cols: Shape, I: Index, T> Deref for SparseColMat<I, T, Rows, Cols>

type Target = SymbolicSparseColMat<Own<I, Rows, Cols>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I: Index, T> Index<(usize, usize)> for SparseColMat<I, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<I: Index, T> IndexMut<(usize, usize)> for SparseColMat<I, T>

fn index_mut(&mut self, (row, col): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<I: Index, T: ComplexField, ViewT: Conjugate<Canonical = T>> LinOp<T> for SparseColMat<I, ViewT>

fn nrows(&self) -> usize

output dimension of the operator

fn ncols(&self) -> usize

input dimension of the operator

fn apply_scratch(&self, rhs_ncols: usize, par: ParShape) -> StackReq

computes the workspace layout required to apply self or the conjugate o self to a matrix with rhs_ncols columns

fn apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies self to rhs, and stores the result in out

fn conj_apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies the conjugate of self to rhs, and stores the result in out

impl<I: Index, T: ComplexField, ViewT: Conjugate<Canonical = T>> Precond<T> for SparseColMat<I, ViewT>

fn apply_in_place_scratch(&self, rhs_ncols: usize, par: ParShape) -> StackReq

computes the workspace layout required to apply self or the conjugate of self to a matrix with rhs_ncols columns in place

fn apply_in_place(&self, rhs: MatMut<'_, T>, par: Par<'_>, stack: &mut MemStack)

applies self to rhs, and stores the result in rhs

fn conj_apply_in_place( &self, rhs: MatMut<'_, T>, par: Par<'_>, stack: &mut MemStack, )

applies the conjugate of self to rhs, and stores the result in rhs