Struct SparseColMatRef

pub struct SparseColMatRef<'nrows, 'ncols, 'a, I, E>
where
    I: Index,
    E: Entity,
{
    symbolic: SymbolicSparseColMatRef<'nrows, 'ncols, 'a, I>,
    values: SliceGroup<'a, E>,
}

Immutable sparse matrix view with dimensions equal to the values tied to ('nrows, 'ncols), in column-major order.

Fields

symbolic: SymbolicSparseColMatRef<'nrows, 'ncols, 'a, I>

values: SliceGroup<'a, E>

Implementations

impl<'nrows, 'ncols, 'a, I, E> SparseColMatRef<'nrows, 'ncols, 'a, I, E>

where I: Index, E: Entity,

pub fn new( inner: SparseColMatRef<'a, I, E>, nrows: Size<'nrows>, ncols: Size<'ncols>, ) -> SparseColMatRef<'nrows, 'ncols, 'a, I, E>

Returns a new matrix view after checking that its dimensions match the dimensions tied to ('nrows, 'ncols).

pub fn into_inner(self) -> SparseColMatRef<'a, I, E>

Returns the unconstrained matrix.

pub fn values_of_col( &self, j: Idx<'ncols, usize>, ) -> <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>

Returns the values in column j.

pub fn symbolic(&self) -> SymbolicSparseColMatRef<'nrows, 'ncols, 'a, I>

Returns the symbolic structure of the matrix.

Methods from Deref<Target = SymbolicSparseColMatRef<'nrows, 'ncols, 'a, I>>

pub fn nrows(&self) -> Size<'nrows>

Returns the number of rows of the matrix.

pub fn ncols(&self) -> Size<'ncols>

Returns the number of columns of the matrix.

pub fn row_indices_of_col_raw( &self, j: Idx<'ncols, usize>, ) -> &'a [Idx<'nrows, I>]

Returns the row indices in column j.

pub fn row_indices_of_col( &self, j: Idx<'ncols, usize>, ) -> impl ExactSizeIterator + DoubleEndedIterator + 'a

Returns the row indices in column j.

Trait Implementations

impl<I, E> Clone for SparseColMatRef<'_, '_, '_, I, E>

where I: Index, E: Entity,

fn clone(&self) -> SparseColMatRef<'_, '_, '_, I, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'nrows, 'ncols, 'a, I, E> Deref for SparseColMatRef<'nrows, 'ncols, 'a, I, E>

where I: Index, E: Entity,

type Target = SymbolicSparseColMatRef<'nrows, 'ncols, 'a, I>

The resulting type after dereferencing.

fn deref(&self) -> &<SparseColMatRef<'nrows, 'ncols, 'a, I, E> as Deref>::Target

Dereferences the value.

impl<'nrows, 'ncols, 'a, I, E> IntoConst for SparseColMatRef<'nrows, 'ncols, 'a, I, E>

where I: Index, E: Entity,

type Target = SparseColMatRef<'nrows, 'ncols, 'a, I, E>

fn into_const( self, ) -> <SparseColMatRef<'nrows, 'ncols, 'a, I, E> as IntoConst>::Target

impl<'short, 'nrows, 'ncols, 'a, I, E> Reborrow<'short> for SparseColMatRef<'nrows, 'ncols, 'a, I, E>

where I: Index, E: Entity,

type Target = SparseColMatRef<'nrows, 'ncols, 'short, I, E>

fn rb( &'short self, ) -> <SparseColMatRef<'nrows, 'ncols, 'a, I, E> as Reborrow<'short>>::Target

impl<'short, 'nrows, 'ncols, 'a, I, E> ReborrowMut<'short> for SparseColMatRef<'nrows, 'ncols, 'a, I, E>

where I: Index, E: Entity,

type Target = SparseColMatRef<'nrows, 'ncols, 'short, I, E>

fn rb_mut( &'short mut self, ) -> <SparseColMatRef<'nrows, 'ncols, 'a, I, E> as ReborrowMut<'short>>::Target

impl<I, E> Copy for SparseColMatRef<'_, '_, '_, I, E>

where I: Index, E: Entity,