Struct ndsparse::csl::CslLineConstructor

pub struct CslLineConstructor<'a, DS, IS, OS, const D: usize> { /* fields omitted */ }

Constructs valid lines in a easy and interactive manner, abstracting away the complexity of the compressed sparse format.

Implementations

impl<'a, DATA, DS, IS, OS, const D: usize> CslLineConstructor<'a, DS, IS, OS, D> where
    DS: AsRef<[DATA]> + Push<Input = DATA> + Storage<Item = DATA>,
    IS: AsRef<[usize]> + Push<Input = usize>,
    OS: AsRef<[usize]> + Push<Input = usize>, 

pub fn next_outermost_dim(self, len: usize) -> Result<Self>

Jumps to the next outermost dimension, i.e., from right to left.

Example

use ndsparse::csl::{CslRef, CslVec};
let mut csl = CslVec::<i32, 3>::default();
csl
  .constructor()?
  .next_outermost_dim(3)?
  .push_line([(0, 1)].iter().copied())?
  .next_outermost_dim(4)?
  .push_line([(1, 2)].iter().copied())?
  .push_empty_line()?
  .push_line([(0, 3), (1,4)].iter().copied())?;
assert_eq!(
  csl.sub_dim(0..4),
  CslRef::new([4, 3], &[1, 2, 3, 4][..], &[0, 1, 0, 1][..], &[0, 1, 2, 2, 4][..]).ok()
);

pub fn push_empty_line(self) -> Result<Self>

This is the same as push_line([].iter(), [].iter()).

Example

use ndsparse::csl::{CslRef, CslVec};
let mut csl = CslVec::<i32, 3>::default();
let constructor = csl.constructor()?.next_outermost_dim(3)?;
constructor.push_empty_line()?.next_outermost_dim(2)?.push_empty_line()?;
assert_eq!(csl.line([0, 0, 0]), CslRef::new([3], &[][..], &[][..], &[0, 0][..]).ok());

pub fn push_line<DI>(self, di: DI) -> Result<Self> where
    DI: Iterator<Item = (usize, DATA)>, 

Pushes a new compressed line, modifying the internal structure and if applicable, increases the current dimension length.

The iterator will be truncated to (usize::Max - last offset value + 1) or (last dimension value) and it can lead to a situation where no values will be inserted.

Arguments

• data: Iterator of cloned items.
• indcs: Iterator of the respective indices of each item.

Example

use ndsparse::csl::{CslRef, CslVec};
let mut csl = CslVec::<i32, 3>::default();
csl.constructor()?.next_outermost_dim(50)?.push_line([(1, 1), (40, 2)].iter().copied())?;
let line = csl.line([0, 0, 0]);
assert_eq!(line, CslRef::new([50], &[1, 2][..], &[1, 40][..], &[0, 2][..]).ok());

Trait Implementations

impl<'a, DS: Debug, IS: Debug, OS: Debug, const D: usize> Debug for CslLineConstructor<'a, DS, IS, OS, D>

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

Formats the value using the given formatter.

impl<'a, DS: PartialEq, IS: PartialEq, OS: PartialEq, const D: usize> PartialEq<CslLineConstructor<'a, DS, IS, OS, D>> for CslLineConstructor<'a, DS, IS, OS, D>

fn eq(&self, other: &CslLineConstructor<'a, DS, IS, OS, D>) -> bool

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

fn ne(&self, other: &CslLineConstructor<'a, DS, IS, OS, D>) -> bool

This method tests for !=.

impl<'a, DS, IS, OS, const D: usize> StructuralPartialEq for CslLineConstructor<'a, DS, IS, OS, D>