mck 0.7.1

Utility crate for the formal verification tool machine-check
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use std::{
    cmp::Ordering,
    fmt::Display,
    ops::{BitAnd, BitOr, BitXor, Not},
};

use serde::{Deserialize, Serialize};

use crate::misc::Join;

/// An extension of a Boolean to three-valued logic.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum ThreeValued {
    // Known false.
    False,
    // Known true.
    True,
    // Either false or true, but it is unknown which one.
    Unknown,
}

impl PartialOrd for ThreeValued {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for ThreeValued {
    fn cmp(&self, other: &Self) -> Ordering {
        match (self, other) {
            (ThreeValued::False, ThreeValued::False) => Ordering::Equal,
            (ThreeValued::False, ThreeValued::Unknown) => Ordering::Less,
            (ThreeValued::False, ThreeValued::True) => Ordering::Less,

            (ThreeValued::Unknown, ThreeValued::False) => Ordering::Greater,
            (ThreeValued::Unknown, ThreeValued::Unknown) => Ordering::Equal,
            (ThreeValued::Unknown, ThreeValued::True) => Ordering::Less,

            (ThreeValued::True, ThreeValued::False) => Ordering::Greater,
            (ThreeValued::True, ThreeValued::Unknown) => Ordering::Greater,
            (ThreeValued::True, ThreeValued::True) => Ordering::Equal,
        }
    }
}

impl ThreeValued {
    /// Whether the value is unknown, i.e. neither false nor true.
    pub fn is_unknown(&self) -> bool {
        matches!(self, ThreeValued::Unknown)
    }

    /// Whether the value is known, i.e. false or true.
    pub fn is_known(&self) -> bool {
        !self.is_unknown()
    }

    /// Whether the value is definitely false.
    pub fn is_false(&self) -> bool {
        matches!(self, ThreeValued::False)
    }

    /// Whether the value is definitely true.
    pub fn is_true(&self) -> bool {
        matches!(self, ThreeValued::True)
    }

    pub fn from_bool(value: bool) -> ThreeValued {
        if value {
            ThreeValued::True
        } else {
            ThreeValued::False
        }
    }
}

impl Not for ThreeValued {
    type Output = Self;

    fn not(self) -> Self {
        match self {
            ThreeValued::False => ThreeValued::True,
            ThreeValued::True => ThreeValued::False,
            ThreeValued::Unknown => ThreeValued::Unknown,
        }
    }
}

impl BitAnd for ThreeValued {
    type Output = Self;

    fn bitand(self, rhs: Self) -> Self::Output {
        match (self, rhs) {
            (ThreeValued::False, _) => ThreeValued::False,
            (_, ThreeValued::False) => ThreeValued::False,
            (ThreeValued::Unknown, _) => ThreeValued::Unknown,
            (_, ThreeValued::Unknown) => ThreeValued::Unknown,
            (ThreeValued::True, ThreeValued::True) => ThreeValued::True,
        }
    }
}

impl BitOr for ThreeValued {
    type Output = Self;

    fn bitor(self, rhs: Self) -> Self::Output {
        match (self, rhs) {
            (ThreeValued::True, _) => ThreeValued::True,
            (_, ThreeValued::True) => ThreeValued::True,
            (ThreeValued::Unknown, _) => ThreeValued::Unknown,
            (_, ThreeValued::Unknown) => ThreeValued::Unknown,
            (ThreeValued::False, ThreeValued::False) => ThreeValued::False,
        }
    }
}

impl BitXor for ThreeValued {
    type Output = Self;

    fn bitxor(self, rhs: Self) -> Self::Output {
        match (self, rhs) {
            (ThreeValued::True, ThreeValued::True) | (ThreeValued::False, ThreeValued::False) => {
                ThreeValued::False
            }
            (ThreeValued::True, ThreeValued::False) | (ThreeValued::False, ThreeValued::True) => {
                ThreeValued::True
            }
            _ => ThreeValued::Unknown,
        }
    }
}

impl Join for ThreeValued {
    fn join(self, rhs: &Self) -> Self {
        match (self, rhs) {
            (ThreeValued::False, ThreeValued::False) => ThreeValued::False,
            (ThreeValued::True, ThreeValued::True) => ThreeValued::True,
            (ThreeValued::False, ThreeValued::True) | (ThreeValued::True, ThreeValued::False) => {
                ThreeValued::Unknown
            }
            (ThreeValued::Unknown, _) | (_, ThreeValued::Unknown) => ThreeValued::Unknown,
        }
    }
}

impl Display for ThreeValued {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let str = match self {
            ThreeValued::False => "false",
            ThreeValued::True => "true",
            ThreeValued::Unknown => "unknown",
        };
        write!(f, "{}", str)
    }
}