CsrMatrixBuilder

Struct CsrMatrixBuilder 

Source
pub struct CsrMatrixBuilder<'a, T> { /* private fields */ }
Expand description

A builder for constructing CSR matrices within a CsrMatrixSet.

This builder allows efficient construction of CSR matrices that will be stored in a matrix set. When the builder is dropped, the matrix is automatically added to the parent set.

§Examples

use algebra_sparse::CsrMatrixSet;

let mut set = CsrMatrixSet::default();
let mut builder = set.new_matrix(3, 1e-10);

let mut row_builder = builder.new_row();
row_builder.push(0, 1.0);
row_builder.push(2, 2.0);
// Matrix is automatically added to set when builder is dropped

Implementations§

Source§

impl<T: Real> CsrMatrixBuilder<'_, T>

Source

pub fn ncol(&self) -> usize

Returns the number of columns for the matrix being built.

Source

pub fn new_row(&mut self) -> CsVecBuilder<'_, T>

Creates a new row builder for this matrix.

The returned builder can be used to add non-zero elements to the next row.

§Returns

A CsVecBuilder for constructing a sparse row

Trait Implementations§

Source§

impl<T> Drop for CsrMatrixBuilder<'_, T>

Automatically finalizes the CSR matrix and adds it to the set when the builder is dropped.

This implementation ensures that the matrix is properly added to the parent set when the builder goes out of scope, including updating all necessary metadata.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for CsrMatrixBuilder<'a, T>
where T: Freeze,

§

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

§

impl<'a, T> Send for CsrMatrixBuilder<'a, T>
where T: Send,

§

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

§

impl<'a, T> Unpin for CsrMatrixBuilder<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for CsrMatrixBuilder<'a, T>

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> 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, 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.