use-catalan-solid 0.0.6

Catalan solid metadata 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
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

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

use use_archimedean::ArchimedeanSolid;

/// The thirteen Catalan solids.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CatalanSolid {
    /// Triakis tetrahedron.
    TriakisTetrahedron,
    /// Rhombic dodecahedron.
    RhombicDodecahedron,
    /// Triakis octahedron.
    TriakisOctahedron,
    /// Tetrakis hexahedron.
    TetrakisHexahedron,
    /// Deltoidal icositetrahedron.
    DeltoidalIcositetrahedron,
    /// Disdyakis dodecahedron.
    DisdyakisDodecahedron,
    /// Pentagonal icositetrahedron.
    PentagonalIcositetrahedron,
    /// Rhombic triacontahedron.
    RhombicTriacontahedron,
    /// Triakis icosahedron.
    TriakisIcosahedron,
    /// Pentakis dodecahedron.
    PentakisDodecahedron,
    /// Deltoidal hexecontahedron.
    DeltoidalHexecontahedron,
    /// Disdyakis triacontahedron.
    DisdyakisTriacontahedron,
    /// Pentagonal hexecontahedron.
    PentagonalHexecontahedron,
}

impl CatalanSolid {
    /// Returns the common lowercase name.
    #[must_use]
    pub const fn name(self) -> &'static str {
        match self {
            Self::TriakisTetrahedron => "triakis tetrahedron",
            Self::RhombicDodecahedron => "rhombic dodecahedron",
            Self::TriakisOctahedron => "triakis octahedron",
            Self::TetrakisHexahedron => "tetrakis hexahedron",
            Self::DeltoidalIcositetrahedron => "deltoidal icositetrahedron",
            Self::DisdyakisDodecahedron => "disdyakis dodecahedron",
            Self::PentagonalIcositetrahedron => "pentagonal icositetrahedron",
            Self::RhombicTriacontahedron => "rhombic triacontahedron",
            Self::TriakisIcosahedron => "triakis icosahedron",
            Self::PentakisDodecahedron => "pentakis dodecahedron",
            Self::DeltoidalHexecontahedron => "deltoidal hexecontahedron",
            Self::DisdyakisTriacontahedron => "disdyakis triacontahedron",
            Self::PentagonalHexecontahedron => "pentagonal hexecontahedron",
        }
    }

    /// Returns the Archimedean solid dual to this Catalan solid.
    #[must_use]
    pub const fn dual_archimedean(self) -> ArchimedeanSolid {
        match self {
            Self::TriakisTetrahedron => ArchimedeanSolid::TruncatedTetrahedron,
            Self::RhombicDodecahedron => ArchimedeanSolid::Cuboctahedron,
            Self::TriakisOctahedron => ArchimedeanSolid::TruncatedCube,
            Self::TetrakisHexahedron => ArchimedeanSolid::TruncatedOctahedron,
            Self::DeltoidalIcositetrahedron => ArchimedeanSolid::Rhombicuboctahedron,
            Self::DisdyakisDodecahedron => ArchimedeanSolid::TruncatedCuboctahedron,
            Self::PentagonalIcositetrahedron => ArchimedeanSolid::SnubCube,
            Self::RhombicTriacontahedron => ArchimedeanSolid::Icosidodecahedron,
            Self::TriakisIcosahedron => ArchimedeanSolid::TruncatedDodecahedron,
            Self::PentakisDodecahedron => ArchimedeanSolid::TruncatedIcosahedron,
            Self::DeltoidalHexecontahedron => ArchimedeanSolid::Rhombicosidodecahedron,
            Self::DisdyakisTriacontahedron => ArchimedeanSolid::TruncatedIcosidodecahedron,
            Self::PentagonalHexecontahedron => ArchimedeanSolid::SnubDodecahedron,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::CatalanSolid;
    use use_archimedean::ArchimedeanSolid;

    #[test]
    fn exposes_dual_archimedean_metadata() {
        let solid = CatalanSolid::RhombicDodecahedron;

        assert_eq!(solid.name(), "rhombic dodecahedron");
        assert_eq!(solid.dual_archimedean(), ArchimedeanSolid::Cuboctahedron);
    }
}