pumpkin-core 0.5.0

The core of the Pumpkin constraint programming solver.
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

use super::TrailedChange;
use super::TrailedInteger;
use crate::basic_types::Trail;
use crate::containers::KeyedVec;

#[derive(Default, Debug, Clone)]
pub(crate) struct TrailedValues {
    trail: Trail<TrailedChange>,
    values: KeyedVec<TrailedInteger, i64>,
}

impl TrailedValues {
    pub(crate) fn grow(&mut self, initial_value: i64) -> TrailedInteger {
        self.values.push(initial_value)
    }

    pub(crate) fn new_checkpoint(&mut self) {
        self.trail.new_checkpoint()
    }

    pub(crate) fn read(&self, trailed_integer: TrailedInteger) -> i64 {
        self.values[trailed_integer]
    }

    pub(crate) fn synchronise(&mut self, new_checkpoint: usize) {
        self.trail
            .synchronise(new_checkpoint)
            .for_each(|state_change| self.values[state_change.reference] = state_change.old_value)
    }

    fn write(&mut self, trailed_integer: TrailedInteger, value: i64) {
        let old_value = self.values[trailed_integer];
        if old_value == value {
            return;
        }
        let entry = TrailedChange {
            old_value,
            reference: trailed_integer,
        };
        self.trail.push(entry);
        self.values[trailed_integer] = value;
    }

    #[cfg(test)]
    pub(crate) fn add_assign(&mut self, trailed_integer: TrailedInteger, addition: i64) {
        self.write(trailed_integer, self.values[trailed_integer] + addition);
    }

    pub(crate) fn assign(&mut self, trailed_integer: TrailedInteger, value: i64) {
        self.write(trailed_integer, value);
    }

    pub(crate) fn debug_create_empty_clone(&self) -> Self {
        let mut new_trail = self.trail.clone();
        let mut new_values = self.values.clone();
        if new_trail.get_checkpoint() > 0 {
            new_trail.synchronise(0).for_each(|state_change| {
                new_values[state_change.reference] = state_change.old_value
            });
        }
        Self {
            trail: new_trail,
            values: new_values,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::engine::TrailedValues;

    #[test]
    fn test_write_resets() {
        let mut assignments = TrailedValues::default();
        let trailed_integer = assignments.grow(0);

        assert_eq!(assignments.read(trailed_integer), 0);

        assignments.new_checkpoint();
        assignments.add_assign(trailed_integer, 5);

        assert_eq!(assignments.read(trailed_integer), 5);

        assignments.add_assign(trailed_integer, 5);
        assert_eq!(assignments.read(trailed_integer), 10);

        assignments.new_checkpoint();
        assignments.add_assign(trailed_integer, 1);

        assert_eq!(assignments.read(trailed_integer), 11);

        assignments.synchronise(1);
        assert_eq!(assignments.read(trailed_integer), 10);

        assignments.synchronise(0);
        assert_eq!(assignments.read(trailed_integer), 0);
    }
}