permanganate 0.2.0

Graph and Boolean SAT solver for Numberlink and Flow Free
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302

#[cfg(test)]
mod tests {
    use std::num::NonZero;

    use crate::builder::{Builder, SquareBoardBuilder};
    use crate::location::Location;
    use crate::shape::SquareStep;

    #[test]
    fn remove_termini() {
        let board = SquareBoardBuilder::with_dims((NonZero::new(5).unwrap(), NonZero::new(5).unwrap()))
            .add_termini('A', (Location(0, 0), Location(1, 4)))
            .pop_termini()
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), ".....
.....
.....
.....
.....
");
    }

    #[test]
    fn solve_most_basic() {
        // flow free classic pack level 1
        let board = SquareBoardBuilder::with_dims((NonZero::new(5).unwrap(), NonZero::new(5).unwrap()))
            .add_termini('A', (Location(0, 0), Location(1, 4)))
            .add_termini('B', (Location(2, 0), Location(1, 3)))
            .add_termini('C', (Location(2, 1), Location(2, 4)))
            .add_termini('D', (Location(4, 0), Location(3, 3)))
            .add_termini('E', (Location(4, 1), Location(3, 4)))
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), "A.B.D
..C.E
.....
.B.D.
.ACE.
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "AbBdD
abCdE
abcde
aBcDe
aACEe
")
    }

    #[test]
    fn solve_large_simple_square() {
        // flow free extreme pack 2 12x12 level 13
        let board = SquareBoardBuilder::with_dims((NonZero::new(12).unwrap(), NonZero::new(12).unwrap()))
            .add_termini('A', (Location(7, 4), Location(4, 11)))
            .add_termini('B', (Location(6, 4), Location(5, 11)))
            .add_termini('C', (Location(6, 6), Location(0, 11)))
            .add_termini('D', (Location(2, 2), Location(7, 3)))
            .add_termini('E', (Location(5, 4), Location(7, 11)))
            .add_termini('F', (Location(7, 2), Location(3, 8)))
            .add_termini('G', (Location(2, 8), Location(5, 10)))
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), "............
............
..D....F....
.......D....
.....EBA....
............
......C.....
............
..GF........
............
.....G......
C...AB.E....
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "ccccceeeeeee
caaacebbbbbe
caDacebFffbe
cadacebDdfbe
cadacEBAdfbe
cadacccadfbe
cadaaaCadfbe
cadddaaadfbe
caGFdddddfbe
cagfffffffbe
cagggGbbbbbe
CaaaABbEeeee
")
    }

    #[test]
    fn simple_with_bridge() {
        // flow free bridges starter pack 5x5 level 2
        let board = SquareBoardBuilder::with_dims((NonZero::new(5).unwrap(), NonZero::new(5).unwrap()))
            .add_termini('A', (Location(1, 3), Location(3, 0)))
            .add_termini('B', (Location(1, 4), Location(4, 3)))
            .add_termini('C', (Location(0, 0), Location(0, 4)))
            .add_termini('D', (Location(1, 0), Location(2, 2)))
            .add_termini('E', (Location(4, 0), Location(2, 3)))
            .add_bridge(Location(2, 1))
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), "CD.AE
..+..
..D..
.AE.B
CB...
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "CDdAE
ca+ae
caDee
cAEeB
CBbbb
");
    }

    #[test]
    fn adjacent_bridges() {
        // flow free bridges hashed pack 7x7 level 1
        let board = SquareBoardBuilder::with_dims((NonZero::new(7).unwrap(), NonZero::new(7).unwrap()))
            .add_termini('A', (Location(0, 5), Location(5, 6)))
            .add_termini('B', (Location(0, 0), Location(6, 6)))
            .add_termini('C', (Location(1, 1), Location(6, 1)))
            .add_termini('D', (Location(1, 2), Location(6, 4)))
            .add_termini('E', (Location(1, 5), Location(6, 2)))
            .add_termini('F', (Location(4, 2), Location(4, 5)))
            .add_bridge(Location(2, 3))
            .add_bridge(Location(2, 4))
            .add_bridge(Location(3, 3))
            .add_bridge(Location(3, 4))
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), "B......
.C....C
.D..F.E
..++...
..++..D
AE..F..
.....AB
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "Bcccccc
bCeeeeC
bDefFeE
bd++ddd
bb++bbD
AEefFbb
aaaaaAB
");
    }

    #[test]
    fn simple_with_warp() {
        // flow free warps starter pack level 2
        let board = SquareBoardBuilder::with_dims((NonZero::new(5).unwrap(), NonZero::new(3).unwrap()))
            .add_termini('A', (Location(0, 0), Location(4, 0)))
            .add_termini('B', (Location(3, 1), Location(4, 2)))
            .add_termini('C', (Location(0, 2), Location(2, 1)))
            .add_termini('D', (Location(1, 1), Location(4, 1)))
            .add_warp(Location(0, 1), None)
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), "A...A
.DCBD
C...B
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "AaaaA
dDCBD
CccbB
");
    }

    #[test]
    fn warp_with_holes() {
        // flow free warps starter pack level 1
        let board = SquareBoardBuilder::with_dims((NonZero::new(6).unwrap(), NonZero::new(3).unwrap()))
            .add_termini('A', (Location(0, 1), Location(4, 1)))
            .add_termini('B', (Location(1, 0), Location(3, 0)))
            .add_termini('C', (Location(1, 1), Location(3, 1)))
            .add_termini('D', (Location(1, 2), Location(3, 2)))
            .add_warp(Location(0, 1), None)
            .drop_location(Location(0, 0))
            .drop_location(Location(0, 2))
            .drop_location(Location(4, 0))
            .drop_location(Location(5, 0))
            .drop_location(Location(4, 2))
            .drop_location(Location(5, 2))
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), ".B.B..
AC.CA.
.D.D..
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), ".BbB..
ACcCAa
.DdD..
");
    }

    #[test]
    fn walls() {
        // flow free pockets pack level 1
        let board = SquareBoardBuilder::with_dims((NonZero::new(8).unwrap(), NonZero::new(8).unwrap()))
            .add_termini('A', (Location(1, 2), Location(6, 5)))
            .disconnect_around(Location(1, 2), &vec![SquareStep::Left, SquareStep::Down, SquareStep::Right])
            .disconnect_around(Location(6, 5), &vec![SquareStep::Left, SquareStep::Down, SquareStep::Right])
            .add_termini('B', (Location(2, 5), Location(4, 5)))
            .disconnect_around(Location(2, 5), &vec![SquareStep::Left, SquareStep::Down, SquareStep::Right])
            .add_termini('C', (Location(4, 4), Location(7, 7)))
            .disconnect_around(Location(4, 4), &vec![SquareStep::Left, SquareStep::Down, SquareStep::Right])
            .add_termini('D', (Location(5, 2), Location(7, 5)))
            .disconnect_around(Location(5, 2), &vec![SquareStep::Left, SquareStep::Down, SquareStep::Right])
            .add_termini('E', (Location(3, 1), Location(3, 7)))
            .disconnect_around(Location(3, 1), &vec![SquareStep::Left, SquareStep::Down, SquareStep::Right])
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), "........
...E....
.A...D..
........
....C...
..B.B.AD
........
...E...C
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "eeeeaaaa
eaaEadda
eAaaaDda
eccccdda
ecbbCdaa
ecBbBdAD
eccccddd
eeeEcccC
");
    }

    #[test]
    fn warps_and_bridges() {
        // flow free bridges warps pack level 150
        let board = SquareBoardBuilder::with_dims((NonZero::new(9).unwrap(), NonZero::new(9).unwrap()))
            .add_termini('A', (Location(6, 1), Location(7, 2)))
            .add_termini('B', (Location(3, 2), Location(5, 6)))
            .add_termini('C', (Location(3, 4), Location(5, 3)))
            .add_termini('D', (Location(2, 7), Location(6, 3)))
            .add_termini('E', (Location(6, 2), Location(7, 7)))
            .add_termini('F', (Location(2, 6), Location(4, 8)))
            .add_termini('G', (Location(1, 0), Location(0, 3)))
            .add_termini('H', (Location(3, 1), Location(3, 3)))
            .add_termini('I', (Location(0, 8), Location(3, 7)))
            .add_termini('J', (Location(5, 5), Location(5, 8)))
            .add_warp(Location(4, 0), None)
            .add_warp(Location(4, 8), None)
            .add_warp(Location(0, 4), None)
            .add_warp(Location(8, 4), None)
            .add_bridge(Location(4, 6))
            .build()
            .unwrap();

        assert_eq!(format!("{}", board), ".G.......
...H..A..
...B..EA.
G..H.CD..
...C.....
.....J...
..F.+B...
..DI...E.
I...FJ...
");

        let solved = board.solve().unwrap();
        assert_eq!(format!("{}", solved), "gGfffeeee
gffHheAae
gfbBheEAe
GfbHhCDee
dfbCccded
dfbbjJded
dfFb+Bded
ddDIjjdEd
IiiiFJddd
");
    }
}