use-geometric-complex 0.0.6

Geometric complex 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
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

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

use use_cell::Cell;

/// A general geometric complex count summary.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct GeometricComplex {
    dimension: usize,
    cell_count: usize,
}

impl GeometricComplex {
    /// Creates a geometric complex descriptor.
    #[must_use]
    pub const fn new(dimension: usize, cell_count: usize) -> Option<Self> {
        if cell_count > 0 {
            Some(Self {
                dimension,
                cell_count,
            })
        } else {
            None
        }
    }

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

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

/// A collection of geometric cells.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CellComplex {
    cells: Vec<Cell>,
}

impl CellComplex {
    /// Creates a cell complex.
    #[must_use]
    pub const fn new(cells: Vec<Cell>) -> Self {
        Self { cells }
    }

    /// Returns the cells.
    #[must_use]
    pub fn cells(&self) -> &[Cell] {
        &self.cells
    }

    /// Returns the number of cells.
    #[must_use]
    pub fn cell_count(&self) -> usize {
        self.cells.len()
    }
}

/// A simplicial complex represented by simplex dimensions.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SimplicialComplex {
    simplex_dimensions: Vec<usize>,
}

impl SimplicialComplex {
    /// Creates a simplicial complex from simplex dimensions.
    #[must_use]
    pub fn new(simplex_dimensions: Vec<usize>) -> Option<Self> {
        if simplex_dimensions.iter().all(|dimension| *dimension > 0) {
            Some(Self { simplex_dimensions })
        } else {
            None
        }
    }

    /// Returns simplex dimensions.
    #[must_use]
    pub fn simplex_dimensions(&self) -> &[usize] {
        &self.simplex_dimensions
    }

    /// Returns the number of simplexes.
    #[must_use]
    pub fn simplex_count(&self) -> usize {
        self.simplex_dimensions.len()
    }
}

#[cfg(test)]
mod tests {
    use super::{CellComplex, GeometricComplex, SimplicialComplex};
    use use_cell::Cell;

    #[test]
    fn stores_geometric_complex_metadata() {
        let cell = Cell::new(2, 3).expect("valid cell");
        let cell_complex = CellComplex::new(vec![cell]);
        let geometric = GeometricComplex::new(2, 1).expect("valid complex");
        let simplicial = SimplicialComplex::new(vec![1, 2]).expect("valid simplicial complex");

        assert_eq!(cell_complex.cell_count(), 1);
        assert_eq!(cell_complex.cells(), &[cell]);
        assert_eq!(geometric.dimension(), 2);
        assert_eq!(simplicial.simplex_count(), 2);
        assert_eq!(SimplicialComplex::new(vec![0]), None);
    }
}