honeycomb_core/cmap/components/orbits.rs
1/// # Orbit search policy enum
2///
3/// This is used to define special cases of orbits that are often used in
4/// algorithms. These special cases correspond to `i`-cells.
5#[derive(Debug, PartialEq, Clone)]
6pub enum OrbitPolicy {
7 /// 0-cell orbit.
8 Vertex,
9 /// 0-cell orbit, without using beta 0. Incorrect if the cell isn't complete / closed.
10 VertexLinear,
11 /// 1-cell orbit.
12 Edge,
13 /// 2-cell orbit.
14 Face,
15 /// 2-cell orbit, without using beta 0. Incorrect if the cell isn't complete / closed.
16 FaceLinear,
17 /// 3-cell orbit.
18 Volume,
19 /// 3-cell orbit, without using beta 0. Incorrect if the cell isn't complete / closed.
20 VolumeLinear,
21 /// Ordered array of beta functions defining the orbit.
22 Custom(&'static [u8]),
23}