use-uniform-polytope 0.0.6

Uniform polytope classification primitives for the RustUse geometry workspace
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

/// Broad uniform polytope families.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UniformPolytopeKind {
    /// Regular polytopes.
    Regular,
    /// Quasiregular polytopes.
    Quasiregular,
    /// Archimedean solids and higher-dimensional analogues.
    Archimedean,
    /// Prismatic uniform families.
    Prismatic,
    /// Other named or not-yet-classified uniform families.
    Other,
}

/// A lightweight uniform polytope descriptor.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct UniformPolytope {
    dimension: usize,
    kind: UniformPolytopeKind,
}

impl UniformPolytope {
    /// Creates a uniform polytope descriptor with positive dimension.
    #[must_use]
    pub const fn new(dimension: usize, kind: UniformPolytopeKind) -> Option<Self> {
        if dimension > 0 {
            Some(Self { dimension, kind })
        } else {
            None
        }
    }

    /// Returns the dimension.
    #[must_use]
    pub const fn dimension(self) -> usize {
        self.dimension
    }

    /// Returns the classification kind.
    #[must_use]
    pub const fn kind(self) -> UniformPolytopeKind {
        self.kind
    }
}

#[cfg(test)]
mod tests {
    use super::{UniformPolytope, UniformPolytopeKind};

    #[test]
    fn stores_uniform_polytope_metadata() {
        let polytope = UniformPolytope::new(3, UniformPolytopeKind::Archimedean).expect("valid");

        assert_eq!(polytope.dimension(), 3);
        assert_eq!(polytope.kind(), UniformPolytopeKind::Archimedean);
        assert_eq!(UniformPolytope::new(0, UniformPolytopeKind::Regular), None);
    }
}