Struct mop_structs::matrix::csr_matrix::CsrMatrixRowConstructor

pub struct CsrMatrixRowConstructor<'a, DS, US> { /* fields omitted */ }

Constructs a new valid row in a easy and interactive manner, abstracting away the complexity of the CSR format.

This struct may panic when out of scope. Please see the Drop documentation in the Trait Implementations section for more information.

Methods

impl<'a, DS, US> CsrMatrixRowConstructor<'a, DS, US> where
    DS: DynDenseStoMut,
    US: DynDenseStoMut<Item = usize>, 

pub fn commit(self)

Commits the row construction, modifying the internal structure.

Examples

use mop_structs::{
    doc_tests::csr_matrix_empty_vec_array,
    matrix::csr_matrix::CsrMatrixRef
};
let mut a = csr_matrix_empty_vec_array();
a.row_constructor().commit();
assert_eq!(a.as_ref(), CsrMatrixRef::new([1, 5], &[], &[], &[0, 0]));

Assertions

• Inserted indices must be less than the number of columns of Self.

use mop_structs::doc_tests::csr_matrix_empty_vec_array;
let mut a = csr_matrix_empty_vec_array();
a.row_constructor().set_value(10, 1).commit();

• Inserted indices must be unique.

use mop_structs::doc_tests::csr_matrix_empty_vec_array;
let mut a = csr_matrix_empty_vec_array();
a.row_constructor().set_value(1, 1).set_value(1, 10).commit();

pub unsafe fn commit_unchecked(self)

A faster and unsafe version of commit.

pub fn copy_values_from_row(self, row: &CssSlice<DS::Item>) -> Self where
    DS::Item: Copy, 

Copies all values of row into the current row.

Examples

use mop_structs::{
    doc_tests::csr_matrix_empty_vec_array,
    matrix::csr_matrix::CsrMatrixRef,
    vec::css::CssSlice
};
let mut a = csr_matrix_empty_vec_array();
let b = CssSlice::new(5, &[1, 2], &[0, 1]);
a.row_constructor().copy_values_from_row(&b).commit();
assert_eq!(a.as_ref(), CsrMatrixRef::new(
    [1, 5],
    &[1, 2],
    &[0, 1],
    &[0, 2]
));

pub fn set_value(self, column_idx: usize, value: DS::Item) -> Self

Sets a new value in the current row and column index column_idx.

Examples

use mop_structs::{
    doc_tests::csr_matrix_empty_vec_array,
    matrix::csr_matrix::CsrMatrixRef
};
let mut a = csr_matrix_empty_vec_array();
a.row_constructor().set_value(1, 1).commit();
assert_eq!(a.as_ref(), CsrMatrixRef::new([1, 5], &[1], &[1], &[0, 1]));

Trait Implementations

impl<'a, DS: PartialEq, US: PartialEq> PartialEq<CsrMatrixRowConstructor<'a, DS, US>> for CsrMatrixRowConstructor<'a, DS, US>

fn eq(&self, other: &CsrMatrixRowConstructor<'a, DS, US>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CsrMatrixRowConstructor<'a, DS, US>) -> bool

This method tests for !=.

impl<'a, DS, US> Drop for CsrMatrixRowConstructor<'a, DS, US>

fn drop(&mut self)

Some measures are taken to ensure the CSR format and avoid unexpected runtime behavior.

Assertions

• Every single nonempty instance of CsrRowLayerConstructor must end with a call to the commit method.

use mop_structs::doc_tests::csr_matrix_empty_vec_array;
let mut a = csr_matrix_empty_vec_array();
a.row_constructor().set_value(1, 1);

impl<'a, DS: Debug, US: Debug> Debug for CsrMatrixRowConstructor<'a, DS, US>

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

Formats the value using the given formatter.