Struct Pattern 

pub struct Pattern {
    pub n_rows: usize,
    pub col_ptr: Vec<usize>,
    pub row_idx: Vec<u32>,
}

The structure of a compressed sparse column matrix without its values (invariant (P2)): what the orderings of Chapter 5.10 consume.

Fields

n_rows: usize

Number of rows m.

col_ptr: Vec<usize>

Column pointers, length n + 1.

row_idx: Vec<u32>

Row indices, strictly increasing inside each column.

Implementations

impl Pattern

pub fn from_raw_parts( n_rows: usize, col_ptr: Vec<usize>, row_idx: Vec<u32>, ) -> Result<Self, SparseError>

The pattern with the given arrays, validated ((P2)).

pub fn empty(n_rows: usize, n_cols: usize) -> Self

The empty m × n pattern.

Panics

If m or n exceeds u32::MAX.

pub fn n_rows(&self) -> usize

Number of rows m.

pub fn n_cols(&self) -> usize

Number of columns n.

pub fn nnz(&self) -> usize

Number of stored entries.

pub fn col(&self, j: usize) -> &[u32]

The row indices of column j.

pub fn transpose(&self) -> Self

Sᵀ (Algorithm T of Chapter 5.8, indices only).

pub fn symmetric(&self) -> Result<Self, SparseError>

S + Sᵀ (Algorithm S); the diagonal entries of S are kept, none is added. An error unless S is square.

pub fn ata(&self) -> Self

The pattern of SᵀS (Algorithm G), diagonal included: an n × n symmetric pattern.

pub fn cholesky_nnz(&self, perm: &Perm) -> Result<usize, SparseError>

nnz(L), diagonal included, of the Cholesky factor of P (S + Sᵀ) Pᵀ for the permutation perm (Algorithm E): the fill an ordering yields. An error unless S is square with perm of the same order.

pub fn check_invariants(&self) -> Result<(), SparseError>

Checks invariant (P2).

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl Eq for Pattern

impl PartialEq for Pattern

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Pattern