semitone 0.0.28

SeMiTONE is a Satisfiability Modulo TheOries NEtwork, allowing the creation of variables and constraints in different underlying theories.
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
use crate::out_of_bounds;
use std::{collections::VecDeque, fmt, mem, ops};
use tracing::trace;

pub type Conflict = (usize, Vec<Lit>);

pub(super) struct SatSolver {
    assigns: Vec<Option<bool>>,       // Current assignments of boolean variables (None = unassigned, Some(true/false) = assigned)
    clauses: Vec<Clause>,             // List of clauses in the solver
    watches: Vec<Vec<usize>>,         // Watch lists for each literal (positive and negative)
    reason: Vec<Option<usize>>,       // Reason for each variable's assignment
    seen: Vec<bool>,                  // Temporary storage for conflict analysis
    analyze_toclear: Vec<usize>,      // Temporary storage for conflict analysis
    prop_q: VecDeque<Lit>,            // Queue of literals to propagate
    pub(super) trail: Vec<Lit>,       // Trail of assigned literals for backtracking
    pub(super) trail_lim: Vec<usize>, // Indices in the trail where decisions were made
    level: Vec<Option<usize>>,        // Decision level for each variable
    user_scopes: Vec<(usize, usize)>, // Stack of user-defined scopes (start index in trail, decision level)
}

impl SatSolver {
    pub(super) fn new() -> Self {
        let mut sat = SatSolver {
            assigns: Vec::new(),
            clauses: Vec::new(),
            watches: Vec::new(),
            reason: Vec::new(),
            seen: Vec::new(),
            analyze_toclear: Vec::new(),
            prop_q: VecDeque::new(),
            trail: Vec::new(),
            trail_lim: Vec::new(),
            level: Vec::new(),
            user_scopes: Vec::new(),
        };
        sat.mk_var();
        sat.enqueue(Lit::TRUE, None);
        let _ = sat.propagate();
        sat
    }

    pub(super) fn mk_var(&mut self) -> usize {
        let idx = self.assigns.len();
        trace!("Creating new variable b{}", idx);
        self.assigns.push(None);
        self.watches.push(Vec::new());
        self.watches.push(Vec::new()); // For the negated literal
        self.reason.push(None);
        self.seen.push(false);
        self.level.push(None);
        idx
    }

    pub(super) fn num_vars(&self) -> usize {
        self.assigns.len()
    }

    pub(super) fn push_decision(&mut self) {
        assert!(self.prop_q.is_empty(), "Cannot push decision level while propagation queue is not empty");
        self.trail_lim.push(self.trail.len());
    }

    pub(super) fn push(&mut self) {
        self.push_decision();
        self.user_scopes.push((self.decision_level(), self.clauses.len()));
    }

    pub(super) fn floor_level(&self) -> usize {
        self.user_scopes.last().map_or(0, |&(level, _)| level)
    }

    pub(super) fn pop(&mut self) -> Option<Vec<Lit>> {
        let (scope_level, clauses_len) = self.user_scopes.pop()?;
        let undone = self.cancel_until(scope_level - 1);
        for watch_list in self.watches.iter_mut() {
            watch_list.retain(|&idx| idx < clauses_len);
        }
        self.clauses.truncate(clauses_len);
        Some(undone)
    }

    pub(super) fn enqueue_decision(&mut self, lit: Lit) -> bool {
        assert!(self.lit_value(lit).is_none(), "Cannot decide on an already assigned literal: {}", lit);
        self.enqueue(lit, None)
    }

