1
use conjure_cp::ast::{Atom, Expression as Expr, Literal};
2
use conjure_cp::ast::{SATIntEncoding, SymbolTable};
3
use conjure_cp::rule_engine::ApplicationError;
4
use conjure_cp::rule_engine::{
5
    ApplicationError::RuleNotApplicable, ApplicationResult, Reduction, register_rule,
6
};
7

            
8
use crate::sat::boolean::{tseytin_and, tseytin_iff, tseytin_not, tseytin_or};
9
use conjure_cp::ast::Metadata;
10
use conjure_cp::ast::Moo;
11
use conjure_cp::into_matrix_expr;
12

            
13
/// This function confirms that all of the input expressions are order SATInts, and returns vectors for each input of their bits
14
/// This function also normalizes order SATInt operands to a common value range.
15
879
pub fn validate_order_int_operands(
16
879
    exprs: Vec<Expr>,
17
879
) -> Result<(Vec<Vec<Expr>>, i32, i32), ApplicationError> {
18
    // Iterate over all inputs
19
    // Check they are order and calulate a lower and upper bound
20
879
    let mut global_min: i32 = i32::MAX;
21
879
    let mut global_max: i32 = i32::MIN;
22

            
23
1617
    for operand in &exprs {
24
1161
        let Expr::SATInt(_, SATIntEncoding::Order, _, (local_min, local_max)) = operand else {
25
456
            return Err(RuleNotApplicable);
26
        };
27
1161
        global_min = global_min.min(*local_min);
28
1161
        global_max = global_max.max(*local_max);
29
    }
30

            
31
    // build out by iterating over each operand and expanding it to match the new bounds
32
423
    let out: Vec<Vec<Expr>> = exprs
33
423
        .into_iter()
34
846
        .map(|expr| {
35
846
            let Expr::SATInt(_, SATIntEncoding::Order, inner, (local_min, local_max)) = expr else {
36
                return Err(RuleNotApplicable);
37
            };
38

            
39
846
            let Some(v) = inner.as_ref().clone().unwrap_list() else {
40
                return Err(RuleNotApplicable);
41
            };
42

            
43
            // calulcate how many trues/falses to prepend/append
44
846
            let prefix_len = (local_min - global_min) as usize;
45
846
            let postfix_len = (global_max - local_max) as usize;
46

            
47
846
            let mut bits = Vec::with_capacity(v.len() + prefix_len + postfix_len);
48

            
49
            // add `true`s to start
50
846
            bits.extend(std::iter::repeat_n(
51
846
                Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(true))),
52
846
                prefix_len,
53
            ));
54

            
55
846
            bits.extend(v);
56

            
57
            // add `false`s to end
58
846
            bits.extend(std::iter::repeat_n(
59
846
                Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(false))),
60
846
                postfix_len,
61
            ));
62

            
63
846
            Ok(bits)
64
846
        })
65
423
        .collect::<Result<_, _>>()?;
66

            
67
423
    Ok((out, global_min, global_max))
68
879
}
69

            
70
/// Encodes a < b for order integers.
71
///
72
/// `x < y` iff `exists i . (NOT x_i AND y_i)`
73
345
fn sat_order_lt(
74
345
    a_bits: Vec<Expr>,
75
345
    b_bits: Vec<Expr>,
76
345
    clauses: &mut Vec<conjure_cp::ast::CnfClause>,
77
345
    symbols: &mut SymbolTable,
78
345
) -> Expr {
79
345
    let mut result = Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(false)));
80

            
81
2397
    for (a_i, b_i) in a_bits.iter().zip(b_bits.iter()) {
82
        // (NOT a_i AND b_i)
83
2397
        let not_a_i = tseytin_not(a_i.clone(), clauses, symbols);
84
2397
        let current_term = tseytin_and(&vec![not_a_i, b_i.clone()], clauses, symbols);
85
2397

            
86
        // accumulate (NOT a_i AND b_i) into OR term
87
2397
        result = tseytin_or(&vec![result, current_term], clauses, symbols);
88
2397
    }
89
345
    result
