Struct extendr_api::prelude::sparse::SymbolicSparseColMat

pub struct SymbolicSparseColMat<I>
where I: Index,
{ pub(crate) nrows: usize, pub(crate) ncols: usize, pub(crate) col_ptr: Vec<I>, pub(crate) col_nnz: Option<Vec<I>>, pub(crate) row_ind: Vec<I>, }
Expand description

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 ncols + 1 (always checked)

  • col_ptrs is non-decreasing

  • col_ptrs[0]..col_ptrs[ncols] 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

  • Within each column, row indices are sorted in non-decreasing order.

§Note

Some algorithms allow working with matrices containing unsorted row indices per column.

Passing such a matrix to an algorithm that does not explicitly permit this is unspecified (though not undefined) behavior.

Fields§

§nrows: usize§ncols: usize§col_ptr: Vec<I>§col_nnz: Option<Vec<I>>§row_ind: Vec<I>

Implementations§

§

impl<I> SymbolicSparseColMat<I>
where I: Index,

pub fn new_checked( nrows: usize, ncols: usize, col_ptrs: Vec<I>, nnz_per_col: Option<Vec<I>>, row_indices: Vec<I>, ) -> SymbolicSparseColMat<I>

Creates a new symbolic matrix view after asserting its invariants.

§Panics

See type level documentation.

pub fn new_unsorted_checked( nrows: usize, ncols: usize, col_ptrs: Vec<I>, nnz_per_col: Option<Vec<I>>, row_indices: Vec<I>, ) -> SymbolicSparseColMat<I>

Creates a new symbolic matrix view from data containing duplicate and/or unsorted row indices per column, after asserting its other invariants.

§Panics

See type level documentation.

pub unsafe fn new_unchecked( nrows: usize, ncols: usize, col_ptrs: Vec<I>, nnz_per_col: Option<Vec<I>>, row_indices: Vec<I>, ) -> SymbolicSparseColMat<I>

Creates a new symbolic matrix view without asserting its invariants.

§Safety

See type level documentation.

pub fn into_parts(self) -> (usize, usize, Vec<I>, Option<Vec<I>>, Vec<I>)

Returns the components of the matrix in the order:

  • row count,
  • column count,
  • column pointers,
  • nonzeros per column,
  • row indices.

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

Returns a view over the symbolic structure of self.

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

Returns the number of rows and columns of the matrix.

pub fn into_transpose(self) -> SymbolicSparseRowMat<I>

Consumes the matrix, and returns its transpose in row-major format without reallocating.

§Note

Allows unsorted matrices, producing an unsorted output.

pub fn to_owned(&self) -> Result<SymbolicSparseColMat<I>, FaerError>

Copies the current matrix into a newly allocated matrix.

§Note

Allows unsorted matrices, producing an unsorted output.

pub fn to_row_major(&self) -> Result<SymbolicSparseRowMat<I>, FaerError>

Copies the current matrix into a newly allocated matrix, with row-major order.

§Note

Allows unsorted matrices, producing a sorted output. Duplicate entries are kept, however.

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.

§Note

Allows unsorted matrices, but the output is a count of all the entries, including the duplicate ones.

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

Returns the column pointers.

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

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

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

Returns the row indices.

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

Returns the row indices of column j.

§Panics

Panics if j >= self.ncols().

pub fn row_indices_of_col( &self, j: usize, ) -> impl ExactSizeIterator + DoubleEndedIterator

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().

§

impl<I> SymbolicSparseColMat<I>
where I: Index,

pub fn try_new_from_indices( nrows: usize, ncols: usize, indices: &[(I, I)], ) -> Result<(SymbolicSparseColMat<I>, ValuesOrder<I>), CreationError>

Create a new symbolic structure, and the corresponding order for the numerical values from pairs of indices (row, col).

pub fn try_new_from_nonnegative_indices( nrows: usize, ncols: usize, indices: &[(<I as Index>::Signed, <I as Index>::Signed)], ) -> Result<(SymbolicSparseColMat<I>, ValuesOrder<I>), CreationError>

Create a new symbolic structure, and the corresponding order for the numerical values from pairs of indices (row, col).

Negative indices are ignored.

Trait Implementations§

§

impl<I> Clone for SymbolicSparseColMat<I>
where I: Clone + Index,

§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<I> Debug for SymbolicSparseColMat<I>
where I: Index,

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.