pumpkin-checking 0.4.0

Types used by both pumpkin-core and pumpkin-checker
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

use std::fmt::Debug;

use crate::AtomicConstraint;
use crate::Comparison;
use crate::IntExt;
use crate::TestAtomic;
use crate::VariableState;

/// A variable in a constraint satisfaction problem.
pub trait CheckerVariable<Atomic: AtomicConstraint>: Debug + Clone {
    /// Tests whether the given atomic is a statement over the variable `self`.
    fn does_atomic_constrain_self(&self, atomic: &Atomic) -> bool;

    /// Get the atomic constraint `[self <= value]`.
    fn atomic_less_than(&self, value: i32) -> Atomic;

    /// Get the atomic constraint `[self <= value]`.
    fn atomic_greater_than(&self, value: i32) -> Atomic;

    /// Get the atomic constraint `[self == value]`.
    fn atomic_equal(&self, value: i32) -> Atomic;

    /// Get the atomic constraint `[self != value]`.
    fn atomic_not_equal(&self, value: i32) -> Atomic;

    /// Get the lower bound of the domain.
    fn induced_lower_bound(&self, variable_state: &VariableState<Atomic>) -> IntExt;

    /// Get the upper bound of the domain.
    fn induced_upper_bound(&self, variable_state: &VariableState<Atomic>) -> IntExt;

    /// Get the value the variable is fixed to, if the variable is fixed.
    fn induced_fixed_value(&self, variable_state: &VariableState<Atomic>) -> Option<i32>;

    /// Returns whether the value is in the domain.
    fn induced_domain_contains(&self, variable_state: &VariableState<Atomic>, value: i32) -> bool;

    /// Get the holes in the domain.
    fn induced_holes<'this, 'state>(
        &'this self,
        variable_state: &'state VariableState<Atomic>,
    ) -> impl Iterator<Item = i32> + 'state
    where
        'this: 'state;

    /// Iterate the domain of the variable.
    ///
    /// The order of the values is unspecified.
    fn iter_induced_domain<'this, 'state>(
        &'this self,
        variable_state: &'state VariableState<Atomic>,
    ) -> Option<impl Iterator<Item = i32> + 'state>
    where
        'this: 'state;
}

impl CheckerVariable<TestAtomic> for &'static str {
    fn does_atomic_constrain_self(&self, atomic: &TestAtomic) -> bool {
        &atomic.name == self
    }

    fn atomic_less_than(&self, value: i32) -> TestAtomic {
        TestAtomic {
            name: self,
            comparison: Comparison::LessEqual,
            value,
        }
    }

    fn atomic_greater_than(&self, value: i32) -> TestAtomic {
        TestAtomic {
            name: self,
            comparison: Comparison::GreaterEqual,
            value,
        }
    }

    fn atomic_equal(&self, value: i32) -> TestAtomic {
        TestAtomic {
            name: self,
            comparison: Comparison::Equal,
            value,
        }
    }

    fn atomic_not_equal(&self, value: i32) -> TestAtomic {
        TestAtomic {
            name: self,
            comparison: Comparison::NotEqual,
            value,
        }
    }

    fn induced_lower_bound(&self, variable_state: &VariableState<TestAtomic>) -> IntExt {
        variable_state.lower_bound(self)
    }

    fn induced_upper_bound(&self, variable_state: &VariableState<TestAtomic>) -> IntExt {
        variable_state.upper_bound(self)
    }

    fn induced_fixed_value(&self, variable_state: &VariableState<TestAtomic>) -> Option<i32> {
        variable_state.fixed_value(self)
    }

    fn induced_domain_contains(
        &self,
        variable_state: &VariableState<TestAtomic>,
        value: i32,
    ) -> bool {
        variable_state.contains(self, value)
    }

    fn induced_holes<'this, 'state>(
        &'this self,
        variable_state: &'state VariableState<TestAtomic>,
    ) -> impl Iterator<Item = i32> + 'state
    where
        'this: 'state,
    {
        variable_state.holes(self)
    }

    fn iter_induced_domain<'this, 'state>(
        &'this self,
        variable_state: &'state VariableState<TestAtomic>,
    ) -> Option<impl Iterator<Item = i32> + 'state>
    where
        'this: 'state,
    {
        variable_state.iter_domain(self)
    }
}