devela 0.27.0

A development layer of coherence.
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

// devela::data::access::iter::strided::canonical
//
//! Defines [`StridedIter`], [`StridedIterMut`].
//

crate::iter_strided! {
    #[doc = crate::_tags!(iterator)]
    /// Iterates over a slice using an affine index progression.
    #[doc = crate::_doc_location!("data/access/iter")]
    /// This is the immutable counterpart of [`StridedIterMut`].
    ///
    /// Elements are accessed according to:
    ///
    /// `index_k = front + k * stride`
    ///
    /// for increasing `k`, until the inclusive bound `back` is reached.
    ///
    /// The iterator supports forward and backward traversal.
    ///
    /// This type is dimension-agnostic and suitable for:
    /// - Traversing rows, columns, or diagonals of a 2D layout.
    /// - Projecting channels from interleaved buffers (e.g. RGBRGB…).
    /// - Downsampling by stepping every `stride` elements.
    /// - Iterating a collapsed axis of an n-dimensional layout.
    ///
    /// # Invariants
    /// - `stride > 0`.
    /// - `front <= back`, or the iterator is empty.
    /// - All generated indices lie within `storage`.
    ///
    /// If these conditions are violated, advancing or peeking may panic.
    /// No unsafe code is used.
    pub struct StridedIter: ref (usize)
}

crate::iter_strided! {
    #[doc = crate::_tags!(iterator)]
    /// Iterates mutably over a slice using an affine index progression.
    #[doc = crate::_doc_location!("data/access/iter")]
    ///
    /// This is the mutable counterpart of [`StridedIter`].
    ///
    /// Elements follow:
    ///
    /// `index_k = front + k * stride`
    ///
    /// until the inclusive bound `back` is reached.
    ///
    /// Each call yields an exclusive reference tied to the borrow
    /// of the iterator itself. Forward and backward traversal
    /// are both supported.
    ///
    /// # Invariants
    /// - `stride > 0`.
    /// - `front <= back`, or the iterator is empty.
    /// - All generated indices lie within `storage`.
    ///
    /// # Aliasing
    ///
    /// Even if indices repeat due to improper construction,
    /// simultaneous mutable aliases are prevented because each
    /// yielded reference is tied to `&mut self`.
    ///
    /// If bounds conditions are violated, advancing or peeking may panic.
    /// No unsafe code is used.
    pub struct StridedIterMut: mut (u32)
}