Struct mop_structs::matrix::dr_matrix::DrMatrix

pub struct DrMatrix<DS> { /* fields omitted */ }

Methods

impl<DS> DrMatrix<DS> where
    DS: StDenseStoRef, 

pub fn new(shape: [usize; 2], data: DS) -> Self

Creates a new DrMatrix from raw parameters.

Arguments

• shape - An array containing the number of rows and columns.
• data - The matrix data.

Examples

use mop_structs::matrix::dr_matrix::DrMatrixArray;
let _ = DrMatrixArray::new([2, 4], [1, 2, 3, 4, 5, 6, 7, 8]);

Assertions

• The length of data must be equal the number of rows times the number of columns.

use mop_structs::matrix::dr_matrix::DrMatrixRef;
let _ = DrMatrixRef::new([2, 4], &[1, 2, 3]);

pub fn new_unchecked(shape: [usize; 2], data: DS) -> Self

A faster and unsafe version of new.

pub fn as_ref(&self) -> DrMatrixRef<DS::Item>

Converts the inner storage to a generic immutable slice storage.

Examples

use mop_structs::{
    doc_tests::dr_matrix_array,
    matrix::dr_matrix::DrMatrixRef
};
assert_eq!(
    dr_matrix_array().as_ref(),
    DrMatrixRef::new(
        [4, 5],
        &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20],
    )
);

pub fn data(&self) -> &[DS::Item]

pub fn row(&self, idx: usize) -> &[DS::Item]

Important traits for DrMatrixRowIter<'a, T>

impl<'a, T> Iterator for DrMatrixRowIter<'a, T> type Item = &'a [T];

pub fn row_iter(&self) -> DrMatrixRowIter<DS::Item>

pub fn row_par_iter(&self) -> ParallelIteratorWrapper<DrMatrixRowIter<DS::Item>>

pub fn value(&self, row_idx: usize, col_idx: usize) -> &DS::Item

impl<DS> DrMatrix<DS> where
    DS: StDenseStoMut, 

pub fn data_mut(&mut self) -> &mut [DS::Item]

pub fn row_mut(&mut self, idx: usize) -> &mut [DS::Item]

Important traits for DrMatrixRowIterMut<'a, T>

impl<'a, T> Iterator for DrMatrixRowIterMut<'a, T> type Item = &'a mut [T];

pub fn row_iter_mut(&mut self) -> DrMatrixRowIterMut<DS::Item>

pub fn row_par_iter_mut(
    &mut self
) -> ParallelIteratorWrapper<DrMatrixRowIterMut<DS::Item>>

pub fn swap(&mut self, a: [usize; 2], b: [usize; 2])

pub fn two_rows_mut(
    &mut self,
    smaller_idx: usize,
    bigger_idx: usize
) -> [&mut [DS::Item]; 2]

pub fn value_mut(&mut self, row_idx: usize, col_idx: usize) -> &mut DS::Item

impl<DS> DrMatrix<DS> where
    DS: DynDenseStoRef, 

pub fn rows_capacity(&self) -> usize

impl<DS> DrMatrix<DS> where
    DS: DynDenseStoMut, 

pub fn clear(&mut self)

pub fn extend<AD>(&mut self, other: &DrMatrix<AD>) where
    AD: DynDenseStoMut<Item = DS::Item>,
    DS::Item: Copy, 

pub fn extend_from_clone<AD>(&mut self, other: &DrMatrix<AD>) where
    AD: DynDenseStoMut<Item = DS::Item>,
    DS::Item: Clone, 

pub fn row_constructor(&mut self) -> DrMatrixRowConstructor<DS>

pub fn truncate(&mut self, until_row_idx: usize)

Trait Implementations

impl<DS> Matrix for DrMatrix<DS>

fn cols(&self) -> usize

fn rows(&self) -> usize

impl<DS: PartialOrd> PartialOrd<DrMatrix<DS>> for DrMatrix<DS>

fn partial_cmp(&self, other: &DrMatrix<DS>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &DrMatrix<DS>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &DrMatrix<DS>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &DrMatrix<DS>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &DrMatrix<DS>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<DS: Copy> Copy for DrMatrix<DS>

impl<DS: Clone> Clone for DrMatrix<DS>

fn clone(&self) -> DrMatrix<DS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DS: PartialEq> PartialEq<DrMatrix<DS>> for DrMatrix<DS>

fn eq(&self, other: &DrMatrix<DS>) -> bool

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

fn ne(&self, other: &DrMatrix<DS>) -> bool

This method tests for !=.

impl<DS: Default> Default for DrMatrix<DS>

fn default() -> DrMatrix<DS>

Returns the "default value" for a type.

impl<DS: Hash> Hash for DrMatrix<DS>

fn hash<__HDS: Hasher>(&self, state: &mut __HDS)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<DS: Debug> Debug for DrMatrix<DS>

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

Formats the value using the given formatter.

impl<DS> Serialize for DrMatrix<DS> where
    DS: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, DS> Deserialize<'de> for DrMatrix<DS> where
    DS: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.