1
use conjure_cp::{
2
    ast::Metadata,
3
    ast::{
4
        Atom, DeclarationKind, Expression, Literal, Moo, Name, ReturnType, SymbolTable, Typeable,
5
    },
6
    into_matrix_expr, matrix_expr,
7
    rule_engine::{
8
        ApplicationError::{self, RuleNotApplicable},
9
        ApplicationResult, Reduction, register_rule, register_rule_set,
10
    },
11
};
12
use uniplate::{Biplate, Uniplate};
13

            
14
use super::utils::is_all_constant;
15

            
16
register_rule_set!("Bubble", ("Base"));
17

            
18
// Bubble reduction rules
19

            
20
/*
21
    Reduce bubbles with a boolean expression to a conjunction with their condition.
22

            
23
    e.g. (a / b = c) @ (b != 0) => (a / b = c) & (b != 0)
24
*/
25
#[register_rule(("Bubble", 8900))]
26
1350090
fn expand_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
27
1518
    match expr {
28
1518
        Expression::Bubble(_, a, b) if a.return_type() == ReturnType::Bool => {
29
708
            let a = Moo::unwrap_or_clone(Moo::clone(a));
30
708
            let b = Moo::unwrap_or_clone(Moo::clone(b));
31
708
            Ok(Reduction::pure(Expression::And(
32
708
                Metadata::new(),
33
708
                Moo::new(matrix_expr![a, b]),
34
708
            )))
35
        }
36
1349382
        _ => Err(ApplicationError::RuleNotApplicable),
37
    }
38
1350090
}
39

            
40
/*
41
    Bring bubbles with a non-boolean expression higher up the tree.
42

            
43
    E.g. ((a / b) @ (b != 0)) = c => (a / b = c) @ (b != 0)
44
*/
45
#[register_rule(("Bubble", 8800))]
46
1180338
fn bubble_up(expr: &Expression, syms: &SymbolTable) -> ApplicationResult {
47
    // do not put root inside a bubble
48
    //
49
    // also do not bubble bubbles inside bubbles, as this does nothing productive it just shuffles
50
    // the conditions around, shuffles them back, then gets stuck in a loop doing this ad infinitum
51
1180338
    if matches!(expr, Expression::Root(_, _) | Expression::Bubble(_, _, _)) {
52
32013
        return Err(RuleNotApplicable);
53
1148325
    }
54

            
55
    // do not bubble things containing lettings
56
3468228
    if expr.universe_bi().iter().any(|x: &Name| {
57
3468213
        syms.lookup(x).is_some_and(|x| {
58
3295047
            matches!(
59
3295047
                &x.kind() as &DeclarationKind,
60
                DeclarationKind::ValueLetting(_)
61
            )
62
3295047
        })
63
3468213
    }) {
64
        return Err(RuleNotApplicable);
65
1148325
    };
66

            
67
1148325
    let mut sub = expr.children();
68
1148325
    let mut bubbled_conditions = vec![];
69
1148325
    for e in sub.iter_mut() {
70
1037415
        if let Expression::Bubble(_, a, b) = e
71
810
            && a.return_type() != ReturnType::Bool
72
810
        {
73
810
            let a = Moo::unwrap_or_clone(Moo::clone(a));
74
810
            let b = Moo::unwrap_or_clone(Moo::clone(b));
75
810
            bubbled_conditions.push(b);
76
810
            *e = a;
77
1036605
        }
78
    }
79
1148325
    if bubbled_conditions.is_empty() {
80
1147515
        Err(ApplicationError::RuleNotApplicable)
81
810
    } else if bubbled_conditions.len() == 1 {
82
810
        let new_expr = Expression::Bubble(
83
810
            Metadata::new(),
84
810
            Moo::new(expr.with_children(sub)),
85
810
            Moo::new(bubbled_conditions[0].clone()),
86
810
        );
87

            
88
810
        Ok(Reduction::pure(new_expr))
89
    } else {
90
        Ok(Reduction::pure(Expression::Bubble(
91
            Metadata::new(),
92
            Moo::new(expr.with_children(sub)),
93
            Moo::new(Expression::And(
94
                Metadata::new(),
95
                Moo::new(into_matrix_expr![bubbled_conditions]),
96
            )),
97
        )))
98
    }
99
1180338
}
100

            
101
// Bubble applications
102

            
103
/// Converts an unsafe division to a safe division with a bubble condition.
104
///
105
/// ```text
106
///     a / b => (a / b) @ (b != 0)
107
/// ```
108
///
109
/// Division by zero is undefined and therefore not allowed, so we add a condition to check for it.
110
/// This condition is brought up the tree and expanded into a conjunction with the first
111
/// boolean-type expression it is paired with.
112

            
113
#[register_rule(("Bubble", 6000))]
114
726246
fn div_to_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
115
726246
    if is_all_constant(expr) {
116
113931
        return Err(RuleNotApplicable);
117
612315
    }
