mdarray 0.5.0

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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

#[cfg(feature = "nightly")]
use std::slice;

use std::ops::{
    Bound, Range, RangeBounds, RangeFrom, RangeFull, RangeInclusive, RangeTo, RangeToInclusive,
};

use crate::dim::{Const, Dim};
use crate::index;
use crate::layout::{Dense, Flat, Layout};
use crate::mapping::{DenseMapping, Mapping};
use crate::ops::StepRange;

/// Helper trait for array indexing, for a single index.
pub trait DimIndex {
    /// Array view dimension.
    type Dim<D: Dim>: Dim;

    /// Array view parameters.
    type Params<P: Params>: Params;

    #[doc(hidden)]
    fn dim_index<D: Dim, L: Layout, I, O>(
        self,
        index: I,
        mapping: L::Mapping<D>,
    ) -> (isize, <O::Layout as Layout>::Mapping<O::Dim>)
    where
        I: ViewIndex<D::Lower, <D::Lower as Dim>::Layout<L>>,
        O: ViewIndex<D, L, Dim = Self::Dim<I::Dim>>;
}

/// Helper trait for array indexing, for view parameters.
pub trait Params {
    /// Base layout for the array view.
    type Layout: Layout;

    /// Base layout for the parent array view.
    type Parent: Layout;

    /// Base layout for the parent array view, when splitting along the dimension.
    type Split: Layout;
}

/// Array view index trait, for a linear index or a tuple of indices.
pub trait ViewIndex<D: Dim, L: Layout> {
    /// Array view dimension.
    type Dim: Dim;

    /// Array view parameters.
    type Params: Params;

    /// Array view layout.
    #[cfg(not(feature = "nightly"))]
    type Layout: Layout;

    /// Array view layout.
    #[cfg(feature = "nightly")]
    type Layout: Layout = <<Self::Params as Params>::Layout as Layout>::Layout<Self::Dim, L>;

    #[doc(hidden)]
    fn view_index(
        self,
        mapping: L::Mapping<D>,
    ) -> (isize, <Self::Layout as Layout>::Mapping<Self::Dim>);
}

impl DimIndex for usize {
    type Dim<D: Dim> = D;
    type Params<P: Params> = (P::Layout, P::Split, P::Split);

    fn dim_index<D: Dim, L: Layout, I, O>(
        self,
        index: I,
        mapping: L::Mapping<D>,
    ) -> (isize, <O::Layout as Layout>::Mapping<O::Dim>)
    where
        I: ViewIndex<D::Lower, <D::Lower as Dim>::Layout<L>>,
        O: ViewIndex<D, L, Dim = Self::Dim<I::Dim>>,
    {
        let (offset, inner) = index.view_index(Mapping::remove_dim(mapping, D::RANK - 1));

        let size = mapping.size(D::RANK - 1);
        let stride = mapping.stride(D::RANK - 1);

        if self >= size {
            index::panic_bounds_check(self, size)
        }

        (offset + stride * self as isize, Mapping::remap(inner))
    }
}

impl DimIndex for RangeFull {
    type Dim<D: Dim> = D::Higher;
    type Params<P: Params> = (P::Parent, P::Parent, <P::Parent as Layout>::NonUniform);

    fn dim_index<D: Dim, L: Layout, I, O>(
        self,
        index: I,
        mapping: L::Mapping<D>,
    ) -> (isize, <O::Layout as Layout>::Mapping<O::Dim>)
    where
        I: ViewIndex<D::Lower, <D::Lower as Dim>::Layout<L>>,
        O: ViewIndex<D, L, Dim = Self::Dim<I::Dim>>,
    {
        let (offset, inner) = index.view_index(Mapping::remove_dim(mapping, D::RANK - 1));

        let size = mapping.size(D::RANK - 1);
        let stride = mapping.stride(D::RANK - 1);

        (offset, Mapping::add_dim(inner, size, stride))
    }
}

macro_rules! impl_dim_index {
    ($type:ty) => {
        impl DimIndex for $type {
            type Dim<D: Dim> = D::Higher;
            type Params<P: Params> =
                (P::Parent, <P::Parent as Layout>::NonUniform, <P::Parent as Layout>::NonUniform);

            fn dim_index<D: Dim, L: Layout, I, O>(
                self,
                index: I,
                mapping: L::Mapping<D>,
            ) -> (isize, <O::Layout as Layout>::Mapping<O::Dim>)
            where
                I: ViewIndex<D::Lower, <D::Lower as Dim>::Layout<L>>,
                O: ViewIndex<D, L, Dim = Self::Dim<I::Dim>>,
            {
                let (offset, inner) = index.view_index(Mapping::remove_dim(mapping, D::RANK - 1));

                let size = mapping.size(D::RANK - 1);
                let stride = mapping.stride(D::RANK - 1);

                #[cfg(not(feature = "nightly"))]
                let range = crate::index::range(self, ..size);
                #[cfg(feature = "nightly")]
                let range = slice::range(self, ..size);
                let count = stride * range.start as isize;

                (offset + count, Mapping::add_dim(inner, range.len(), stride))
            }
        }
    };
}