    pub(super) fn propagate(&mut self) -> Result<(), Conflict> {
        while let Some(lit) = self.prop_q.pop_front() {
            let falsified = !lit;
            let falsified_index = falsified.index();
            let watches = mem::take(&mut self.watches[falsified_index]);
            for i in 0..watches.len() {
                let clause_idx = watches[i];
                // Keep the first watched literal as the other watcher and the second as the falsified one.
                if self.clauses[clause_idx].lits[0] == falsified {
                    self.clauses[clause_idx].lits.swap(0, 1);
                }

                // Check if clause is already satisfied
                if self.lit_value(self.clauses[clause_idx].lits[0]) == Some(true) {
                    self.watches[falsified_index].push(clause_idx);
                    continue;
                }

                // Find a replacement watcher that is not currently false.
                let mut found_replacement = false;
                for j in 2..self.clauses[clause_idx].lits.len() {
                    let next_lit = self.clauses[clause_idx].lits[j];
                    if self.lit_value(next_lit) != Some(false) {
                        self.clauses[clause_idx].lits.swap(1, j);
                        self.watches[next_lit.index()].push(clause_idx);
                        found_replacement = true;
                        break;
                    }
                }

                if found_replacement {
                    continue;
                }

                // If we reach here, the clause is either unit or unsatisfied
                self.watches[falsified_index].push(clause_idx); // Re-add the clause to the watch list
                if !self.enqueue(self.clauses[clause_idx].lits[0], Some(clause_idx)) {
                    for c_i in watches.iter().skip(i + 1) {
                        self.watches[falsified_index].push(*c_i);
                    }
                    self.prop_q.clear();
                    if self.decision_level() <= self.floor_level() {
                        return Err((self.floor_level(), self.clauses[clause_idx].lits.clone()));
                    }
                    return Err(self.analyze_conflict(clause_idx));
                }
            }
        }
        Ok(())
    }

    fn analyze_conflict(&mut self, mut confl: usize) -> Conflict {
        let mut path_c = 0;
        let mut p_lit = None; // Option<Lit>
        let mut learnt = vec![Lit::new(0, false)];
        let mut index = self.trail.len();

        self.analyze_toclear.clear();

        loop {
            let clause = &self.clauses[confl];
            let start_idx = if p_lit.is_none() { 0 } else { 1 };

            for j in start_idx..clause.lits.len() {
                let q = clause.lits[j];
                let var = q.var();

                if !self.seen[var] && self.level(var).unwrap_or(0) > 0 {
                    self.seen[var] = true;
                    self.analyze_toclear.push(var);

                    if self.level(var).unwrap_or(0) >= self.decision_level() {
                        path_c += 1;
                    } else {
                        learnt.push(q);
                    }
                }
            }

            loop {
                index -= 1;
                if self.seen[self.trail[index].var()] {
                    break;
                }
            }

            let next_p = self.trail[index];
            p_lit = Some(next_p);
            confl = self.reason[next_p.var()].unwrap_or_default();
            self.seen[next_p.var()] = false;
            path_c -= 1;

            if path_c == 0 {
                break;
            }
        }

        learnt[0] = !p_lit.unwrap();

        let mut j = 1;
        for i in 1..learnt.len() {
            let var = learnt[i].var();
            let mut redundant = false;

            if let Some(reason_idx) = self.reason[var] {
                redundant = true;
                let c = &self.clauses[reason_idx];
                for k in 1..c.lits.len() {
                    let v = c.lits[k].var();
                    if !self.seen[v] && self.level(v).unwrap_or(0) > 0 {
                        redundant = false; // There is an external dependency
                        break;
                    }
                }
            }

            if !redundant {
                learnt[j] = learnt[i];
                j += 1;
            }
        }
        learnt.truncate(j);

        let mut bt_level = 0;
        if learnt.len() > 1 {
            let mut max_i = 1;
            let mut max_level = self.level(learnt[1].var()).unwrap_or(0);

            for (i, lit) in learnt.iter().enumerate().skip(2) {
                let l = self.level(lit.var()).unwrap_or(0);
                if l > max_level {
                    max_level = l;
                    max_i = i;
                }
            }

            learnt.swap(1, max_i);
            bt_level = max_level;
        }

        for &var in &self.analyze_toclear {
            self.seen[var] = false;
        }

        (bt_level, learnt)
    }

    fn enqueue(&mut self, lit: Lit, reason: Option<usize>) -> bool {
        trace!("Enqueue {}{}", lit, reason.map_or("".to_string(), |r| format!(" (reason: {})", r)));
        match self.lit_value(lit) {
            None => {
                self.assigns[lit.var()] = if lit.sign() { Some(false) } else { Some(true) };
                self.level[lit.var()] = Some(self.decision_level());
                self.reason[lit.var()] = reason;
                self.trail.push(lit);
                self.prop_q.push_back(lit);
                true
            }
            Some(value) => value,
        }
    }

