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
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
233

// devela::geom::metric::extent
//
//! A geometrical extent.
//
// IMPROVE: use TBD NumConst::ONE and unify methods for int and floats.

use crate::{_impl_geom_dim, is, whilst};

#[doc = crate::_tags!(geom)]
/// An orthogonal extension in `D`-space without a coordinate position.
#[doc = crate::_doc_location!("geom/metric")]
///
/// Represents the lengths of each dimension in a multi-dimensional space,
/// providing an origin-agnostic shape with the implied form of an orthotope
/// (generalized rectangle or box).
///
/// See also [`Extent1`], [`Extent2`], [`Extent3`].
#[must_use]
#[repr(transparent)]
#[doc(alias = "Size")]
pub struct Extent<T, const D: usize> {
    /// The size values in `D`-dimensional space.
    pub dim: [T; D],
}

#[doc = crate::_tags!(geom)]
/// A 1-dimensional [`Extent`].
#[doc = crate::_doc_location!("geom/metric")]
#[doc(alias = "Size")]
pub type Extent1<T> = Extent<T, 1>;

#[doc = crate::_tags!(geom)]
/// A 2-dimensional [`Extent`].
#[doc = crate::_doc_location!("geom/metric")]
#[doc(alias = "Size")]
pub type Extent2<T> = Extent<T, 2>;

#[doc = crate::_tags!(geom)]
/// A 3-dimensional [`Extent`].
#[doc = crate::_doc_location!("geom/metric")]
#[doc(alias = "Size")]
pub type Extent3<T> = Extent<T, 3>;

_impl_geom_dim![common_methods: Extent];
_impl_geom_dim![common_traits: Extent];

/// Implement `Extent` methods for all primitives.
macro_rules! impl_extent {
    () => {
        impl_extent![sint i8, i16, i32, i64, i128, isize];
        impl_extent![uint u8, u16, u32, u64, u128, usize];
        impl_extent![float f32, f64];
    };
    // integers common methods
    //
    // $t: the inner integer primitive type
    (int $($t:ty),+) => { $( impl_extent![@int $t]; )+ };
    (@int $t:ty) => {
        impl<const D: usize> Extent<$t, D> {
            #[must_use]
            /// Returns the internal measure, the product of the extents.
            ///
            /// It's equivalent to length, area, and volume in 1, 2 and 3 dimensions.
            pub const fn measure(self) -> $t {
                let mut measure = 1;
                whilst!(i in 0..D; measure *= self.dim[i]);
                measure
            }
            #[must_use]
            /// Returns the external boundary, the sum of the extents.
            ///
            /// It's equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.
            pub const fn boundary(self) -> $t {
                let mut boundary = 0;
                whilst!(i in 0..D; {
                    let mut face_measure = 1;
                    whilst!(j in 0..D; is![i != j, face_measure *= self.dim[j]]);
                    boundary += face_measure;
                });
                2 * boundary // Each dimension's contribution is counted twice
            }
        }

        // impl Extent<$t, 1> {}
        impl Extent2<$t> {
            #[must_use]
            /// The area of the 2d extent.
            pub const fn area(self) -> $t { self.dim[0] * self.dim[1] }
            #[must_use]
            /// The perimeter of the 2d extent.
            pub const fn perimeter(self) -> $t { 2 * (self.dim[0] + self.dim[1]) }
        }
        impl Extent3<$t> {
            #[must_use]
            /// The volume of the 3d extent.
            pub const fn volume(self) -> $t {
                self.dim[0] * self.dim[1] * self.dim[2]
            }
            #[must_use]
            /// The surface area of the 3d extent.
            pub const fn surface_area(self) -> $t {
                2 * (self.dim[0] * self.dim[1]
                    + self.dim[1] * self.dim[2]
                    + self.dim[2] * self.dim[0])
            }
        }
    };

    (sint $($t:ty),+) => { $( impl_extent![@sint $t]; )+ };
    (@sint $t:ty ) => {
        impl_extent![int $t];
    };
    (uint $($t:ty),+) => { $( impl_extent![@uint $t]; )+ };
    (@uint $t:ty ) => {
        impl_extent![int $t];
    };

    // $f: the inner floating-point primitive type
    (float $($f:ty),+) => { $( impl_extent![@float $f]; )+ };
    (@float $f:ty) => {
        impl<const D: usize> Extent<$f, D> {
            #[must_use]
            /// Returns the internal measure, the product of the extents.
            ///
            /// It's equivalent to length, area, and volume in 1, 2 and 3 dimensions.
            pub const fn measure(self) -> $f {
                let mut measure = 1.0;
                whilst!(i in 0..D; measure *= self.dim[i]);
                measure
            }
            #[must_use]
            /// Returns the external boundary, the sum of the extents.
            ///
            /// It's equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.
            pub const fn boundary(self) -> $f {
                let mut boundary = 0.0;
                whilst!(i in 0..D; {
                    let mut face_measure = 1.0;
                    whilst!(j in 0..D; is![i != j, face_measure *= self.dim[j]]);
                    boundary += face_measure;
                });
                2.0 * boundary // Each dimension's contribution is counted twice
            }
        }

        impl Extent2<$f> {
            #[must_use]
            /// Returns the area of the 2d extent.
            pub const fn area(self) -> $f { self.dim[0] * self.dim[1] }
            #[must_use]
            /// Returns the perimeter of the 2d extent.
            pub const fn perimeter(self) -> $f { 2.0 * (self.dim[0] + self.dim[1]) }
        }
        impl Extent3<$f> {
            #[must_use]
            /// Returns the volume of the 3d extent.
            pub const fn volume(self) -> $f {
                self.dim[0] * self.dim[1] * self.dim[2]
            }
            #[must_use]
            /// The surface area of the 3d extent.
            pub const fn surface_area(self) -> $f {
                2.0 * (self.dim[0] * self.dim[1]
                    + self.dim[1] * self.dim[2]
                    + self.dim[2] * self.dim[0])
            }
        }
    };
}
impl_extent![];

