use-cell 0.0.6

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

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

/// A cell used by geometric complex crates.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Cell {
    dimension: usize,
    boundary_count: usize,
}

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

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

    /// Returns the number of boundary elements.
    #[must_use]
    pub const fn boundary_count(self) -> usize {
        self.boundary_count
    }
}

#[cfg(test)]
mod tests {
    use super::Cell;

    #[test]
    fn stores_cell_metadata() {
        let cell = Cell::new(2, 4).expect("valid cell");

        assert_eq!(cell.dimension(), 2);
        assert_eq!(cell.boundary_count(), 4);
        assert_eq!(Cell::new(0, 1), None);
    }
}