Grcov report - integer

1

use conjure_cp::ast::{Expression as Expr, GroundDomain};

2

use conjure_cp::ast::{SATIntEncoding, SymbolTable};

3

use conjure_cp::rule_engine::{

4

    ApplicationError, ApplicationError::RuleNotApplicable, ApplicationResult, Reduction,

5

    register_rule,

6

};

7

8

use conjure_cp::ast::Metadata;

9

use conjure_cp::ast::{Atom, Literal, Moo, Range};

10

use conjure_cp::into_matrix_expr;

11

12

use conjure_cp::{bug, essence_expr};

13

14

/// This function takes a target expression and a vector of ranges and creates an expression representing the ranges with the target expression as the subject

15

///

16

/// E.g. x : int(4), int(10..20), int(30..) ~~> Or(x=4, 10<=x<=20, x>=30)

17

438

fn int_domain_to_expr(subject: Expr, ranges: &Vec<Range<i32>>) -> Expr {

18

438

    let mut output = vec![];

19

20

438

    let value = Moo::new(subject);

21

22

498

    for range in ranges {

23

498

        match range {

24

81

            Range::Single(x) => output.push(essence_expr!(&value = &x)),

25

417

            Range::Bounded(x, y) => output.push(essence_expr!("&value >= &x /\\ &value <= &y")),

26

            _ => bug!("Unbounded domains not supported for SAT"),

27

28

29

30

438

    Expr::Or(Metadata::new(), Moo::new(into_matrix_expr!(output)))

31

438

32

33

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

34

/// This function also extends all vectors such that they have the same lengths

35

/// The vector lengths is either `n` for bit_count = Some(n), otherwise the length of the longest operand

36

813

pub fn validate_log_int_operands(

37

813

    exprs: Vec<Expr>,

38

813

    bit_count: Option<u32>,

39

813

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

40

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

41

    // Collect inner bit vectors from each SATInt

42

43

    // TODO: this file should be encoding agnostic so this needs to moved to the log_int_ops.rs file, do this once the direct ints have been merged to main though

44

813

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

45

813

        .into_iter()

46

1452

        .map(|expr| {

47

1212

            let Expr::SATInt(_, SATIntEncoding::Log, inner, _) = expr else {

48

240

                return Err(RuleNotApplicable);

49

};

50

1212

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

51

                return Err(RuleNotApplicable);

52

};

53

1212

            Ok(bits)

54

1452

})

55

813

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

56

57

    // Determine target length

58

573

    let max_len = bit_count

59

573

        .map(|b| b as usize)

60

1092

        .unwrap_or_else(|| out.iter().map(|v| v.len()).max().unwrap_or(0));

61

62

    // Extend or crop each vector

63

1125

    for v in &mut out {

64

1125

        if v.len() < max_len {

65

            // pad with the last element

66

246

            if let Some(last) = v.last().cloned() {

67

246

                v.resize(max_len, last);

68

246

69

879

        } else if v.len() > max_len {

70

            // crop extra elements

71

            v.truncate(max_len);

72

879

73

74

75

573

    Ok(out)

76

813

77

78

/// Converts an integer decision variable to SATInt form, creating a new representation of boolean variables if

79

/// one does not yet exist

80

///

81

/// ```text

82

///  x

83

///  ~~>

84

///  SATInt([x#00, x#01, ...])

85

///

86

///  new variables:

87

///  find x#00: bool

88

///  find x#01: bool

89

///  ...

90

///

91

/// ```

92

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

93

108255

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

94

    // thing we are representing must be a reference

95

65886

    let Expr::Atomic(_, Atom::Reference(name)) = expr else {

96

46644

        return Err(RuleNotApplicable);

97

};

98

99

    // thing we are representing must be a variable

100

    // symbols

101

    //     .lookup(name)

102

    //     .ok_or(RuleNotApplicable)?

103

    //     .as_find()

104

    //     .ok_or(RuleNotApplicable)?;

105

106

    // thing we are representing must be an integer

107

61611

    let dom = name.resolved_domain().ok_or(RuleNotApplicable)?;

108

61611

    let GroundDomain::Int(ranges) = dom.as_ref() else {

109

61281

        return Err(RuleNotApplicable);

110

};

111

112

330

    let (min, max) = ranges

113

330

        .iter()

114

360

        .fold((i32::MAX, i32::MIN), |(min_a, max_b), range| {

115

360

116

360

                min_a.min(*range.low().unwrap()),

117

360

                max_b.max(*range.high().unwrap()),

118

360

119

360

});

120

121

330

    let mut symbols = symbols.clone();

122

123

330

    let new_name = &name.name().to_owned();

124

125

330

    let repr_exists = symbols

126

330

        .get_representation(new_name, &["sat_direct_int"])

127

330

        .is_some();

128

129

330

    let representation = symbols

130

330

        .get_or_add_representation(new_name, &["sat_direct_int"])

131

330

        .ok_or(RuleNotApplicable)?;

132

133

330

    let bits: Vec<Expr> = representation[0]

134

330

        .clone()

135

330

        .expression_down(&symbols)?

136

330

        .into_values()

137

330

        .collect();

138

139

330

    let cnf_int = Expr::SATInt(

140

330

        Metadata::new(),

141

330

        SATIntEncoding::Direct,

142

330

        Moo::new(into_matrix_expr!(bits.clone())),

143

330

        (min, max),

144

330

);

145

146

330

    if !repr_exists {

147

        // Domain constraint: the integer must take one of its valid values

148

165

        let constraints = vec![int_domain_to_expr(cnf_int.clone(), ranges)];

149

150

        // At-Most-One constraints: only one bit can be true.

151

165

        let mut clauses = vec![];

152

1275

        for i in 0..bits.len() {

153

12612

            for j in i + 1..bits.len() {

154

12612

                clauses.push(conjure_cp::ast::CnfClause::new(vec![

155

12612

                    Expr::Not(Metadata::new(), Moo::new(bits[i].clone())),

156

12612

                    Expr::Not(Metadata::new(), Moo::new(bits[j].clone())),

157

12612

                ]));

158

12612

159

160

161

165

        let mut reduction = Reduction::cnf(cnf_int, clauses, symbols);

162

165

        reduction.new_top = constraints;

163

165

        Ok(reduction)

164

    } else {

165

        Ok(Reduction::pure(cnf_int))

166

167

108255

168

169

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

170

44649

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

171

    // thing we are representing must be a reference

172

21519

    let Expr::Atomic(_, Atom::Reference(name)) = expr else {

173

25260

        return Err(RuleNotApplicable);

174

};

175

176

    // thing we are representing must be an integer

177

19389

    let dom = name.resolved_domain().ok_or(RuleNotApplicable)?;

178

19389

    let GroundDomain::Int(ranges) = dom.as_ref() else {

179

19167

        return Err(RuleNotApplicable);

180

};

181

182

222

    let (min, max) = ranges

183

222

        .iter()

184

222

        .fold((i32::MAX, i32::MIN), |(min_a, max_b), range| {

185

222

186

222

                min_a.min(*range.low().unwrap()),

187

222

                max_b.max(*range.high().unwrap()),

188

222

189

222

});

190

191

222

    let mut symbols = symbols.clone();

192

193

222

    let new_name = &name.name().to_owned();

194

195

222

    let repr_exists = symbols

196

222

        .get_representation(new_name, &["sat_order_int"])

197

222

        .is_some();

198

199

222

    let representation = symbols

200

222

        .get_or_add_representation(new_name, &["sat_order_int"])

201

222

        .ok_or(RuleNotApplicable)?;

202

203

222

    let bits: Vec<Expr> = representation[0]

204

222

        .clone()

205

222

        .expression_down(&symbols)?

206

222

        .into_values()

207

222

        .collect();

208

209

222

    let cnf_int = Expr::SATInt(

210

222

        Metadata::new(),

211

222

        SATIntEncoding::Order,

212

222

        Moo::new(into_matrix_expr!(bits.clone())),

213

222

        (min, max),

214

222

);

215

216

222

    if !repr_exists {

217

        // Domain constraint: the integer must take one of its valid values

218

102

        let constraints = vec![int_domain_to_expr(cnf_int.clone(), ranges)];

219

220

        // Ordering constraints: b_i -> b_{i-1} which is !b_i or b_{i-1}

221

102

        let mut clauses = vec![];

222

321

        for i in 1..bits.len() {

223

321

            clauses.push(conjure_cp::ast::CnfClause::new(vec![

224

321

                Expr::Not(Metadata::new(), Moo::new(bits[i].clone())),

225

321

                bits[i - 1].clone(),

226

321

            ]));

227

321

228

229

102

        if !bits.is_empty() {

230

            // Domain constraint: a >= min, which is b_min.

231

102

            clauses.push(conjure_cp::ast::CnfClause::new(vec![bits[0].clone()]));

232

102

233

234

102

        let mut reduction = Reduction::cnf(cnf_int, clauses, symbols);

235

102

        reduction.new_top = constraints;

236

102

        Ok(reduction)

237

    } else {

238

120

        Ok(Reduction::pure(cnf_int))

239

240

44649

241

242

/// Converts an integer decision variable to SATInt form (Log encoding)

243

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

244

124497

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

245

    // thing we are representing must be a reference

246

66096

    let Expr::Atomic(_, Atom::Reference(name)) = expr else {

247

72807

        return Err(RuleNotApplicable);

248

};

249

250

    // thing we are representing must be a variable

251

    // symbols

252

    //     .lookup(name)

253

    //     .ok_or(RuleNotApplicable)?

254

    //     .as_find()

255

    //     .ok_or(RuleNotApplicable)?;

256

257

    // thing we are representing must be an integer

258

51690

    let dom = name.resolved_domain().ok_or(RuleNotApplicable)?;

259

51690

    let GroundDomain::Int(ranges) = dom.as_ref() else {

260

51444

        return Err(RuleNotApplicable);

261

};

262

263

246

    let (min, max) = ranges

264

246

        .iter()

265

276

        .fold((i32::MAX, i32::MIN), |(min_a, max_b), range| {

266

276

267

276

                min_a.min(*range.low().unwrap()),

268

276

                max_b.max(*range.high().unwrap()),

269

276

270

276

});

271

272

246

    let mut symbols = symbols.clone();

273

274

246

    let new_name = &name.name().to_owned();

275

276

246

    let repr_exists = symbols

277

246

        .get_representation(new_name, &["sat_log_int"])

278

246

        .is_some();

279

280

246

    let representation = symbols

281

246

        .get_or_add_representation(new_name, &["sat_log_int"])

282

246

        .ok_or(RuleNotApplicable)?;

283

284

246

    let bits = representation[0]

285

246

        .clone()

286

246

        .expression_down(&symbols)?

287

246

        .into_values()

288

246

        .collect();

289

290

246

    let cnf_int = Expr::SATInt(

291

246

        Metadata::new(),

292

246

        SATIntEncoding::Log,

293

246

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

294

246

        (min, max),

295

246

);

296

297

246

    if !repr_exists {

298

        // add domain ranges as constraints if this is the first time the representation is added

299

171

        Ok(Reduction::new(

300

171

            cnf_int.clone(),

301

171

            vec![int_domain_to_expr(cnf_int, ranges)], // contains domain rules

302

171

            symbols,

303

171

))

304

    } else {

305

75

        Ok(Reduction::pure(cnf_int))

306

307

124497

308

309

/// Converts an integer literal to SATInt form

310

///

311

/// ```text

312

///  3

313

///  ~~>

314

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

315

///

316

/// ```

317

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

318

124497

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

319

450

    let value = {

320

14406

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

321

450

*v

322

        } else {

323

124047

            return Err(RuleNotApplicable);

324

325

};

326

    //TODO: Adding constant optimization to all int operations should hopefully make this rule redundant

327

328

450

    let mut binary_encoding = vec![];

329

330

450

    let bit_count = bit_magnitude(value);

331

332

450

    let mut value_mut = value as u32;

333

334

1659

    for _ in 0..bit_count {

335

1659

        binary_encoding.push(Expr::Atomic(

336

1659

            Metadata::new(),

337

1659

            Atom::Literal(Literal::Bool((value_mut & 1) != 0)),

338

1659

));

339

1659

        value_mut >>= 1;

340

1659

341

342

450

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

343

450

        Metadata::new(),

344

450

        SATIntEncoding::Log,

345

450

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

346

450

        (value, value),

347

450

)))

348

124497

349

350

/// Determine the number of bits required to encode an i32 in 2s complement

351

486

pub fn bit_magnitude(x: i32) -> usize {

352

486

    if x >= 0 {

353

        // positive: bits = highest set bit + 1 sign bit

354

435

        (1 + (32 - x.leading_zeros())).try_into().unwrap()

355

    } else {

356

        // negative: bits = highest set bit in magnitude

357

51

        (33 - (!x).leading_zeros()).try_into().unwrap()

358

359

486

360

361

/// Given two vectors of expressions, extend the shorter one by repeating its last element until both are the same length

362

3

pub fn match_bits_length(a: Vec<Expr>, b: Vec<Expr>) -> (Vec<Expr>, Vec<Expr>) {

363

3

    let len_a = a.len();

364

3

    let len_b = b.len();

365

366

3

    if len_a < len_b {

367

        let last_a = a.last().cloned().unwrap();

368

        let mut a_extended = a;

369

        a_extended.resize(len_b, last_a);

370

        (a_extended, b)

371

3

    } else if len_b < len_a {

372

        let last_b = b.last().cloned().unwrap();

373

        let mut b_extended = b;

374

        b_extended.resize(len_a, last_b);

375

        (a, b_extended)

376

    } else {

377

3

        (a, b)

378

379

3