90
345
}
91

            
92
/// Converts an integer literal to SATInt form
93
///
94
/// ```text
95
///  3
96
///  ~~>
97
///  SATInt([true;int(1..), (3, 3)])
98
///
99
/// ```
100
#[register_rule(("SAT_Order", 9500))]
101
60201
fn literal_sat_order_int(expr: &Expr, _: &SymbolTable) -> ApplicationResult {
102
291
    let value = {
103
2688
        if let Expr::Atomic(_, Atom::Literal(Literal::Int(value))) = expr {
104
291
            *value
105
        } else {
106
59910
            return Err(RuleNotApplicable);
107
        }
108
    };
109

            
110
291
    Ok(Reduction::pure(Expr::SATInt(
111
291
        Metadata::new(),
112
291
        SATIntEncoding::Order,
113
291
        Moo::new(into_matrix_expr!(vec![Expr::Atomic(
114
291
            Metadata::new(),
115
291
            Atom::Literal(Literal::Bool(true)),
116
291
        )])),
117
291
        (value, value),
118
291
    )))
119
60201
}
120

            
121
/// Builds CNF for equality between two order SATInt bit-vectors.
122
/// This function is used by both eq and neq rules, with the output negated for neq.
123
/// Returns (expr, clauses, symbols).
124
78
fn sat_order_eq_expr(
125
78
    lhs_bits: &[Expr],
126
78
    rhs_bits: &[Expr],
127
78
    symbols: &SymbolTable,
128
78
) -> (Expr, Vec<conjure_cp::ast::CnfClause>, SymbolTable) {
129
78
    let bit_count = lhs_bits.len();
130

            
131
78
    let mut output = true.into();
132
78
    let mut new_symbols = symbols.clone();
133
78
    let mut new_clauses = vec![];
134

            
135
399
    for i in 0..bit_count {
136
399
        let comparison = tseytin_iff(
137
399
            lhs_bits[i].clone(),
138
399
            rhs_bits[i].clone(),
139
399
            &mut new_clauses,
140
399
            &mut new_symbols,
141
399
        );
142
399
        output = tseytin_and(
143
399
            &vec![comparison, output],
144
399
            &mut new_clauses,
145
399
            &mut new_symbols,
146
399
        );
147
399
    }
148

            
149
78
    (output, new_clauses, new_symbols)
150
78
}
151

            
152
/// Converts a = expression between two order SATInts to a boolean expression in cnf
153
///
154
/// ```text
155
/// SATInt(a) = SATInt(b) ~> Bool
156
/// ```
157
#[register_rule(("SAT_Order", 9100))]
158
16812
fn eq_sat_order(expr: &Expr, symbols: &SymbolTable) -> ApplicationResult {
159
16812
    let Expr::Eq(_, lhs, rhs) = expr else {
160
16743
        return Err(RuleNotApplicable);
161
    };
162

            
163
66
    let (binding, _, _) =
164
69
        validate_order_int_operands(vec![lhs.as_ref().clone(), rhs.as_ref().clone()])?;
165
66
    let [lhs_bits, rhs_bits] = binding.as_slice() else {
166
        return Err(RuleNotApplicable);
167
    };
168

            
169
66
    let (output, new_clauses, new_symbols) = sat_order_eq_expr(lhs_bits, rhs_bits, symbols);
170

            
171
66
    Ok(Reduction::cnf(output, new_clauses, new_symbols))
172
16812
}
173

            
174
/// Converts a != expression between two order SATInts to a boolean expression in cnf
175
#[register_rule(("SAT_Order", 9100))]
176
16812
fn neq_sat_order(expr: &Expr, symbols: &SymbolTable) -> ApplicationResult {
177
16812
    let Expr::Neq(_, lhs, rhs) = expr else {
178
16797
        return Err(RuleNotApplicable);
179
    }; // considered covered
180

            
181
12
    let (binding, _, _) =
182
15
        validate_order_int_operands(vec![lhs.as_ref().clone(), rhs.as_ref().clone()])?;
183
12
    let [lhs_bits, rhs_bits] = binding.as_slice() else {
184
        return Err(RuleNotApplicable); // consider covered
185
    };
186

            
187
12
    let (mut output, mut new_clauses, mut new_symbols) =
188
12
        sat_order_eq_expr(lhs_bits, rhs_bits, symbols);
189

            
190
12
    output = tseytin_not(output, &mut new_clauses, &mut new_symbols);
191

            
192
12
    Ok(Reduction::cnf(output, new_clauses, new_symbols))
193
16812
}
194

            
195
/// Converts a </>/<=/>= expression between two order SATInts to a boolean expression in cnf
196
///
197
/// ```text
198
/// SATInt(a) </>/<=/>= SATInt(b) ~> Bool
199
///
200
/// ```
201
/// Note: < and <= are rewritten by swapping operands to reuse lt logic.
202
#[register_rule(("SAT_Order", 9100))]
203
16812
fn ineq_sat_order(expr: &Expr, symbols: &SymbolTable) -> ApplicationResult {
204
16812
    let (lhs, rhs, negate) = match expr {
205
        // A < B -> sat_order_lt(A, B)
206
12
        Expr::Lt(_, x, y) => (x, y, false),
207
        // A > B -> sat_order_lt(B, A)
208
3
        Expr::Gt(_, x, y) => (y, x, false),
209
        // A <= B -> NOT (B < A)
210
486
        Expr::Leq(_, x, y) => (y, x, true),
211
        // A >= B -> NOT (A < B)
212
294
        Expr::Geq(_, x, y) => (x, y, true),
213
16017
        _ => return Err(RuleNotApplicable),
214
    };
215

            
216
345
    let (binding, _, _) =
217
795
        validate_order_int_operands(vec![lhs.as_ref().clone(), rhs.as_ref().clone()])?;
218
345
    let [lhs_bits, rhs_bits] = binding.as_slice() else {
219
        return Err(RuleNotApplicable);
220
    };
221

            
222
345
    let mut new_symbols = symbols.clone();
223
345
    let mut new_clauses = vec![];
224

            
225
345
    let mut output = sat_order_lt(
226
345
        lhs_bits.clone(),
227
345
        rhs_bits.clone(),
228
345
        &mut new_clauses,
229
345
        &mut new_symbols,
230
    );
231

            
232
345
    if negate {
233
330
        output = tseytin_not(output, &mut new_clauses, &mut new_symbols);
234
330
    }
235

            
236
345
    Ok(Reduction::cnf(output, new_clauses, new_symbols))
237
16812
}