impl_dim_index!((Bound<usize>, Bound<usize>));
impl_dim_index!(Range<usize>);
impl_dim_index!(RangeFrom<usize>);
impl_dim_index!(RangeInclusive<usize>);
impl_dim_index!(RangeTo<usize>);
impl_dim_index!(RangeToInclusive<usize>);

impl<R: RangeBounds<usize>> DimIndex for StepRange<R, isize> {
    type Dim<D: Dim> = D::Higher;
    type Params<P: Params> =
        (P::Split, <P::Split as Layout>::NonUniform, <P::Split as Layout>::NonUniform);

    fn dim_index<D: Dim, L: Layout, I, O>(
        self,
        index: I,
        mapping: L::Mapping<D>,
    ) -> (isize, <O::Layout as Layout>::Mapping<O::Dim>)
    where
        I: ViewIndex<D::Lower, <D::Lower as Dim>::Layout<L>>,
        O: ViewIndex<D, L, Dim = Self::Dim<I::Dim>>,
    {
        let (offset, inner) = index.view_index(Mapping::remove_dim(mapping, D::RANK - 1));

        let size = mapping.size(D::RANK - 1);
        let stride = mapping.stride(D::RANK - 1);

        #[cfg(not(feature = "nightly"))]
        let range = crate::index::range(self.range, ..size);
        #[cfg(feature = "nightly")]
        let range = slice::range(self.range, ..size);
        #[cfg(not(feature = "nightly"))]
        let len = crate::index::div_ceil(range.len(), self.step.abs_diff(0));
        #[cfg(feature = "nightly")]
        let len = range.len().div_ceil(self.step.abs_diff(0));

        let delta = if self.step < 0 && !range.is_empty() { range.end - 1 } else { range.start };

        (offset + stride * delta as isize, Mapping::add_dim(inner, len, stride * self.step))
    }
}

impl<L: Layout, P: Layout, S: Layout> Params for (L, P, S) {
    type Layout = L;
    type Parent = P;
    type Split = S;
}

impl ViewIndex<Const<0>, Dense> for () {
    type Dim = Const<0>;
    type Params = (Dense, Dense, Flat);

    #[cfg(not(feature = "nightly"))]
    type Layout = <<Self::Params as Params>::Layout as Layout>::Layout<Self::Dim, Dense>;

    fn view_index(self, _: DenseMapping<Const<0>>) -> (isize, DenseMapping<Const<0>>) {
        (0, DenseMapping::default())
    }
}

macro_rules! impl_view_index {
    ($n:tt, $m:tt, ($($ij:tt),*), $k:tt, ($($xy:tt),*), $z:tt, ($($xyz:tt),+), $layout:ty) => {
        impl<L: Layout, $($xyz: DimIndex),+> ViewIndex<Const<$n>, L> for ($($xyz,)+) {
            type Dim = $z::Dim<<($($xy,)*) as ViewIndex<Const<$m>, $layout>>::Dim>;
            type Params = $z::Params<<($($xy,)*) as ViewIndex<Const<$m>, $layout>>::Params>;

            #[cfg(not(feature = "nightly"))]
            type Layout = <<Self::Params as Params>::Layout as Layout>::Layout<Self::Dim, L>;

            fn view_index(
                self,
                mapping: L::Mapping<Const<$n>>,
            ) -> (isize, <Self::Layout as Layout>::Mapping<Self::Dim>) {
                self.$k.dim_index::<Const<$n>, L, ($($xy,)*), Self>(($(self.$ij,)*), mapping)
            }
        }
    };
}

impl_view_index!(1, 0, (), 0, (), X, (X), Dense);
impl_view_index!(2, 1, (0), 1, (X), Y, (X, Y), L::Uniform);
impl_view_index!(3, 2, (0, 1), 2, (X, Y), Z, (X, Y, Z), L);
impl_view_index!(4, 3, (0, 1, 2), 3, (X, Y, Z), W, (X, Y, Z, W), L);
impl_view_index!(5, 4, (0, 1, 2, 3), 4, (X, Y, Z, W), U, (X, Y, Z, W, U), L);
impl_view_index!(6, 5, (0, 1, 2, 3, 4), 5, (X, Y, Z, W, U), V, (X, Y, Z, W, U, V), L);