propositional_logic 0.2.0

generate truth tables for compound propositions
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

#![deny(clippy::all, clippy::pedantic, clippy::nursery, clippy::perf)]

pub mod macros;
pub mod prelude;

/// The Negation Logical Connective
/// # Example
/// ```
/// use propositional_logic::prelude::*;
///
/// assert_eq!(not(true), false);
/// assert_eq!(not(false), true);
/// ```
#[must_use]
pub const fn not(a: bool) -> bool {
    !a
}

/// The Conjunction Logical Connective
///
/// # Example
/// ```
/// use propositional_logic::prelude::*;
///
/// assert_eq!(and(true, true), true);
/// assert_eq!(and(true, false), false);
/// assert_eq!(and(false, true), false);
/// assert_eq!(and(false, false), false);
/// ```
#[must_use]
pub const fn and(a: bool, b: bool) -> bool {
    a && b
}

/// The Disjunction Logical Connective
///
/// # Example
/// ```
/// use propositional_logic::prelude::*;
///
/// assert_eq!(or(true, true), true);
/// assert_eq!(or(true, false), true);
/// assert_eq!(or(false, true), true);
/// assert_eq!(or(false, false), false);
/// ```
#[must_use]
pub const fn or(a: bool, b: bool) -> bool {
    a || b
}

/// The Exclusive Disjunction Logical Connective
///
/// # Example
/// ```
/// use propositional_logic::prelude::*;
///
/// assert_eq!(xor(true, true), false);
/// assert_eq!(xor(true, false), true);
/// assert_eq!(xor(false, true), true);
/// assert_eq!(xor(false, false), false);
/// ```
#[must_use]
pub const fn xor(a: bool, b: bool) -> bool {
    a ^ b
}

/// The Implication Logical Connective
///
/// # Example
/// ```
/// use propositional_logic::prelude::*;
///
/// assert_eq!(imply(true, true), true);
/// assert_eq!(imply(true, false), false);
/// assert_eq!(imply(false, true), true);
/// assert_eq!(imply(false, false), true);
/// ```
#[must_use]
pub const fn imply(a: bool, b: bool) -> bool {
    !a || b
}

/// The Biconditional Logical Connective
///
/// # Example
/// ```
/// use propositional_logic::prelude::*;
///
/// assert_eq!(iff(true, true), true);
/// assert_eq!(iff(true, false), false);
/// assert_eq!(iff(false, true), false);
/// assert_eq!(iff(false, false), true);
/// ```
#[must_use]
pub const fn iff(a: bool, b: bool) -> bool {
    imply(a, b) && imply(b, a)
}

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

    #[test]
    fn test_not() {
        assert!(!not(true));
        assert!(not(false));
    }

    #[test]
    fn test_and() {
        assert!(and(true, true));
        assert!(!and(true, false));
        assert!(!and(false, true));
        assert!(!and(false, false));
    }

    #[test]
    fn test_or() {
        assert!(or(true, true));
        assert!(or(true, false));
        assert!(or(false, true));
        assert!(!or(false, false));
    }

    #[test]
    fn test_xor() {
        assert!(!xor(true, true));
        assert!(xor(true, false));
        assert!(xor(false, true));
        assert!(!xor(false, false));
    }

    #[test]
    fn test_imply() {
        assert!(imply(true, true));
        assert!(!imply(true, false));
        assert!(imply(false, true));
        assert!(imply(false, false));
    }

    #[test]
    fn test_iff() {
        assert!(iff(true, true));
        assert!(!iff(true, false));
        assert!(!iff(false, true));
        assert!(iff(false, false));
    }
}