#[rustfmt::skip]
/// 1D accessors
impl<T: Copy> Extent1<T> {
    #[must_use]
    /// Returns a copy of the first dimension.
    pub const fn length(self) -> T { self.dim[0] }
    /// Returns a copy of the first dimension.
    pub const fn l(self) -> T { self.dim[0] }
}

#[rustfmt::skip]
/// 2D Accessors
impl<T: Copy> Extent2<T> {
    #[must_use]
    /// Returns a copy of the horizontal dimension (X-axis).
    pub const fn width(self) -> T { self.dim[0] }
    #[must_use]
    /// Returns a copy of the horizontal dimension (X-axis).
    pub const fn w(self) -> T { self.dim[0] }
    #[must_use]
    /// Returns a copy of the vertical dimension (Y-axis).
    pub const fn height(self) -> T { self.dim[1] }
    #[must_use]
    /// Returns a copy of the vertical dimension (Y-axis).
    pub const fn h(self) -> T { self.dim[1] }

    #[must_use]
    /// Returns a copy of the horizontal dimension (X-axis) (width).
    pub const fn length(self) -> T { self.dim[0] }
    #[must_use]
    /// Returns a copy of the horizontal dimension (X-axis) (width).
    pub const fn l(self) -> T { self.dim[0] }
    #[must_use]
    /// Returns a copy of the vertical dimension (Y-axis) (width).
    pub const fn breadth(self) -> T { self.dim[1] }
    #[must_use]
    /// Returns a copy of the vertical dimension (Y-axis) (width).
    pub const fn b(self) -> T { self.dim[1] }
}

#[rustfmt::skip]
/// 3D Accessors
impl<T: Copy> Extent3<T> {
    #[must_use]
    /// Returns a copy of the horizontal dimension (X-axis) (width).
    pub const fn width(self) -> T { self.dim[0] }
    #[must_use]
    /// Returns a copy of the horizontal dimension (X-axis) (width).
    pub const fn w(self) -> T { self.dim[0] }
    #[must_use]
    /// Returns a copy of the vertical dimension (Y-axis).
    pub const fn height(self) -> T { self.dim[1] }
    #[must_use]
    /// Returns a copy of the vertical dimension (Y-axis).
    pub const fn h(self) -> T { self.dim[1] }
    #[must_use]
    /// Returns a copy of the depth dimension (Z-axis).
    pub const fn depth(self) -> T { self.dim[2] }
    #[must_use]
    /// Returns a copy of the depth dimension (Z-axis).
    pub const fn d(self) -> T { self.dim[2] }
}