118
612315
    if let Expression::UnsafeDiv(_, a, b) = expr {
119
        // bubble bottom up
120
204
        if !a.is_safe() || !b.is_safe() {
121
24
            return Err(RuleNotApplicable);
122
180
        }
123

            
124
180
        return Ok(Reduction::pure(Expression::Bubble(
125
180
            Metadata::new(),
126
180
            Moo::new(Expression::SafeDiv(Metadata::new(), a.clone(), b.clone())),
127
180
            Moo::new(Expression::Neq(
128
180
                Metadata::new(),
129
180
                b.clone(),
130
180
                Moo::new(Expression::from(0)),
131
180
            )),
132
180
        )));
133
612111
    }
134
612111
    Err(ApplicationError::RuleNotApplicable)
135
726246
}
136

            
137
/// Converts an unsafe mod to a safe mod with a bubble condition.
138
///
139
/// ```text
140
/// a % b => (a % b) @ (b != 0)
141
/// ```
142
///
143
/// Mod zero is undefined and therefore not allowed, so we add a condition to check for it.
144
/// This condition is brought up the tree and expanded into a conjunction with the first
145
/// boolean-type expression it is paired with.
146
///
147
#[register_rule(("Bubble", 6000))]
148
726246
fn mod_to_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
149
726246
    if is_all_constant(expr) {
150
113931
        return Err(RuleNotApplicable);
151
612315
    }
152
612315
    if let Expression::UnsafeMod(_, a, b) = expr {
153
        // bubble bottom up
154
108
        if !a.is_safe() || !b.is_safe() {
155
18
            return Err(RuleNotApplicable);
156
90
        }
157

            
158
90
        return Ok(Reduction::pure(Expression::Bubble(
159
90
            Metadata::new(),
160
90
            Moo::new(Expression::SafeMod(Metadata::new(), a.clone(), b.clone())),
161
90
            Moo::new(Expression::Neq(
162
90
                Metadata::new(),
163
90
                b.clone(),
164
90
                Moo::new(Expression::from(0)),
165
90
            )),
166
90
        )));
167
612207
    }
168
612207
    Err(ApplicationError::RuleNotApplicable)
169
726246
}
170

            
171
/// Converts an unsafe pow to a safe pow with a bubble condition.
172
///
173
/// ```text
174
/// a**b => (a ** b) @ ((a!=0 \/ b!=0) /\ b>=0
175
/// ```
176
///
177
/// Pow is only defined when `(a!=0 \/ b!=0) /\ b>=0`, so we add a condition to check for it.
178
/// This condition is brought up the tree and expanded into a conjunction with the first
179
/// boolean-type expression it is paired with.
180
///
181
#[register_rule(("Bubble", 6000))]
182
726246
fn pow_to_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
183
726246
    if is_all_constant(expr) {
184
113931
        return Err(RuleNotApplicable);
185
612315
    }
186
612315
    if let Expression::UnsafePow(_, a, b) = expr.clone() {
187
        // bubble bottom up
188
84
        if !a.is_safe() || !b.is_safe() {
189
6
            return Err(RuleNotApplicable);
190
78
        }
191

            
192
78
        return Ok(Reduction::pure(Expression::Bubble(
193
78
            Metadata::new(),
194
78
            Moo::new(Expression::SafePow(Metadata::new(), a.clone(), b.clone())),
195
78
            Moo::new(Expression::And(
196
78
                Metadata::new(),
197
78
                Moo::new(matrix_expr![
198
78
                    Expression::Or(
199
78
                        Metadata::new(),
200
78
                        Moo::new(matrix_expr![
201
78
                            Expression::Neq(
202
78
                                Metadata::new(),
203
78
                                a,
204
78
                                Moo::new(Atom::Literal(Literal::Int(0)).into()),
205
78
                            ),
206
78
                            Expression::Neq(
207
78
                                Metadata::new(),
208
78
                                b.clone(),
209
78
                                Moo::new(Atom::Literal(Literal::Int(0)).into()),
210
78
                            ),
211
78
                        ]),
212
78
                    ),
213
78
                    Expression::Geq(
214
78
                        Metadata::new(),
215
78
                        b,
216
78
                        Moo::new(Atom::Literal(Literal::Int(0)).into()),
217
78
                    ),
218
78
                ]),
219
78
            )),
220
78
        )));
221
612231
    }
222
612231
    Err(ApplicationError::RuleNotApplicable)
223
726246
}