Struct faer_core::sparse::SymbolicSparseColMatRef

pub struct SymbolicSparseColMatRef<'a, I> { /* private fields */ }

Symbolic structure of sparse matrix in column format, either compressed or uncompressed.

Requires:

• nrows <= I::Signed::MAX (always checked)

• ncols <= I::Signed::MAX (always checked)

• col_ptrs has length n (always checked)

• col_ptrs is non-decreasing

• col_ptrs[0]..col_ptrs[n] is a valid range in row_indices (always checked, assuming non-decreasing)

• if nnz_per_col is None, elements of row_indices[col_ptrs[j]..col_ptrs[j + 1]] are less than nrows

• nnz_per_col[j] <= col_ptrs[j+1] - col_ptrs[j]

• if nnz_per_col is Some(_), elements of row_indices[col_ptrs[j]..][..nnz_per_col[j]] are less than nrows

Implementations

impl<'a, I: Index> SymbolicSparseColMatRef<'a, I>

pub fn new_checked( nrows: usize, ncols: usize, col_ptrs: &'a [I], nnz_per_col: Option<&'a [I]>, row_indices: &'a [I] ) -> Self

Creates a new symbolic matrix view after asserting its invariants.

Panics

See type level documentation.

pub unsafe fn new_unchecked( nrows: usize, ncols: usize, col_ptrs: &'a [I], nnz_per_col: Option<&'a [I]>, row_indices: &'a [I] ) -> Self

Creates a new symbolic matrix view without asserting its invariants.

Safety

See type level documentation.

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 compute_nnz(&self) -> usize

Returns the number of symbolic non-zeros in the matrix.

The value is guaranteed to be less than I::Signed::MAX.

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

Returns the column pointers.

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

Returns the count of non-zeros per column of the matrix.

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

Returns the row indices.

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

Returns the row indices of column j.

Panics

Panics if j >= self.ncols()

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

Returns the row indices of column j.

Panics

Panics if j >= self.ncols()

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

Returns the range that the column j occupies in `self.row_indices().

Panics

Panics if j >= self.ncols()

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

Returns the range that the column j occupies in `self.row_indices().

Safety

The behavior is undefined if j >= self.ncols()

Trait Implementations

impl<I> Clone for SymbolicSparseColMatRef<'_, I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I: Debug> Debug for SymbolicSparseColMatRef<'a, I>

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

Formats the value using the given formatter.

impl<I> Copy for SymbolicSparseColMatRef<'_, I>