Grcov report - direct_int

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 conjure_cp::ast::Metadata;

9

use conjure_cp::ast::Moo;

10

use conjure_cp::into_matrix_expr;

11

12

use super::boolean::{tseytin_and, tseytin_iff, tseytin_not, tseytin_or, tseytin_xor};

13

14

use conjure_cp::ast::CnfClause;

15

/// Converts an integer literal to SATInt form

16

///

17

/// ```text

18

///  3

19

///  ~~>

20

///  SATInt([true;int(1..), (3, 3)])

21

///

22

/// ```

23

#[register_rule(("SAT_Direct", 9500))]

24

108255

fn literal_sat_direct_int(expr: &Expr, _: &SymbolTable) -> ApplicationResult {

25

429

    let value = {

26

4275

        if let Expr::Atomic(_, Atom::Literal(Literal::Int(value))) = expr {

27

429

            *value

28

        } else {

29

107826

            return Err(RuleNotApplicable);

30

31

};

32

33

429

    Ok(Reduction::pure(Expr::SATInt(

34

429

        Metadata::new(),

35

429

        SATIntEncoding::Direct,

36

429

        Moo::new(into_matrix_expr!(vec![Expr::Atomic(

37

429

            Metadata::new(),

38

429

            Atom::Literal(Literal::Bool(true)),

39

429

        )])),

40

429

        (value, value),

41

429

)))

42

108255

43

44

/// This function confirms that all of the input expressions are direct SATInts, and returns vectors for each input of their bits

45

/// This function also normalizes direct SATInt operands to a common value range by zero-padding.

46

8667

pub fn validate_direct_int_operands(

47

8667

    exprs: Vec<Expr>,

48

8667

) -> Result<(Vec<Vec<Expr>>, i32, i32), ApplicationError> {

49

    // TODO: In the future it may be possible to optimize operations between integers with different bit sizes

50

    // Collect inner bit vectors from each SATInt

51

52

    // Iterate over all inputs

53

    // Check they are direct and calulate a lower and upper bound

54

8667

    let mut global_min: i32 = i32::MAX;

55

8667

    let mut global_max: i32 = i32::MIN;

56

57

9573

    for operand in &exprs {

58

8856

        let Expr::SATInt(_, SATIntEncoding::Direct, _, (local_min, local_max)) = operand else {

59

8061

            return Err(RuleNotApplicable);

60

};

61

1512

        global_min = global_min.min(*local_min);

62

1512

        global_max = global_max.max(*local_max);

63

64

65

    // build out by iterating over each operand and expanding it to match the new bounds

66

67

606

    let out: Vec<Vec<Expr>> = exprs

68

606

        .into_iter()

69

1191

        .map(|expr| {

70

1191

            let Expr::SATInt(_, SATIntEncoding::Direct, inner, (local_min, local_max)) = expr

71

            else {

72

                return Err(RuleNotApplicable);

73

};

74

75

1191

            let Some(v) = inner.as_ref().clone().unwrap_list() else {

76

                return Err(RuleNotApplicable);

77

};

78

79

            // calulcate how many zeroes to prepend/append

80

1191

            let prefix_len = (local_min - global_min) as usize;

81

1191

            let postfix_len = (global_max - local_max) as usize;

82

83

1191

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

84

85

            // add 0s to start

86

1191

            bits.extend(std::iter::repeat_n(

87

1191

                Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(false))),

88

1191

                prefix_len,

89

));

90

91

1191

            bits.extend(v);

92

93

            // add 0s to end

94

1191

            bits.extend(std::iter::repeat_n(

95

1191

                Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(false))),

96

1191

                postfix_len,

97

));

98

99

1191

            Ok(bits)

100

1191

})

101

606

        .collect::<Result<_, _>>()?;

102

103

606

    Ok((out, global_min, global_max))

104

8667

105

106

/// Converts a = expression between two direct SATInts to a boolean expression in cnf

107

///

108

/// ```text

109

/// SATInt(a) = SATInt(b) ~> Bool

