Type Alias SparseColMatRef 

pub type SparseColMatRef<'a, I, T, Rows = usize, Cols = usize> = SparseColMat<Ref<'a, I, T, Rows, Cols>>;

view over sparse column major matrix

see SymbolicSparseColMatRef

Aliased Type

#[repr(transparent)]
pub struct SparseColMatRef<'a, I, T, Rows = usize, Cols = usize>(pub Ref<'a, I, T, Rows, Cols>);

Tuple Fields

0: Ref<'a, I, T, Rows, Cols>

Implementations

impl<'a, Rows: Shape, Cols: Shape, I: Index, T> SparseColMatRef<'a, I, T, Rows, Cols>

pub fn new( symbolic: SymbolicSparseColMatRef<'a, I, Rows, Cols>, val: &'a [T], ) -> Self

creates a new sparse matrix view.

panics

panics if the length of values is not equal to the length of symbolic.row_idx()

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

returns the symbolic and numeric components of the sparse matrix

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

returns the symbolic component of the sparse matrix

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

returns the numeric component of the sparse matrix

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

returns a view over the values of column j

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

returns the input matrix with the given shape after checking that it matches the current shape

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

returns a reference to the value at the given index, or None if the symbolic structure doesn’t contain it, or contains multiple indices with the given index

panics

• panics if row >= self.nrows()
• panics if col >= self.ncols()

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

returns the input matrix with dynamic shape

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

returns a view over self

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

returns a view over the transpose of self

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

where T: Conjugate,

returns a view over the conjugate of self

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

where T: Conjugate,

returns a view over the adjoint of self

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

where T: Conjugate,

returns an unconjugated view over self

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

where T: Conjugate,

returns a newly allocated matrix holding the (possibly conjugated) values of self in row major format

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

where T: Conjugate,

returns a newly allocated dense matrix holding the (possibly conjugated) values of self

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

where Rows: 'a, Cols: 'a,

returns an iterator over the entries of the matrix.

Methods from Deref<Target = SymbolicSparseColMatRef<'a, I, Rows, Cols>>

pub fn nrows(&self) -> Rows

returns the number of rows of the matrix

pub fn ncols(&self) -> Cols

returns the number of columns of the matrix

pub fn shape(&self) -> (Rows, Cols)

returns the number of rows and columns of the matrix

pub fn to_owned(&self) -> Result<SymbolicSparseColMat<I, Rows, Cols>, FaerError>

returns a newly allocated matrix holding the values of self

pub fn to_row_major( &self, ) -> Result<SymbolicSparseRowMat<I, Rows, Cols>, FaerError>

returns a newly allocated matrix holding the values of self in row major format

pub fn compute_nnz(&self) -> usize

returns the number of non-zero elements in the matrix

pub fn col_ptr(&self) -> &'a [I]

returns the column pointers

pub fn col_nnz(&self) -> Option<&'a [I]>

returns the column non-zero counts

pub fn row_idx(&self) -> &'a [I]

returns the row indices

pub fn col_range(&self, j: Idx<Cols>) -> Range<usize>

returns the range specifying the indices of column j

pub unsafe fn col_range_unchecked(&self, j: Idx<Cols>) -> Range<usize>

returns the range specifying the indices of column j, without bound checks

pub fn row_idx_of_col_raw(&self, j: Idx<Cols>) -> &'a [Idx<Rows, I>]

returns the row indices of column j

pub fn row_idx_of_col( &self, j: Idx<Cols>, ) -> impl 'a + Clone + ExactSizeIterator + DoubleEndedIterator<Item = Idx<Rows>>

where Rows: 'a, Cols: 'a,

returns the row indices of column j

pub fn parts(&self) -> (Rows, Cols, &[I], Option<&[I]>, &[I])

see SymbolicSparseColMatRef::parts

pub fn nrows(&self) -> Rows

returns the number of rows of the matrix

pub fn ncols(&self) -> Cols

returns the number of columns of the matrix

pub fn shape(&self) -> (Rows, Cols)

returns the number of rows and columns of the matrix

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

returns a view over the transpose of self

pub fn to_owned(&self) -> Result<SymbolicSparseColMat<I, Rows, Cols>, FaerError>

see SymbolicSparseColMatRef::to_owned

pub fn to_row_major( &self, ) -> Result<SymbolicSparseRowMat<I, Rows, Cols>, FaerError>

see SymbolicSparseColMatRef::to_row_major

pub fn compute_nnz(&self) -> usize

see SymbolicSparseColMatRef::compute_nnz

pub fn col_ptr(&self) -> &[I]

see SymbolicSparseColMatRef::col_ptr

pub fn col_nnz(&self) -> Option<&[I]>

see SymbolicSparseColMatRef::col_nnz

pub fn row_idx(&self) -> &[I]

see SymbolicSparseColMatRef::row_idx

pub fn col_range(&self, j: Idx<Cols>) -> Range<usize>

see SymbolicSparseColMatRef::col_range

pub unsafe fn col_range_unchecked(&self, j: Idx<Cols>) -> Range<usize>

see SymbolicSparseColMatRef::col_range_unchecked

pub fn row_idx_of_col_raw(&self, j: Idx<Cols>) -> &[Idx<Rows, I>]

see SymbolicSparseColMatRef::row_idx_of_col_raw

pub fn row_idx_of_col( &self, j: Idx<Cols>, ) -> impl '_ + Clone + ExactSizeIterator + DoubleEndedIterator<Item = Idx<Rows>>

see SymbolicSparseColMatRef::row_idx_of_col

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

see SymbolicSparseColMatRef::as_shape

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

see SymbolicSparseColMatRef::as_dyn

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

Returns a view over the symbolic structure of self.

Trait Implementations

impl<T: ComplexField, I: Index, ViewT: Conjugate<Canonical = T>> BiLinOp<T> for SparseColMatRef<'_, I, ViewT>

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

computes the workspace size and alignment 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<T: ComplexField, I: Index, ViewT: Conjugate<Canonical = T>> BiPrecond<T> for SparseColMatRef<'_, I, ViewT>

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

computes the workspace size and alignment 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<'a, Rows: Shape, Cols: Shape, I: Index, T> Deref for SparseColMatRef<'a, I, T, Rows, Cols>

type Target = SymbolicSparseColMat<Ref<'a, I, Rows, Cols>>

The resulting type after dereferencing.

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

Dereferences the value.

impl<I: Index, T> Index<(usize, usize)> for SparseColMatRef<'_, 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<T: ComplexField, I: Index, ViewT: Conjugate<Canonical = T>> LinOp<T> for SparseColMatRef<'_, 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: Par) -> StackReq

computes the workspace size and alignment 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<T: ComplexField, I: Index, ViewT: Conjugate<Canonical = T>> Precond<T> for SparseColMatRef<'_, I, ViewT>

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

computes the workspace size and alignment 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