Struct SymbolicSparseColMat 

#[repr(transparent)]
pub struct SymbolicSparseColMat<Inner>(pub Inner);

generic SymbolicSparseColMat wrapper

Tuple Fields

0: Inner

Implementations

impl<Inner> SymbolicSparseColMat<Inner>

pub fn from_inner_ref(inner: &Inner) -> &Self

wrap by reference

pub fn from_inner_mut(inner: &mut Inner) -> &mut Self

wrap by mutable reference

impl<'a, Rows: Shape, Cols: Shape, I: Index> SymbolicSparseColMat<Ref<'a, I, Rows, Cols>>

pub unsafe fn new_unchecked( nrows: Rows, ncols: Cols, col_ptr: &'a [I], col_nnz: Option<&'a [I]>, row_idx: &'a [I], ) -> Self

creates a new symbolic matrix view without checking its invariants

safety

see type level documentation.

pub fn new_checked( nrows: Rows, ncols: Cols, col_ptr: &'a [I], col_nnz: Option<&'a [I]>, row_idx: &'a [I], ) -> Self

creates a new symbolic matrix view after checking its invariants

safety

see type level documentation.

pub fn new_unsorted_checked( nrows: Rows, ncols: Cols, col_ptr: &'a [I], col_nnz: Option<&'a [I]>, row_idx: &'a [I], ) -> Self

creates a new symbolic matrix view after checking its invariants (excluding soft invariants)

safety

see type level documentation.

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

returns the components of the sparse matrix

• number of rows
• number of columns
• column pointers
• column non-zero counts
• row indices

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<'a, I, Cols, Rows>

returns a view over the transpose of self

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 as_shape<V: Shape, H: Shape>( self, nrows: V, ncols: H, ) -> SymbolicSparseColMatRef<'a, I, V, H>

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

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

returns the input matrix with dynamic shape

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

Returns a view over the symbolic structure of self.

impl<Rows: Shape, Cols: Shape, I: Index> SymbolicSparseColMat<Own<I, Rows, Cols>>

pub unsafe fn new_unchecked( nrows: Rows, ncols: Cols, col_ptr: Vec<I>, col_nnz: Option<Vec<I>>, row_idx: Vec<I>, ) -> Self

creates a new symbolic matrix view without checking its invariants

safety

see type level documentation.

pub fn new_checked( nrows: Rows, ncols: Cols, col_ptr: Vec<I>, col_nnz: Option<Vec<I>>, row_idx: Vec<I>, ) -> Self

creates a new symbolic matrix view after checking its invariants

safety

see type level documentation.

pub fn new_unsorted_checked( nrows: Rows, ncols: Cols, col_ptr: Vec<I>, col_nnz: Option<Vec<I>>, row_idx: Vec<I>, ) -> Self

creates a new symbolic matrix view after checking its invariants (excluding soft invariants)

safety

see type level documentation.

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

see SymbolicSparseColMatRef::parts

pub fn into_parts(self) -> (Rows, Cols, Vec<I>, Option<Vec<I>>, Vec<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 into_transpose(self) -> SymbolicSparseRowMat<I, Cols, Rows>

returns 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 into_shape<V: Shape, H: Shape>( self, nrows: V, ncols: H, ) -> SymbolicSparseColMat<I, V, H>

see SymbolicSparseColMatRef::as_shape

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

see SymbolicSparseColMatRef::as_dyn

pub fn into_dyn(self) -> SymbolicSparseColMat<I>

see SymbolicSparseColMatRef::as_dyn

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

Returns a view over the symbolic structure of self.

pub fn try_new_from_indices( nrows: Rows, ncols: Cols, idx: &[Pair<Idx<Rows, I>, Idx<Cols, I>>], ) -> Result<(Self, Argsort<I>), CreationError>

create a new symbolic structure, and the corresponding order for the numerical values from pairs of indices

pub fn try_new_from_nonnegative_indices( nrows: Rows, ncols: Cols, idx: &[Pair<MaybeIdx<Rows, I>, MaybeIdx<Cols, I>>], ) -> Result<(Self, Argsort<I>), CreationError>

create a new symbolic structure, and the corresponding order for the numerical values from pairs of indices

negative indices are ignored

Trait Implementations

impl<Inner: Clone> Clone for SymbolicSparseColMat<Inner>

fn clone(&self) -> SymbolicSparseColMat<Inner>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Inner: Debug> Debug for SymbolicSparseColMat<Inner>

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

Formats the value using the given formatter.

impl<Inner> Deref for SymbolicSparseColMat<Inner>

type Target = Inner

The resulting type after dereferencing.

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

Dereferences the value.

impl<Inner> DerefMut for SymbolicSparseColMat<Inner>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Inner: IntoConst> IntoConst for SymbolicSparseColMat<Inner>

type Target = SymbolicSparseColMat<<Inner as IntoConst>::Target>

fn into_const(self) -> Self::Target

impl<'short, Inner: Reborrow<'short>> Reborrow<'short> for SymbolicSparseColMat<Inner>

type Target = SymbolicSparseColMat<<Inner as Reborrow<'short>>::Target>

fn rb(&'short self) -> Self::Target

impl<'short, Inner: ReborrowMut<'short>> ReborrowMut<'short> for SymbolicSparseColMat<Inner>

type Target = SymbolicSparseColMat<<Inner as ReborrowMut<'short>>::Target>

fn rb_mut(&'short mut self) -> Self::Target

impl<Inner: Copy> Copy for SymbolicSparseColMat<Inner>