mdarray 0.6.1

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

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

use crate::dim::Dims;
use crate::index;
use crate::layout::{Dense, Layout, Uniform};
use crate::mapping::Mapping;
use crate::shape::Shape;
use crate::span::Span;

/// Array span index trait, for an element or a subslice.
pub trait SpanIndex<T, S: Shape, L: Layout> {
    /// Array element or subslice type.
    type Output: ?Sized;

    #[doc(hidden)]
    unsafe fn get_unchecked(self, span: &Span<T, S, L>) -> &Self::Output;

    #[doc(hidden)]
    unsafe fn get_unchecked_mut(self, span: &mut Span<T, S, L>) -> &mut Self::Output;

    #[doc(hidden)]
    fn index(self, span: &Span<T, S, L>) -> &Self::Output;

    #[doc(hidden)]
    fn index_mut(self, span: &mut Span<T, S, L>) -> &mut Self::Output;
}

impl<T, D: Dims, S: Shape<Dims = D>, L: Layout> SpanIndex<T, S, L> for D {
    type Output = T;

    unsafe fn get_unchecked(self, span: &Span<T, S, L>) -> &T {
        &*span.as_ptr().offset(span.mapping().offset(self))
    }

    unsafe fn get_unchecked_mut(self, span: &mut Span<T, S, L>) -> &mut T {
        &mut *span.as_mut_ptr().offset(span.mapping().offset(self))
    }

    fn index(self, span: &Span<T, S, L>) -> &T {
        let dims = span.dims();

        for i in 0..S::RANK {
            if self[i] >= dims[i] {
                index::panic_bounds_check(self[i], dims[i])
            }
        }

        unsafe { self.get_unchecked(span) }
    }

    fn index_mut(self, span: &mut Span<T, S, L>) -> &mut T {
        let dims = span.dims();

        for i in 0..S::RANK {
            if self[i] >= dims[i] {
                index::panic_bounds_check(self[i], dims[i])
            }
        }

        unsafe { self.get_unchecked_mut(span) }
    }
}

impl<T, S: Shape, L: Uniform> SpanIndex<T, S, L> for usize {
    type Output = T;

    unsafe fn get_unchecked(self, span: &Span<T, S, L>) -> &T {
        debug_assert!(self < span.len(), "index out of bounds");

        let offset = if S::RANK > 0 { span.stride(0) * self as isize } else { 0 };

        &*span.as_ptr().offset(offset)
    }

    unsafe fn get_unchecked_mut(self, span: &mut Span<T, S, L>) -> &mut T {
        debug_assert!(self < span.len(), "index out of bounds");

        let offset = if S::RANK > 0 { span.stride(0) * self as isize } else { 0 };

        &mut *span.as_mut_ptr().offset(offset)
    }

    fn index(self, span: &Span<T, S, L>) -> &T {
        if self >= span.len() {
            index::panic_bounds_check(self, span.len())
        }

        unsafe { self.get_unchecked(span) }
    }

    fn index_mut(self, span: &mut Span<T, S, L>) -> &mut T {
        if self >= span.len() {
            index::panic_bounds_check(self, span.len())
        }

        unsafe { self.get_unchecked_mut(span) }
    }
}

macro_rules! impl_span_index {
    ($type:ty) => {
        impl<T, S: Shape> SpanIndex<T, S, Dense> for $type {
            type Output = [T];

            unsafe fn get_unchecked(self, span: &Span<T, S>) -> &[T] {
                span.as_slice().get_unchecked(self)
            }

            unsafe fn get_unchecked_mut(self, span: &mut Span<T, S>) -> &mut [T] {
                span.as_mut_slice().get_unchecked_mut(self)
            }

            fn index(self, span: &Span<T, S>) -> &[T] {
                span.as_slice().index(self)
            }

            fn index_mut(self, span: &mut Span<T, S>) -> &mut [T] {
                span.as_mut_slice().index_mut(self)
            }
        }
    };
}

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