Struct CsVecRef 

#[non_exhaustive]
pub struct CsVecRef<'a, T> { /* private fields */ }

An immutable view of a sparse vector.

This provides efficient read-only access to sparse vector data without allocation. Sparse vectors store only non-zero elements and their indices, making them memory-efficient for vectors with few non-zero elements.

Format

The sparse vector uses two parallel arrays:

• indices: Indices of non-zero elements
• values: Non-zero values corresponding to each index

Examples

use algebra_sparse::CsVecRef;

let indices = [0, 2, 4];
let values = [1.0, 3.0, 5.0];
let sparse_vec = CsVecRef::from_parts_unchecked(&indices, &values, 6);

// Iterate over non-zero elements
for (index, value) in sparse_vec.iter() {
    println!("vec[{}] = {}", index, value);
}

Implementations

impl<'a, T> CsVecRef<'a, T>

pub fn from_parts_unchecked( indices: &'a [usize], values: &'a [T], len: usize, ) -> Self

Creates a CsVecRef from raw parts without checking validity.

Safety

This function does not validate that the provided parts form a valid sparse vector. The indices and values arrays should have the same length, and indices should be in ascending order and within bounds [0, len).

Arguments

• indices - Indices of non-zero elements
• values - Non-zero values corresponding to each index
• len - Total length of the vector

pub fn iter(&self) -> impl Iterator<Item = (usize, T)>

where T: Copy,

Returns an iterator over the non-zero elements of the vector.

The iterator yields tuples of (index, value) for each non-zero element.

Returns

An iterator over (index, value) pairs

pub fn len(&self) -> usize

Returns the total length of the vector.

This is the full length of the vector, not the number of non-zero elements.

Returns

The total length including zero elements

pub fn is_empty(&self) -> bool

Returns true if the vector is empty (has length 0).

pub fn indices(&self) -> &'a [usize]

Returns the indices of the non-zero elements.

Returns

A slice of indices for non-zero elements

pub fn values(&self) -> &'a [T]

Returns all non-zero values in the vector.

Returns

A slice of non-zero values

Trait Implementations

impl<'a, T: Real> Add<Matrix<T, Dyn, Const<1>, ViewStorage<'a, T, Dyn, Const<1>, Const<1>, Dyn>>> for CsVecRef<'a, T>

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

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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