    pub(super) fn add_clause(&mut self, lits: impl IntoIterator<Item = Lit>) -> Result<(), Conflict> {
        let mut simplified_lits = Vec::new();

        for lit in lits {
            match self.lit_value(lit) {
                Some(true) if self.level(lit.var()) == Some(0) => {
                    return Ok(()); // Clause is already satisfied at level 0
                }
                Some(false) if self.level(lit.var()) == Some(0) => {
                    continue;
                }
                _ => {
                    if simplified_lits.contains(&!lit) {
                        return Ok(()); // Clause is trivially satisfied (tautology)
                    }
                    if !simplified_lits.contains(&lit) {
                        simplified_lits.push(lit);
                    }
                }
            }
        }

        match simplified_lits.len() {
            0 => return Err((self.floor_level(), simplified_lits)),
            1 => {
                let floor = self.floor_level();
                let lit = simplified_lits[0];
                let lvl = self.level(lit.var()).unwrap_or(0);
                match self.lit_value(lit) {
                    Some(true) if lvl <= floor => return Ok(()),
                    Some(false) if lvl <= floor => return Err((floor, simplified_lits)),
                    _ => {}
                }
                if self.decision_level() > floor {
                    return Err((floor, simplified_lits));
                }
                let enqueued = self.enqueue(lit, None);
                debug_assert!(enqueued);
            }
            _ => {
                simplified_lits.sort_by_key(|&l| {
                    let lvl = self.level(l.var()).unwrap_or(0);
                    match self.lit_value(l) {
                        Some(true) => (0u8, lvl),
                        None => (1, 0),
                        Some(false) => (2, usize::MAX - lvl),
                    }
                });

                let first = simplified_lits[0];
                let second = simplified_lits[1];

                if self.lit_value(first) == Some(false) {
                    return Err((self.conflict_bt_level(&simplified_lits), simplified_lits));
                }

                let is_unit = self.lit_value(first).is_none() && self.lit_value(second) == Some(false);
                if is_unit {
                    let assert_level = self.level(second.var()).unwrap_or(0).max(self.floor_level());
                    if self.decision_level() > assert_level {
                        return Err((assert_level, simplified_lits));
                    }
                }

                let clause_index = self.clauses.len();
                let clause = Clause::new(simplified_lits);
                trace!("Adding clause {}: {}", clause_index, clause);

                self.watches[clause.lits[0].index()].push(clause_index);
                self.watches[clause.lits[1].index()].push(clause_index);
                self.clauses.push(clause);

                if is_unit {
                    let enqueued = self.enqueue(first, Some(clause_index));
                    debug_assert!(enqueued);
                }
            }
        }
        Ok(())
    }

    /// Level to backtrack to so that the (falsified) `clause` becomes asserting; never below `floor`.
    pub(super) fn conflict_bt_level(&self, clause: &[Lit]) -> usize {
        let floor = self.floor_level();
        if clause.len() <= 1 {
            return floor;
        }
        let mut levels: Vec<usize> = clause.iter().map(|l| self.level(l.var()).unwrap_or(0)).collect();
        levels.sort_unstable_by(|a, b| b.cmp(a));
        let max = levels[0];
        if max <= floor {
            return floor;
        }
        if levels[1] < max { levels[1].max(floor) } else { (max - 1).max(floor) }
    }

    #[inline]
    pub(super) fn value(&self, var: usize) -> Option<bool> {
        self.assigns.get(var).copied().unwrap_or_else(|| out_of_bounds(var))
    }

    #[inline]
    pub(super) fn lit_value(&self, lit: Lit) -> Option<bool> {
        let val = self.value(lit.var());
        if lit.sign() { val.map(|v| !v) } else { val }
    }

    #[inline]
    pub(super) fn level(&self, var: usize) -> Option<usize> {
        self.level.get(var).copied().unwrap_or_else(|| out_of_bounds(var))
    }

    #[inline]
    pub(super) fn lit_level(&self, lit: Lit) -> Option<usize> {
        self.level(lit.var())
    }

    #[inline]
    pub(super) fn lit_value_and_level(&self, lit: Lit) -> Option<(bool, usize)> {
        let val = self.lit_value(lit)?;
        let lvl = self.level(lit.var()).expect("Level should be set for assigned variable");
        Some((val, lvl))
    }

