Struct Dense 

pub struct Dense<DS, const D: usize> { /* private fields */ }

Base structure for all Dense variants.

Types

• D: Number of dimensions
• DS: Data Storage

Implementations

impl<DS, const D: usize> Dense<DS, D>

pub fn dims(&self) -> &[usize; D]

The definitions of all dimensions.

Example

use ndstruct::doc_tests::dense_array_3;
assert_eq!(dense_array_3().dims(), &[4, 3, 3]);

impl<DATA, DS, const D: usize> Dense<DS, D>

where DS: AsRef<[<DS as SingleTypeStorage>::Item]> + SingleTypeStorage<Item = DATA>,

pub fn new(dims: [usize; D], data: DS) -> Result<Self>

Creates a valid Dense instance.

Arguments

• dims: Array of dimensions
• data: Data collection

Example

use ndstruct::dense::{DenseArray, DenseVec};
// Matrix ([1, 2, 3], [4, 5, 6])
let mut _matrix = DenseArray::new([2, 3], [1, 2, 3, 4, 5, 6]);
// A bunch of nothing for your overflow needs
let _over_nine: ndstruct::Result<DenseVec<(), 9001>>;
_over_nine = DenseVec::new([0; 9001], vec![]);

pub fn data(&self) -> &[DATA]

The data that is being stored.

Example

use ndstruct::doc_tests::dense_array_3;
assert_eq!(dense_array_3().data(), &[
   1,  2,  3,  4,  5,  6,  7,  8,  9,
  10, 11, 12, 13, 14, 15, 16, 17, 18,
  19, 20, 21, 22, 23, 24, 25, 26, 27,
  28, 29, 30, 31, 32, 33, 34, 35, 36,
]);

pub fn value(&self, indcs: [usize; D]) -> 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 ndstruct::doc_tests::dense_array_3;
let elem = dense_array_3();
assert_eq!(elem.value([0, 0, 0]), Some(&1));
assert_eq!(elem.value([0, 0, 2]), Some(&3));
assert_eq!(elem.value([0, 2, 2]), Some(&9));
assert_eq!(elem.value([3, 2, 2]), Some(&36));
assert_eq!(elem.value([3, 2, 3]), None);

Trait Implementations

impl<DS: Clone, const D: usize> Clone for Dense<DS, D>

fn clone(&self) -> Dense<DS, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<DS: Debug, const D: usize> Debug for Dense<DS, D>

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

Formats the value using the given formatter.

impl<DS: Default, const D: usize> Default for Dense<DS, D>

fn default() -> Dense<DS, D>

Returns the “default value” for a type.

impl<'de, DS, const D: usize> Deserialize<'de> for Dense<DS, D>

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.

impl<DS: Ord, const D: usize> Ord for Dense<DS, D>

fn cmp(&self, other: &Dense<DS, D>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<DS: PartialEq, const D: usize> PartialEq for Dense<DS, D>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<DS: PartialOrd, const D: usize> PartialOrd for Dense<DS, D>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<DS, const D: usize> Serialize for Dense<DS, D>

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<DS: Eq, const D: usize> Eq for Dense<DS, D>

impl<DS, const D: usize> StructuralPartialEq for Dense<DS, D>