Skip to main content

CscPattern

Struct CscPattern 

Source
pub struct CscPattern<'a> {
    pub n: usize,
    pub col_ptr: &'a [i32],
    pub row_idx: &'a [i32],
}
Expand description

Borrowed symmetric sparsity pattern in CSC form.

The pattern must be full-symmetric — both the upper and lower halves are present. Row indices within each column must be sorted in ascending order. Indices are 0-based.

Invariants (checked by CscPattern::new):

  • col_ptr.len() == n + 1
  • col_ptr[0] == 0, col_ptr is non-decreasing
  • row_idx.len() == col_ptr[n]
  • every row index is in 0..n (non-negative and < n)
  • row indices within each column are sorted ascending

Structural symmetry is the caller’s responsibility and is not checked here; individual ordering crates may debug-assert it.

Fields§

§n: usize

Matrix dimension.

§col_ptr: &'a [i32]

Column pointers. Length n + 1.

§row_idx: &'a [i32]

Row indices. Length col_ptr[n].

Implementations§

Source§

impl<'a> CscPattern<'a>

Source

pub fn new( n: usize, col_ptr: &'a [i32], row_idx: &'a [i32], ) -> Option<CscPattern<'a>>

Construct a validated pattern.

Returns None if the structural invariants above are violated. Does not check symmetry.

Source

pub fn nnz(&self) -> usize

Number of stored nonzeros.

Trait Implementations§

Source§

impl<'a> Clone for CscPattern<'a>

Source§

fn clone(&self) -> CscPattern<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for CscPattern<'a>

Source§

impl<'a> Debug for CscPattern<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CscPattern<'a>

§

impl<'a> RefUnwindSafe for CscPattern<'a>

§

impl<'a> Send for CscPattern<'a>

§

impl<'a> Sync for CscPattern<'a>

§

impl<'a> Unpin for CscPattern<'a>

§

impl<'a> UnsafeUnpin for CscPattern<'a>

§

impl<'a> UnwindSafe for CscPattern<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.