    pub(super) fn decision_level(&self) -> usize {
        self.trail_lim.len()
    }

    pub(super) fn cancel_until(&mut self, level: usize) -> Vec<Lit> {
        trace!("Canceling until level {}", level);
        let mut retracted = Vec::new();
        while self.decision_level() > level {
            let lim = self.trail_lim.pop().unwrap();
            while self.trail.len() > lim {
                let lit = self.trail.pop().expect("Trail underflow while canceling until level");
                trace!("Undoing assignment of {}", lit);
                self.assigns[lit.var()] = None;
                self.reason[lit.var()] = None;
                self.level[lit.var()] = None;
                retracted.push(lit);
            }
        }
        self.prop_q.retain(|l| self.assigns[l.var()] == Some(!l.sign()));
        retracted
    }

    /// Simplifies the clauses in the solver.
    pub(super) fn simplify_db(&mut self) -> bool {
        assert_eq!(self.decision_level(), 0, "simplify_db should only be called at decision level 0");

        if self.propagate().is_err() {
            return false;
        }

        for lit in &self.trail {
            self.reason[lit.var()] = None;
        }

        let mut clauses = mem::take(&mut self.clauses);
        clauses.retain_mut(|c| !c.simplify(self));
        self.clauses = clauses;

        for w in self.watches.iter_mut() {
            w.clear();
        }
        for (idx, c) in self.clauses.iter().enumerate() {
            debug_assert!(c.lits.len() >= 2, "unit/empty clause survived root propagation");
            self.watches[c.lits[0].index()].push(idx);
            self.watches[c.lits[1].index()].push(idx);
        }
        true
    }
}

impl fmt::Display for SatSolver {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "Assignments:")?;
        for (i, val) in self.assigns.iter().enumerate() {
            if let Some(v) = val {
                writeln!(f, "  b{} = {}", i, v)?;
            } else {
                writeln!(f, "  b{} = unassigned", i)?;
            }
        }
        writeln!(f, "Clauses:")?;
        for (i, clause) in self.clauses.iter().enumerate() {
            writeln!(f, "  {}: {}", i, clause)?;
        }
        Ok(())
    }
}

// Compact encoding: x = var*2 + sign_bit, where sign_bit=1 means negated (MiniSat convention).
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Lit {
    x: usize,
}

impl Lit {
    pub fn new(var: usize, sign: bool) -> Self {
        Lit { x: var * 2 + sign as usize }
    }

    /// Variable index.
    pub fn var(self) -> usize {
        self.x >> 1
    }

    /// True if this is a negated literal.
    pub fn sign(self) -> bool {
        self.x & 1 != 0
    }

    /// Compact integer index suitable for watch-list indexing (MiniSat's toInt).
    pub(super) fn index(self) -> usize {
        self.x
    }

    pub const TRUE: Lit = Lit { x: 0 };
    pub const FALSE: Lit = Lit { x: 1 };
}

impl ops::Not for Lit {
    type Output = Self;

    fn not(self) -> Self {
        Lit { x: self.x ^ 1 }
    }
}

impl fmt::Display for Lit {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.sign() { write!(f, "¬b{}", self.var()) } else { write!(f, "b{}", self.var()) }
    }
}

pub(super) struct Clause {
    lits: Vec<Lit>, // List of literals in the clause
}

impl Clause {
    fn new(lits: Vec<Lit>) -> Self {
        Clause { lits }
    }

    /// Simplifies the clause by removing literals that are already satisfied or falsified at decision level 0.
    /// Returns true if the clause is satisfied, false otherwise.
    fn simplify(&mut self, sat: &SatSolver) -> bool {
        if self.lits.iter().any(|&l| sat.lit_value(l) == Some(true)) {
            return true;
        }
        self.lits.retain(|&l| sat.lit_value(l).is_none());
        false
    }
}

