CsrMatrixView

Struct CsrMatrixView 

Source
pub struct CsrMatrixView<'a, T>(/* private fields */);
Expand description

An immutable view of a CSR matrix.

This provides efficient read-only access to CSR matrix data without allocation. Views are commonly used for matrix operations and can be easily created from both mutable and immutable CSR matrices.

§Examples

use algebra_sparse::{CsrMatrix, CsrMatrixViewMethods};
use nalgebra::DMatrix;

let dense = DMatrix::from_row_slice(2, 2, &[1.0, 2.0, 3.0, 4.0]);
let csr = CsrMatrix::from_dense(dense.as_view());
let view = csr.as_view();

println!("Number of rows: {}", view.nrows());
println!("Number of columns: {}", view.ncols());

Implementations§

Source§

impl<'a, T> CsrMatrixView<'a, T>

Source

pub fn from_parts_unchecked( row_offsets: &'a [usize], col_indices: &'a [usize], values: &'a [T], ncol: usize, ) -> Self

Creates a CsrMatrixView from raw parts without checking validity.

§Safety

This function does not validate that the provided parts form a valid CSR matrix. Invalid parts may cause undefined behavior when accessing the matrix.

§Arguments
  • row_offsets - Row offset array (length = nrows + 1)
  • col_indices - Column index array for non-zero elements
  • values - Non-zero values array
  • ncol - Number of columns
Source§

impl<'a, T> CsrMatrixView<'a, T>
where T: Real,

Source

pub fn dense_rate(&self) -> f32

Returns the density rate of the matrix.

This is the ratio of non-zero elements to total elements. A value of 0.1 means 10% of elements are non-zero.

Source

pub fn transpose(&self) -> CscMatrixView<'a, T>

Transposes the CSR matrix view to a CSC matrix view.

This is a zero-cost operation that only changes the interpretation of the data. No data is copied or moved.

§Returns

A CSC view of the same matrix data

Source

pub fn shape(&self) -> (usize, usize)

Returns the shape of the matrix as (nrows, ncols).

Source

pub fn nrows(&self) -> usize

Returns the number of rows in the matrix.

Source

pub fn ncols(&self) -> usize

Returns the number of columns in the matrix.

Source

pub fn get_row(self, row_index: usize) -> CsVecRef<'a, T>

Gets a row as a sparse vector.

§Arguments
  • row_index - Index of the row to retrieve
§Returns

A CsVecRef representing the sparse vector for this row

Trait Implementations§

Source§

impl<'a, T: Clone> Clone for CsrMatrixView<'a, T>

Source§

fn clone(&self) -> CsrMatrixView<'a, T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, T: Debug> Debug for CsrMatrixView<'a, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'b, T> IntoView for &CsrMatrixView<'b, T>
where T: Copy,

Source§

type View = CsrMatrixView<'b, T>

The view type produced by this trait.
Source§

fn into_view(self) -> Self::View

Converts the type into an immutable view. Read more
Source§

impl<'a, T> IntoView for CsrMatrixView<'a, T>

Source§

type View = CsrMatrixView<'a, T>

The view type produced by this trait.
Source§

fn into_view(self) -> Self::View

Converts the type into an immutable view. Read more
Source§

impl<'a, T: Real> Mul<CscMatrixView<'a, T>> for CsrMatrixView<'a, T>

Source§

type Output = CsrMatrix<T>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: CscMatrixView<'a, T>) -> Self::Output

Performs the * operation. Read more
Source§

impl<'a, T: Real> Mul<DiagonalBlockMatrixView<'a, T>> for CsrMatrixView<'a, T>

Source§

type Output = CsrMatrix<T>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DiagonalBlockMatrixView<'a, T>) -> Self::Output

Performs the * operation. Read more
Source§

impl<'a, T: Real> Mul<Matrix<T, Dyn, Const<1>, VecStorage<T, Dyn, Const<1>>>> for CsrMatrixView<'a, T>

Source§

type Output = Matrix<T, Dyn, Const<1>, VecStorage<T, Dyn, Const<1>>>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DVector<T>) -> Self::Output

Performs the * operation. Read more
Source§

impl<'a, T: Real> Mul<Matrix<T, Dyn, Const<1>, ViewStorage<'a, T, Dyn, Const<1>, Const<1>, Dyn>>> for CsrMatrixView<'a, T>

Source§

type Output = Matrix<T, Dyn, Const<1>, VecStorage<T, Dyn, Const<1>>>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DVectorView<'a, T>) -> Self::Output

Performs the * operation. Read more
Source§

impl<'a, T: Real> Mul<Matrix<T, Dyn, Dyn, ViewStorage<'a, T, Dyn, Dyn, Const<1>, Dyn>>> for CsrMatrixView<'a, T>

Source§

type Output = CsrMatrix<T>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: DMatrixView<'a, T>) -> Self::Output

Performs the * operation. Read more
Source§

impl<'a, T: Copy> Copy for CsrMatrixView<'a, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for CsrMatrixView<'a, T>

§

impl<'a, T> RefUnwindSafe for CsrMatrixView<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for CsrMatrixView<'a, T>
where T: Sync,

§

impl<'a, T> Sync for CsrMatrixView<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for CsrMatrixView<'a, T>

§

impl<'a, T> UnwindSafe for CsrMatrixView<'a, T>
where T: RefUnwindSafe,

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.