mdarray 0.7.2

Multidimensional array for Rust
Documentation 
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

#[cfg(not(feature = "std"))]
use alloc::boxed::Box;
#[cfg(not(feature = "std"))]
use alloc::vec;

use core::fmt::{self, Debug, Formatter};
use core::hash::Hash;

use crate::shape::Shape;
use crate::tensor::Tensor;
use crate::traits::Owned;

/// Array dimension trait.
pub trait Dim: Copy + Debug + Default + Hash + Ord + Send + Sync {
    /// Merge dimensions, where constant size is preferred over dynamic.
    type Merge<D: Dim>: Dim;

    #[doc(hidden)]
    type Owned<T, S: Shape>: Owned<T, S::Prepend<Self>>;

    /// Dimension size if known statically, or `None` if dynamic.
    const SIZE: Option<usize>;

    /// Creates an array dimension with the given size.
    ///
    /// # Panics
    ///
    /// Panics if the size is not matching a constant-sized dimension.
    fn from_size(size: usize) -> Self;

    /// Returns the number of elements in the dimension.
    fn size(self) -> usize;
}

#[allow(unreachable_pub)]
pub trait Dims<T: Copy + Debug + Default + Eq + Hash + Send + Sync>:
    AsMut<[T]>
    + AsRef<[T]>
    + Clone
    + Debug
    + Default
    + Eq
    + Hash
    + Send
    + Sync
    + for<'a> TryFrom<&'a [T], Error: Debug>
{
    fn new(len: usize) -> Self;
}

/// Type-level constant.
#[derive(Clone, Copy, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Const<const N: usize>;

/// Dynamically-sized dimension type.
pub type Dyn = usize;

impl<const N: usize> Debug for Const<N> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_tuple("Const").field(&N).finish()
    }
}

impl<const N: usize> Dim for Const<N> {
    type Merge<D: Dim> = Self;
    type Owned<T, S: Shape> = <S::Owned<T> as Owned<T, S>>::WithConst<N>;

    const SIZE: Option<usize> = Some(N);

    #[inline]
    fn from_size(size: usize) -> Self {
        assert!(size == N, "invalid size");

        Self
    }

    #[inline]
    fn size(self) -> usize {
        N
    }
}

impl Dim for Dyn {
    type Merge<D: Dim> = D;
    type Owned<T, S: Shape> = Tensor<T, S::Prepend<Self>>;

    const SIZE: Option<usize> = None;

    #[inline]
    fn from_size(size: usize) -> Self {
        size
    }

    #[inline]
    fn size(self) -> usize {
        self
    }
}

macro_rules! impl_dims {
    ($($n:tt),+) => {
        $(
            impl<T: Copy + Debug + Default + Eq + Hash + Send + Sync> Dims<T> for [T; $n] {
                #[inline]
                fn new(len: usize) -> Self {
                    assert!(len == $n, "invalid length");

                    Self::default()
                }
            }
        )+
    };
}

impl_dims!(0, 1, 2, 3, 4, 5, 6);

impl<T: Copy + Debug + Default + Eq + Hash + Send + Sync> Dims<T> for Box<[T]> {
    #[inline]
    fn new(len: usize) -> Self {
        vec![T::default(); len].into()
    }
}

impl<const N: usize> From<Const<N>> for Dyn {
    #[inline]
    fn from(_: Const<N>) -> Self {
        N
    }
}

impl<const N: usize> TryFrom<Dyn> for Const<N> {
    type Error = Dyn;

    #[inline]
    fn try_from(value: Dyn) -> Result<Self, Self::Error> {
        if value.size() == N { Ok(Self) } else { Err(value) }
    }
}