geometry/
sign.rs

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
//! Signs: positive or negative.

use array_map::Indexable;
use serde::{Deserialize, Serialize};

/// Enumeration over possible signs.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, Hash, PartialEq, Eq)]
#[repr(u8)]
#[derive(Indexable)]
pub enum Sign {
    /// Positive.
    Pos,
    /// Negative.
    Neg,
}

impl Sign {
    /// Converts this sign to +1 (if positive) or -1 (if negative).
    #[inline]
    pub const fn as_int(&self) -> i64 {
        match self {
            Self::Pos => 1,
            Self::Neg => -1,
        }
    }

    /// Returns true if the sign is positive.
    #[inline]
    pub const fn is_pos(&self) -> bool {
        matches!(self, Sign::Pos)
    }

    /// Returns true if the sign is negative.
    #[inline]
    pub const fn is_neg(&self) -> bool {
        matches!(self, Sign::Neg)
    }
}

impl std::ops::Not for Sign {
    type Output = Self;
    /// Flips the [`Sign`].
    fn not(self) -> Self::Output {
        match self {
            Self::Pos => Self::Neg,
            Self::Neg => Self::Pos,
        }
    }
}