leto 0.43.0

N-dimensional strided arrays, zero-copy views, and storage backends
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

use super::types::Array;
use crate::application::view::ArrayView;
use crate::domain::error::Result;
use crate::infrastructure::storage::Storage;

/// Read-only source for assigning values into an array.
pub trait AssignSource<T, const N: usize> {
    /// Shape of the assignment source.
    fn assign_shape(&self) -> [usize; N];

    /// Value at a logical index.
    ///
    /// # Errors
    /// Returns [`LetoError`](crate::domain::error::LetoError) when the index is
    /// out of bounds for the source.
    fn assign_get(&self, index: [usize; N]) -> Result<&T>;

    /// Borrow the source as a validated strided view when its representation
    /// supports zero-copy traversal.
    ///
    /// The view must have the shape returned by [`Self::assign_shape`] and each
    /// logical element must equal the corresponding [`Self::assign_get`] value.
    /// Implementors outside Leto may retain the default checked-index route.
    #[doc(hidden)]
    #[inline]
    fn assign_view(&self) -> Option<ArrayView<'_, T, N>> {
        None
    }
}

impl<T, S, const N: usize> AssignSource<T, N> for Array<T, S, N>
where
    S: Storage<T>,
{
    #[inline]
    fn assign_shape(&self) -> [usize; N] {
        self.shape()
    }

    #[inline]
    fn assign_get(&self, index: [usize; N]) -> Result<&T> {
        self.get(index)
    }

    #[inline]
    fn assign_view(&self) -> Option<ArrayView<'_, T, N>> {
        Some(self.view())
    }
}

impl<T, const N: usize> AssignSource<T, N> for ArrayView<'_, T, N> {
    #[inline]
    fn assign_shape(&self) -> [usize; N] {
        self.shape()
    }

    #[inline]
    fn assign_get(&self, index: [usize; N]) -> Result<&T> {
        self.get(index)
    }

    #[inline]
    fn assign_view(&self) -> Option<ArrayView<'_, T, N>> {
        Some(self.reborrow())
    }
}