110

/// ```

111

/// NOTE: This rule reduces to AND_i (a[i] ≡ b[i]) and does not enforce one-hotness.

112

#[register_rule(("SAT_Direct", 9100))]

113

21309

fn eq_sat_direct(expr: &Expr, symbols: &SymbolTable) -> ApplicationResult {

114

    // TODO: this could be optimized by just going over the sections of both vectors where the ranges intersect

115

    // this does require enforcing structure separately

116

21309

    let Expr::Eq(_, lhs, rhs) = expr else {

117

21171

        return Err(RuleNotApplicable);

118

};

119

120

    let (binding, _, _) =

121

138

        validate_direct_int_operands(vec![lhs.as_ref().clone(), rhs.as_ref().clone()])?;

122

120

    let [lhs_bits, rhs_bits] = binding.as_slice() else {

123

        return Err(RuleNotApplicable);

124

};

125

126

120

    let bit_count = lhs_bits.len();

127

128

120

    let mut output = true.into();

129

120

    let mut new_symbols = symbols.clone();

130

120

    let mut new_clauses = vec![];

131

    let mut comparison;

132

133

2271

    for i in 0..bit_count {

134

2271

        comparison = tseytin_iff(

135

2271

            lhs_bits[i].clone(),

136

2271

            rhs_bits[i].clone(),

137

2271

            &mut new_clauses,

138

2271

            &mut new_symbols,

139

2271

);

140

2271

        output = tseytin_and(

141

2271

            &vec![comparison, output],

142

2271

            &mut new_clauses,

143

2271

            &mut new_symbols,

144

2271

);

145

2271

146

147

120

    Ok(Reduction::cnf(output, new_clauses, new_symbols))

148

21309

149

150

/// Converts a != expression between two direct SATInts to a boolean expression in cnf

151

///

152

/// ```text

153

/// SATInt(a) != SATInt(b) ~> Bool

154

///

155

/// ```

156

///

157

/// True iff at least one value position differs.

158

#[register_rule(("SAT_Direct", 9100))]

159

21309

fn neq_sat_direct(expr: &Expr, symbols: &SymbolTable) -> ApplicationResult {

160

21309

    let Expr::Neq(_, lhs, rhs) = expr else {

161

21282

        return Err(RuleNotApplicable);

162

};

163

164

24

    let (binding, _, _) =

165

27

        validate_direct_int_operands(vec![lhs.as_ref().clone(), rhs.as_ref().clone()])?;

166

24

    let [lhs_bits, rhs_bits] = binding.as_slice() else {

167

        return Err(RuleNotApplicable);

168

};

169

170

24

    let bit_count = lhs_bits.len();

171

172

24

    let mut output = false.into();

173

24

    let mut new_symbols = symbols.clone();

174

24

    let mut new_clauses = vec![];

175

    let mut comparison;

176

177

144

    for i in 0..bit_count {

178

144

        comparison = tseytin_xor(

179

144

            lhs_bits[i].clone(),

180

144

            rhs_bits[i].clone(),

181

144

            &mut new_clauses,

182

144

            &mut new_symbols,

183

144

);

184

144

        output = tseytin_or(

185

144

            &vec![comparison, output],

186

144

            &mut new_clauses,

187

144

            &mut new_symbols,

188

144

);

189

144

190

191

24

    Ok(Reduction::cnf(output, new_clauses, new_symbols))

192

21309

193

194

/// Converts a </>/<=/>= expression between two direct SATInts to a boolean expression in cnf

195

///

196

/// ```text

197

/// SATInt(a) </>/<=/>= SATInt(b) ~> Bool

198

///

199

/// ```

200

/// Note: < and <= are rewritten by swapping operands to reuse lt logic.

201

#[register_rule(("SAT", 9100))]

202

118776

fn ineq_sat_direct(expr: &Expr, symbols: &SymbolTable) -> ApplicationResult {

203

118776

    let (lhs, rhs, negate) = match expr {

204

        // A < B -> sat_direct_lt(A, B)

205

144

        Expr::Lt(_, x, y) => (x, y, false),

206

        // A > B -> sat_direct_lt(B, A)

207

186

        Expr::Gt(_, x, y) => (y, x, false),

208

        // A <= B -> NOT (B < A)

209

4461

        Expr::Leq(_, x, y) => (y, x, true),

210

        // A >= B -> NOT (A < B)

211

3687

        Expr::Geq(_, x, y) => (x, y, true),

212

110298

        _ => return Err(RuleNotApplicable),

213

};

214

215

441

    let (binding, _, _) =

216

8478

        validate_direct_int_operands(vec![lhs.as_ref().clone(), rhs.as_ref().clone()])?;

217

441

    let [lhs_bits, rhs_bits] = binding.as_slice() else {

218

        return Err(RuleNotApplicable);

219

};

220

221

441

    let mut new_symbols = symbols.clone();

222

441

    let mut new_clauses = vec![];

223

224

441

    let mut output = sat_direct_lt(

225

441

        lhs_bits.clone(),

226

441

        rhs_bits.clone(),

227

441

        &mut new_clauses,

228

441

        &mut new_symbols,

229

);

230

231

441

    if negate {

232

414

        output = tseytin_not(output, &mut new_clauses, &mut new_symbols);

233

414

234

235

441

    Ok(Reduction::cnf(output, new_clauses, new_symbols))

236

118776

237

238

/// Encodes a < b for one-hot direct integers using prefix OR logic.

239

441

fn sat_direct_lt(

240

441

    a: Vec<Expr>,

241

441

    b: Vec<Expr>,

242

441

    clauses: &mut Vec<CnfClause>,

243

441

    symbols: &mut SymbolTable,

244

441

) -> Expr {

245

441

    let mut b_or = Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(false)));

246

441

    let mut cum_result = Expr::Atomic(Metadata::new(), Atom::Literal(Literal::Bool(false)));

247

248

3537

    for (a_i, b_i) in a.iter().zip(b.iter()) {

249

        // b_or is prefix_or of b up to index i: B_i = b_0 | ... | b_i

250

3537

        b_or = tseytin_or(&vec![b_or, b_i.clone()], clauses, symbols);

251

3537

252

        // a < b if there exists i such that a=i and b > i.

253

        // b > i is equivalent to NOT(B_i) assuming one-hotness.

254

3537

        let not_b_or = tseytin_not(b_or.clone(), clauses, symbols);

255

3537

        let a_i_and_not_b_i = tseytin_and(&vec![a_i.clone(), not_b_or], clauses, symbols);

256

3537

257

3537

        cum_result = tseytin_or(&vec![cum_result, a_i_and_not_b_i], clauses, symbols);

258

3537

259

260

441

    cum_result

261

441

262

263

/// Converts a - expression for a SATInt to a new SATInt

264

///

265

/// ```text

266

/// -SATInt(a) ~> SATInt(b)

267

///

268

/// ```

269

#[register_rule(("SAT_Direct", 9100))]

270

21309

fn neg_sat_direct(expr: &Expr, _: &SymbolTable) -> ApplicationResult {

271

21309

    let Expr::Neg(_, value) = expr else {

272

21285

        return Err(RuleNotApplicable);

273

};

274

275

24

    let (binding, old_min, old_max) = validate_direct_int_operands(vec![value.as_ref().clone()])?;

276

21

    let [val_bits] = binding.as_slice() else {

277

        return Err(RuleNotApplicable);

278

};

279

280

21

    let new_min = -old_max;

281

21

    let new_max = -old_min;

282

283

21

    let mut out = val_bits.clone();

284

21

    out.reverse();

285

286

21

    Ok(Reduction::pure(Expr::SATInt(

287

21

        Metadata::new(),

288

21

        SATIntEncoding::Direct,

289

21

        Moo::new(into_matrix_expr!(out)),

290

21

        (new_min, new_max),

291

21

)))

292

21309