Struct ndsparse::coo::Coo

pub struct Coo<DA, DS> where
    DA: Dims,  { /* fields omitted */ }

Base structure for all COO* variants.

Types

• DS: Data Storage
• const DIMS: usize: Dimensions length

Methods

impl<DA, DS> Coo<DA, DS> where
    DA: Dims, 

pub fn dims(&self) -> &DA

The definitions of all dimensions.

Example

use ndsparse::doc_tests::coo_array_5;
assert_eq!(coo_array_5().dims(), &[2, 3, 4, 3, 3]);

impl<DA, DATA, DS> Coo<DA, DS> where
    DA: Dims,
    DS: AsRef<[<DS as Storage>::Item]> + Storage<Item = (ArrayWrapper<DA>, DATA)>, 

pub fn new<ID, IDS>(into_dims: ID, into_data: IDS) -> Self where
    ID: Into<ArrayWrapper<DA>>,
    IDS: Into<DS>, 

Creates a valid COO instance.

Arguments

• into_dims: Array of dimensions
• into_data: Data collection

Example

use ndsparse::coo::{CooArray, CooVec};
// Sparse array ([8, _, _, _, _, 9, _, _, _, _])
let mut _sparse_array = CooArray::new([10], [([0].into(), 8.0), ([5].into(), 9.0)]);
// A bunch of nothing for your overflow needs
let mut _over_nine: CooVec<[usize; 9001], ()>;
_over_nine = CooVec::new([0; 9001], vec![]);

Assertions

• Data indices must be in asceding order

use ndsparse::coo::CooArray;
let _ = CooArray::new([2, 2], [([1, 1].into(), 8), ([0, 0].into(), 9)]);

• All indices must be lesser than the defined dimensions

use ndsparse::coo::CooArray;
let _ = CooArray::new([2, 2], [([0, 1].into(), 8), ([9, 9].into(), 9)]);

• Must not have duplicated indices

use ndsparse::coo::CooArray;
let _ = CooArray::new([2, 2], [([0, 0].into(), 8), ([0, 0].into(), 9)]);

pub fn data(&self) -> &[(ArrayWrapper<DA>, DATA)]

The data that is being stored.

Example

use ndsparse::doc_tests::coo_array_5;
assert_eq!(coo_array_5().data().get(0), Some(&([0, 0, 1, 1, 2].into(), 1)));

pub fn value(&self, indcs: DA) -> Option<&DATA>

If any, retrieves an immutable data reference of a given set of indices.

Arguments

• indcs: Indices of the desired data location

Example

use ndsparse::doc_tests::coo_array_5;
let coo = coo_array_5();
assert_eq!(coo.value([0, 0, 0, 0, 0]), None);
assert_eq!(coo.value([0, 2, 2, 0, 1]), Some(&4));

impl<DA, DATA, DS> Coo<DA, DS> where
    DA: Dims,
    DS: AsMut<[<DS as Storage>::Item]> + Storage<Item = (ArrayWrapper<DA>, DATA)>, 

pub unsafe fn data_mut(&mut self) -> &[(ArrayWrapper<DA>, DATA)]

Mutable version of data.

Safety

Indices can be modified to overflow its dimensions.

pub fn value_mut(&mut self, indcs: DA) -> Option<&mut DATA>

Mutable version of value.

impl<DA, DATA, DS> Coo<DA, DS> where
    DA: Dims,
    DS: AsMut<[<DS as Storage>::Item]> + AsRef<[<DS as Storage>::Item]> + Default + Storage<Item = (ArrayWrapper<DA>, DATA)> + Push<Input = <DS as Storage>::Item>, 

pub fn new_random_with_rand<F, ID, R>(
    into_dims: ID,
    nnz: usize,
    rng: &mut R,
    cb: F
) -> Self where
    F: FnMut(&mut R, &DA) -> DATA,
    ID: Into<ArrayWrapper<DA>>,
    R: Rng, 

Creates a new random and valid instance delimited by the passed arguments.

Arguments

• into_dims: Array of dimensions
• nnz: Number of Non-Zero elements
• rng: rand::Rng trait
• cb: Callback to control data creation

Example

use ndsparse::coo::CooVec;
use rand::{thread_rng, Rng};
let mut _random: CooVec<[usize; 8], u8>;
let mut rng = thread_rng();
_random = CooVec::new_random_with_rand([1, 2, 3, 4, 5, 6, 7, 8], 9, &mut rng, |r, _| r.gen());

Trait Implementations

impl<DA: Clone, DS: Clone> Clone for Coo<DA, DS> where
    DA: Dims, 

fn clone(&self) -> Coo<DA, DS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DA: Debug, DS: Debug> Debug for Coo<DA, DS> where
    DA: Dims, 

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

Formats the value using the given formatter.

impl<DA: Default, DS: Default> Default for Coo<DA, DS> where
    DA: Dims, 

fn default() -> Coo<DA, DS>

Returns the "default value" for a type.

impl<'de, DA, DS> Deserialize<'de> for Coo<DA, DS> where
    DA: Dims,
    DA: Deserialize<'de>,
    DS: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<DA: PartialEq, DS: PartialEq> PartialEq<Coo<DA, DS>> for Coo<DA, DS> where
    DA: Dims, 

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

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

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

This method tests for !=.

impl<DA, DS> Serialize for Coo<DA, DS> where
    DA: Dims,
    DA: Serialize,
    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<DA, DS> StructuralPartialEq for Coo<DA, DS> where
    DA: Dims,