impl fmt::Display for Clause {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let lits: Vec<String> = self.lits.iter().map(|l| l.to_string()).collect();
        write!(f, "({})", lits.join(" ∨ "))
    }
}

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

    fn decide(sat: &mut SatSolver, lit: Lit) -> Result<(), Conflict> {
        sat.push_decision();
        sat.enqueue_decision(lit);
        sat.propagate()
    }

    #[test]
    fn unit_clause_at_decision_level_returns_conflict_to_backtrack() {
        let mut sat = SatSolver::new();
        let var = sat.mk_var();

        sat.push_decision();
        assert_eq!(sat.floor_level(), 0);

        let lit = Lit::new(var, false);

        let result = sat.add_clause([lit]);
        assert_eq!(result, Err((0, vec![lit])));

        sat.cancel_until(0);
        assert_eq!(sat.decision_level(), 0);

        let retry_result = sat.add_clause([lit]);
        assert_eq!(retry_result, Ok(()));

        assert_eq!(sat.level(var), Some(0));
        assert_eq!(sat.lit_value(lit), Some(true));
    }

    #[test]
    fn test_conflict_analysis() {
        let mut sat = SatSolver::new();
        let b1 = sat.mk_var();
        let b2 = sat.mk_var();
        let b3 = sat.mk_var();
        let b4 = sat.mk_var();
        let b5 = sat.mk_var();
        let b6 = sat.mk_var();
        let b7 = sat.mk_var();
        let b8 = sat.mk_var();
        let b9 = sat.mk_var();

        // [(b1 ∨ b2) ∧ (b1 ∨ b3 ∨ b7) ∧ (¬b2 ∨ ¬b3 ∨ b4) ∧ (¬b4 ∨ b5 ∨ b8) ∧ (¬b4 ∨ b6 ∨ b9) ∧ (¬b5 ∨ ¬b6)]
        assert!(sat.add_clause([Lit::new(b1, false), Lit::new(b2, false)]).is_ok());
        assert!(sat.add_clause([Lit::new(b1, false), Lit::new(b3, false), Lit::new(b7, false)]).is_ok());
        assert!(sat.add_clause([Lit::new(b2, true), Lit::new(b3, true), Lit::new(b4, false)]).is_ok());
        assert!(sat.add_clause([Lit::new(b4, true), Lit::new(b5, false), Lit::new(b8, false)]).is_ok());
        assert!(sat.add_clause([Lit::new(b4, true), Lit::new(b6, false), Lit::new(b9, false)]).is_ok());
        assert!(sat.add_clause([Lit::new(b5, true), Lit::new(b6, true)]).is_ok());

        // Decision: ¬b7
        decide(&mut sat, Lit::new(b7, true)).expect("Should be able to decide ¬b7");
        // Decision: ¬b8
        decide(&mut sat, Lit::new(b8, true)).expect("Should be able to decide ¬b8");
        // Decision: ¬b9
        decide(&mut sat, Lit::new(b9, true)).expect("Should be able to decide ¬b9");
        // Decision: ¬b1
        let result = decide(&mut sat, Lit::new(b1, true));
        assert!(result.is_err());
        let (bt_level, conflict_clause) = result.unwrap_err();
        assert_eq!(bt_level, 3);
        assert!(conflict_clause.contains(&Lit::new(b4, true)));
        assert!(conflict_clause.contains(&Lit::new(b8, false)));
        assert!(conflict_clause.contains(&Lit::new(b9, false)));
        sat.cancel_until(bt_level);
        assert!(sat.add_clause(conflict_clause).is_ok());
    }

    #[test]
    fn simplify_removes_satisfied_clauses_and_false_literals() {
        let mut sat = SatSolver::new();
        let (a, b, c, d) = (sat.mk_var(), sat.mk_var(), sat.mk_var(), sat.mk_var());
        let (la, lb, lc, ld) = (Lit::new(a, false), Lit::new(b, false), Lit::new(c, false), Lit::new(d, false));

        assert!(sat.add_clause([la, lb]).is_ok()); // -> (a ∨ b)
        assert!(sat.add_clause([!la, lc, ld]).is_ok()); // -> (c ∨ d)
        assert!(sat.add_clause([!la, lb, lc]).is_ok()); // -> (b ∨ c)
        assert!(sat.add_clause([la]).is_ok()); // -> (a) should simplify the other clauses

        assert!(sat.simplify_db());
        assert_eq!(sat.clauses.len(), 2);
        assert!(sat.clauses.iter().all(|cl| cl.lits.len() == 2));

        decide(&mut sat, !lc).expect("no conflict");
        assert_eq!(sat.lit_value(ld), Some(true));
        assert_eq!(sat.lit_value(lb), Some(true));
    }
}