devela 0.28.0

A development substrate 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

// devela::geom::metric::stride
//
//! Defines [`Stride`].
//

#[doc = crate::_tags!(geom)]
/// A step size for traversing dimensions or repetitions.
#[doc = crate::_doc_meta!{location("geom/metric")}]
///
/// `Stride` defines the spacing between adjacent elements in a structured layout.
/// It does not define structure itself, but rather **how elements are accessed within it**.
///
/// - In **1D**, `Stride<T, 1>` represents uniform step spacing (e.g. sampling rate).
/// - In **nD**, `Stride<T, N>` defines the step sizes across `N` dimensions.
///
/// Common applications:
/// - **Numerical computing** (matrix row/column strides)
/// - **Memory layouts** (pixel buffers, structured arrays)
/// - **Geometric traversal** (lattices, grids, fractal stepping)
#[must_use]
#[repr(transparent)]
pub struct Stride<T, const D: usize> {
    /// The step sizes per dimension.
    pub dim: [T; D],
}

#[doc = crate::_tags!(geom)]
/// A 1-dimensional [`Stride`].
#[doc = crate::_doc_meta!{location("geom/metric")}]
pub type Stride1<T> = Stride<T, 1>;

#[doc = crate::_tags!(geom)]
/// A 2-dimensional [`Stride`].
#[doc = crate::_doc_meta!{location("geom/metric")}]
pub type Stride2<T> = Stride<T, 2>;

#[doc = crate::_tags!(geom)]
/// A 3-dimensional [`Stride`].
#[doc = crate::_doc_meta!{location("geom/metric")}]
pub type Stride3<T> = Stride<T, 3>;

crate::_geom_dim_impl_common![common_methods: Stride];
crate::_geom_dim_impl_common![common_traits: Stride];