geometric-traits 0.1.0

Trait-based algebraic and graph algorithms for Rust, supporting no_std environments
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

//! Enumeration for the LAPMOD assignment state, including the variants of:
//!
//! * `Unassigned`
//! * `Assigned`
//! * `Conflict`

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// The LAPMOD assignment state.
pub enum AssignmentState<T> {
    /// The assignment is unassigned.
    Unassigned,
    /// The assignment is assigned.
    Assigned(T),
    /// The assignment is in conflict.
    Conflict(T),
}

impl<T> AssignmentState<T> {
    /// Returns true if the assignment is unassigned.
    ///
    /// # Examples
    ///
    /// ```
    /// use geometric_traits::traits::algorithms::AssignmentState;
    ///
    /// let state: AssignmentState<usize> = AssignmentState::Unassigned;
    /// assert!(state.is_unassigned());
    /// ```
    #[inline]
    pub fn is_unassigned(&self) -> bool {
        matches!(self, AssignmentState::Unassigned)
    }

    /// Returns true if the assignment is assigned.
    ///
    /// # Examples
    ///
    /// ```
    /// use geometric_traits::traits::algorithms::AssignmentState;
    ///
    /// let state: AssignmentState<usize> = AssignmentState::Assigned(1);
    /// assert!(state.is_assigned());
    /// ```
    #[inline]
    pub fn is_assigned(&self) -> bool {
        matches!(self, AssignmentState::Assigned(_))
    }
}