GCC Code Coverage Report
Directory: . Exec Total Coverage
File: src/theory/booleans/theory_bool_rewriter.cpp Lines: 221 229 96.5 %
Date: 2021-05-21 Branches: 866 1565 55.3 %

Line Exec Source
1
/******************************************************************************
2
 * Top contributors (to current version):
3
 *   Tim King, Dejan Jovanovic, Haniel Barbosa
4
 *
5
 * This file is part of the cvc5 project.
6
 *
7
 * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
8
 * in the top-level source directory and their institutional affiliations.
9
 * All rights reserved.  See the file COPYING in the top-level source
10
 * directory for licensing information.
11
 * ****************************************************************************
12
 *
13
 * [[ Add one-line brief description here ]]
14
 *
15
 * [[ Add lengthier description here ]]
16
 * \todo document this file
17
 */
18
19
#include <algorithm>
20
#include <unordered_set>
21
22
#include "expr/node_value.h"
23
#include "theory/booleans/theory_bool_rewriter.h"
24
25
namespace cvc5 {
26
namespace theory {
27
namespace booleans {
28
29
11681347
RewriteResponse TheoryBoolRewriter::postRewrite(TNode node) {
30
11681347
  return preRewrite(node);
31
}
32
33
/**
34
 * flattenNode looks for children of same kind, and if found merges
35
 * them into the parent.
36
 *
37
 * It simultaneously handles a couple of other optimizations:
38
 * - trivialNode - if found during exploration, return that node itself
39
 *    (like in case of OR, if "true" is found, makes sense to replace
40
 *     whole formula with "true")
41
 * - skipNode - as name suggests, skip them
42
 *    (like in case of OR, you may want to skip any "false" nodes found)
43
 *
44
 * Use a null node if you want to ignore any of the optimizations.
45
 */
46
751737
RewriteResponse flattenNode(TNode n, TNode trivialNode, TNode skipNode)
47
{
48
  typedef std::unordered_set<TNode> node_set;
49
50
1503474
  node_set visited;
51
751737
  visited.insert(skipNode);
52
53
1503474
  std::vector<TNode> toProcess;
54
751737
  toProcess.push_back(n);
55
56
751737
  Kind k = n.getKind();
57
  typedef std::vector<TNode> ChildList;
58
1503474
  ChildList childList;   //TNode should be fine, since 'n' is still there
59
60
2205857
  for (unsigned i = 0; i < toProcess.size(); ++ i) {
61
2924449
    TNode current = toProcess[i];
62
9727533
    for(unsigned j = 0, j_end = current.getNumChildren(); j < j_end; ++ j) {
63
15488301
      TNode child = current[j];
64
8273413
      if(visited.find(child) != visited.end()) {
65
1042316
        continue;
66
7231097
      } else if(child == trivialNode) {
67
16209
        return RewriteResponse(REWRITE_DONE, trivialNode);
68
      } else {
69
7214888
        visited.insert(child);
70
7214888
        if(child.getKind() == k)
71
719518
          toProcess.push_back(child);
72
        else
73
6495370
          childList.push_back(child);
74
      }
75
    }
76
  }
77
735528
  if (childList.size() == 0) return RewriteResponse(REWRITE_DONE, skipNode);
78
652633
  if (childList.size() == 1) return RewriteResponse(REWRITE_AGAIN, childList[0]);
79
80
  /* Trickery to stay under number of children possible in a node */
81
499518
  NodeManager* nodeManager = NodeManager::currentNM();
82
499518
  if (childList.size() < expr::NodeValue::MAX_CHILDREN)
83
  {
84
999036
    Node retNode = nodeManager->mkNode(k, childList);
85
499518
    return RewriteResponse(REWRITE_DONE, retNode);
86
  }
87
  else
88
  {
89
    Assert(childList.size()
90
           < static_cast<size_t>(expr::NodeValue::MAX_CHILDREN)
91
                 * static_cast<size_t>(expr::NodeValue::MAX_CHILDREN));
92
    NodeBuilder nb(k);
93
    ChildList::iterator cur = childList.begin(), next, en = childList.end();
94
    while (cur != en)
95
    {
96
      next = min(cur + expr::NodeValue::MAX_CHILDREN, en);
97
      nb << (nodeManager->mkNode(k, ChildList(cur, next)));
98
      cur = next;
99
    }
100
    return RewriteResponse(REWRITE_DONE, nb.constructNode());
101
  }
102
}
103
104
// Equality parity returns
105
// * 0 if no relation between a and b is found
106
// * 1 if a == b
107
// * 2 if a == not(b)
108
// * 3 or b == not(a)
109
4623692
inline int equalityParity(TNode a, TNode b){
110
4623692
  if(a == b){
111
10422
    return 1;
112
4613270
  }else if(a.getKind() == kind::NOT && a[0] == b){
113
144
    return 2;
114
4613126
  }else if(b.getKind() == kind::NOT && b[0] == a){
115
1044
    return 3;
116
  }else{
117
4612082
    return 0;
118
  }
119
}
120
121
153139
inline Node makeNegation(TNode n){
122
153139
  bool even = false;
123
176753
  while(n.getKind() == kind::NOT){
124
11807
    n = n[0];
125
11807
    even = !even;
126
  }
127
153139
  if(even){
128
11355
    return n;
129
  } else {
130
141784
    if(n.isConst()){
131
2491
      return NodeManager::currentNM()->mkConst(!n.getConst<bool>());
132
    }else{
133
139293
      return n.notNode();
134
    }
135
  }
136
}
137
138
18220096
RewriteResponse TheoryBoolRewriter::preRewrite(TNode n) {
139
18220096
  NodeManager* nodeManager = NodeManager::currentNM();
140
36440192
  Node tt = nodeManager->mkConst(true);
141
36440192
  Node ff = nodeManager->mkConst(false);
142
143
18220096
  switch(n.getKind()) {
144
3550645
  case kind::NOT: {
145
3550645
    if (n[0] == tt) return RewriteResponse(REWRITE_DONE, ff);
146
3477838
    if (n[0] == ff) return RewriteResponse(REWRITE_DONE, tt);
147
3427322
    if (n[0].getKind() == kind::NOT) return RewriteResponse(REWRITE_AGAIN, n[0][0]);
148
3283077
    break;
149
  }
150
4470356
  case kind::OR: {
151
4470356
    bool done = true;
152
4470356
    TNode::iterator i = n.begin(), iend = n.end();
153
30568446
    for(; i != iend; ++i) {
154
13106439
      if (*i == tt) return RewriteResponse(REWRITE_DONE, tt);
155
13049045
      if (*i == ff) done = false;
156
13049045
      if ((*i).getKind() == kind::OR) done = false;
157
    }
158
4412962
    if (!done) {
159
291053
      return flattenNode(n, /* trivialNode = */ tt, /* skipNode = */ ff);
160
    }
161
    // x v ... v x --> x
162
    unsigned ind, size;
163
4129622
    for (ind = 0, size = n.getNumChildren(); ind < size - 1; ++ind)
164
    {
165
4126249
      if (n[ind] != n[ind+1])
166
      {
167
4118536
        break;
168
      }
169
    }
170
4121909
    if (ind == size - 1)
171
    {
172
3373
      return RewriteResponse(REWRITE_AGAIN, n[0]);
173
    }
174
4118536
    break;
175
  }
176
4478170
  case kind::AND: {
177
4478170
    bool done = true;
178
4478170
    TNode::iterator i = n.begin(), iend = n.end();
179
57506500
    for(; i != iend; ++i) {
180
26709137
      if (*i == ff) return RewriteResponse(REWRITE_DONE, ff);
181
26514165
      if (*i == tt) done = false;
182
26514165
      if ((*i).getKind() == kind::AND) done = false;
183
    }
184
4283198
    if (!done) {
185
921368
      RewriteResponse ret = flattenNode(n, /* trivialNode = */ ff, /* skipNode = */ tt);
186
460684
      Debug("bool-flatten") << n << ": " << ret.d_node << std::endl;
187
460684
      return ret;
188
    }
189
    // x ^ ... ^ x --> x
190
    unsigned ind, size;
191
3833325
    for (ind = 0, size = n.getNumChildren(); ind < size - 1; ++ind)
192
    {
193
3828518
      if (n[ind] != n[ind+1])
194
      {
195
3817707
        break;
196
      }
197
    }
198
3822514
    if (ind == size - 1)
199
    {
200
4807
      return RewriteResponse(REWRITE_AGAIN, n[0]);
201
    }
202
3817707
    break;
203
  }
204
502972
  case kind::IMPLIES: {
205
502972
    if (n[0] == ff || n[1] == tt) return RewriteResponse(REWRITE_DONE, tt);
206
500078
    if (n[0] == tt && n[1] == ff) return RewriteResponse(REWRITE_DONE, ff);
207
499970
    if (n[0] == tt) return RewriteResponse(REWRITE_AGAIN, n[1]);
208
490093
    if (n[1] == ff) return RewriteResponse(REWRITE_AGAIN, makeNegation(n[0]));
209
469533
    break;
210
  }
211
1580167
  case kind::EQUAL: {
212
    // rewrite simple cases of IFF
213
1580167
    if(n[0] == tt) {
214
      // IFF true x
215
10886
      return RewriteResponse(REWRITE_AGAIN, n[1]);
216
1569281
    } else if(n[1] == tt) {
217
      // IFF x true
218
29332
      return RewriteResponse(REWRITE_AGAIN, n[0]);
219
1539949
    } else if(n[0] == ff) {
220
      // IFF false x
221
36027
      return RewriteResponse(REWRITE_AGAIN, makeNegation(n[1]));
222
1503922
    } else if(n[1] == ff) {
223
      // IFF x false
224
73699
      return RewriteResponse(REWRITE_AGAIN, makeNegation(n[0]));
225
1430223
    } else if(n[0] == n[1]) {
226
      // IFF x x
227
27470
      return RewriteResponse(REWRITE_DONE, tt);
228
1402753
    } else if(n[0].getKind() == kind::NOT && n[0][0] == n[1]) {
229
      // IFF (NOT x) x
230
779
      return RewriteResponse(REWRITE_DONE, ff);
231
1401974
    } else if(n[1].getKind() == kind::NOT && n[1][0] == n[0]) {
232
      // IFF x (NOT x)
233
156
      return RewriteResponse(REWRITE_DONE, ff);
234
1401818
    } else if(n[0].getKind() == kind::EQUAL && n[1].getKind() == kind::EQUAL) {
235
      // a : (= i x)
236
      // i : (= j k)
237
      // x : (= y z)
238
239
      // assume wlog k, z are constants and j is the same symbol as y
240
      // (iff (= j k) (= j z))
241
      // if k = z
242
      //  then (iff (= j k) (= j k)) => true
243
      // else
244
      //  (iff (= j k) (= j z)) <=> b
245
      //  b : (and (not (= j k)) (not (= j z)))
246
      //  (= j k) (= j z) | a b
247
      //  f       f       | t t
248
      //  f       t       | f f
249
      //  t       f       | f f
250
      //  t       t       | * f
251
      // * j cannot equal both k and z in a theory model
252
27876
      TNode t,c;
253
13946
      if (n[0][0].isConst()) {
254
814
        c = n[0][0];
255
814
        t = n[0][1];
256
      }
257
13132
      else if (n[0][1].isConst()) {
258
2337
        c = n[0][1];
259
2337
        t = n[0][0];
260
      }
261
13946
      bool matchesForm = false;
262
13946
      bool constantsEqual = false;
263
13946
      if (!c.isNull()) {
264
3151
        if (n[1][0] == t && n[1][1].isConst()) {
265
8
          matchesForm = true;
266
8
          constantsEqual = (n[1][1] == c);
267
        }
268
3143
        else if (n[1][1] == t && n[1][0].isConst()) {
269
8
          matchesForm = true;
270
8
          constantsEqual = (n[1][0] == c);
271
        }
272
      }
273
13946
      if(matchesForm){
274
16
        if(constantsEqual){
275
1
          return RewriteResponse(REWRITE_DONE, tt);
276
        }else{
277
30
          Cardinality kappa = t.getType().getCardinality();
278
30
          Cardinality two(2l);
279
15
          if(kappa.knownLessThanOrEqual(two)){
280
2
            return RewriteResponse(REWRITE_DONE, ff);
281
          }else{
282
26
            Node neitherEquality = (makeNegation(n[0])).andNode(makeNegation(n[1]));
283
13
            return RewriteResponse(REWRITE_AGAIN, neitherEquality);
284
          }
285
        }
286
      }
287
    }
288
1401802
    break;
289
  }
290
1176018
  case kind::XOR: {
291
    // rewrite simple cases of XOR
292
1176018
    if(n[0] == tt) {
293
      // XOR true x
294
4236
      return RewriteResponse(REWRITE_AGAIN, makeNegation(n[1]));
295
1171782
    } else if(n[1] == tt) {
296
      // XOR x true
297
14617
      return RewriteResponse(REWRITE_AGAIN, makeNegation(n[0]));
298
1157165
    } else if(n[0] == ff) {
299
      // XOR false x
300
35158
      return RewriteResponse(REWRITE_AGAIN, n[1]);
301
1122007
    } else if(n[1] == ff) {
302
      // XOR x false
303
113836
      return RewriteResponse(REWRITE_AGAIN, n[0]);
304
1008171
    } else if(n[0] == n[1]) {
305
      // XOR x x
306
1276
      return RewriteResponse(REWRITE_DONE, ff);
307
1006895
    } else if(n[0].getKind() == kind::NOT && n[0][0] == n[1]) {
308
      // XOR (NOT x) x
309
36
      return RewriteResponse(REWRITE_DONE, tt);
310
1006859
    } else if(n[1].getKind() == kind::NOT && n[1][0] == n[0]) {
311
      // XOR x (NOT x)
312
151
      return RewriteResponse(REWRITE_DONE, tt);
313
    }
314
1006708
    break;
315
  }
316
1853002
  case kind::ITE: {
317
    // non-Boolean-valued ITEs should have been removed in place of
318
    // a variable
319
    // rewrite simple cases of ITE
320
1853002
    if (n[0].isConst()) {
321
244971
      if (n[0] == tt) {
322
        // ITE true x y
323
28412
        Debug("bool-ite") << "TheoryBoolRewriter::preRewrite_ITE: n[0] ==tt "
324
14206
                          << n << ": " << n[1] << std::endl;
325
14206
        return RewriteResponse(REWRITE_AGAIN, n[1]);
326
      } else {
327
230765
        Assert(n[0] == ff);
328
        // ITE false x y
329
461530
        Debug("bool-ite") << "TheoryBoolRewriter::preRewrite_ITE: n[0] ==ff "
330
230765
                          << n << ": " << n[1] << std::endl;
331
230765
        return RewriteResponse(REWRITE_AGAIN, n[2]);
332
      }
333
1608031
    } else if (n[1].isConst()) {
334
422208
      if (n[1] == tt && n[2] == ff) {
335
9566
        Debug("bool-ite")
336
4783
            << "TheoryBoolRewriter::preRewrite_ITE: n[1] ==tt && n[2] == ff "
337
4783
            << n << ": " << n[0] << std::endl;
338
4783
        return RewriteResponse(REWRITE_AGAIN, n[0]);
339
      }
340
417425
      else if (n[1] == ff && n[2] == tt) {
341
7948
        Debug("bool-ite")
342
3974
            << "TheoryBoolRewriter::preRewrite_ITE: n[1] ==ff && n[2] == tt "
343
3974
            << n << ": " << n[0].notNode() << std::endl;
344
3974
        return RewriteResponse(REWRITE_AGAIN, makeNegation(n[0]));
345
      }
346
413451
      if (n[1] == tt || n[1] == ff)
347
      {
348
        // ITE C true y --> C v y
349
        // ITE C false y --> ~C ^ y
350
        Node resp =
351
228602
            n[1] == tt ? n[0].orNode(n[2]) : (n[0].negate()).andNode(n[2]);
352
228602
        Debug("bool-ite") << "TheoryBoolRewriter::preRewrite_ITE: n[1] const "
353
114301
                          << n << ": " << resp << std::endl;
354
114301
        return RewriteResponse(REWRITE_AGAIN, resp);
355
      }
356
    }
357
358
1484973
    if (n[0].getKind() == kind::NOT)
359
    {
360
      // ite(not(c), x, y) ---> ite(c, y, x)
361
      return RewriteResponse(
362
81670
          REWRITE_AGAIN, nodeManager->mkNode(kind::ITE, n[0][0], n[2], n[1]));
363
    }
364
365
1403303
    if (n[2].isConst() && (n[2] == tt || n[2] == ff))
366
    {
367
      // ITE C x true --> ~C v x
368
      // ITE C x false --> C ^ x
369
      Node resp =
370
52020
          n[2] == tt ? (n[0].negate()).orNode(n[1]) : n[0].andNode(n[1]);
371
52020
      Debug("bool-ite") << "TheoryBoolRewriter::preRewrite_ITE: n[2] const "
372
26010
                        << n << ": " << resp << std::endl;
373
26010
      return RewriteResponse(REWRITE_AGAIN, resp);
374
    }
375
376
    int parityTmp;
377
1377293
    if ((parityTmp = equalityParity(n[1], n[2])) != 0) {
378
13234
      Node resp = (parityTmp == 1) ? (Node)n[1] : n[0].eqNode(n[1]);
379
13234
      Debug("bool-ite")
380
6617
          << "TheoryBoolRewriter::preRewrite_ITE:  equalityParity n[1], n[2] "
381
6617
          << parityTmp << " " << n << ": " << resp << std::endl;
382
6617
      return RewriteResponse(REWRITE_AGAIN, resp);
383
    // Curiously, this rewrite affects several benchmarks dramatically, including copy_array and some simple_startup - disable for now
384
    // } else if (n[0].getKind() == kind::NOT) {
385
    //   return RewriteResponse(REWRITE_AGAIN, n[0][0].iteNode(n[2], n[1]));
386
1370676
    } else if(!n[1].isConst() && (parityTmp = equalityParity(n[0], n[1])) != 0){
387
      // (parityTmp == 1) if n[0] == n[1]
388
      // otherwise, n[0] == not(n[1]) or not(n[0]) == n[1]
389
390
      // if n[1] is constant this can loop, this is possible in prewrite
391
550
      Node resp = n[0].iteNode( (parityTmp == 1) ? tt : ff, n[2]);
392
550
      Debug("bool-ite")
393
275
          << "TheoryBoolRewriter::preRewrite_ITE: equalityParity n[0], n[1] "
394
275
          << parityTmp << " " << n << ": " << resp << std::endl;
395
275
      return RewriteResponse(REWRITE_AGAIN, resp);
396
1370401
    } else if(!n[2].isConst() && (parityTmp = equalityParity(n[0], n[2])) != 0){
397
      // (parityTmp == 1) if n[0] == n[2]
398
      // otherwise, n[0] == not(n[2]) or not(n[0]) == n[2]
399
688
      Node resp = n[0].iteNode(n[1], (parityTmp == 1) ? ff : tt);
400
688
      Debug("bool-ite")
401
344
          << "TheoryBoolRewriter::preRewrite_ITE: equalityParity n[0], n[2] "
402
344
          << parityTmp << " " << n << ": " << resp << std::endl;
403
344
      return RewriteResponse(REWRITE_AGAIN, resp);
404
3917539
    } else if(n[1].getKind() == kind::ITE &&
405
2547482
              (parityTmp = equalityParity(n[0], n[1][0])) != 0){
406
      // (parityTmp == 1) then n : (ite c (ite c x y) z)
407
      // (parityTmp > 1)  then n : (ite c (ite (not c) x y) z) or
408
      // n: (ite (not c) (ite c x y) z)
409
5256
      Node resp = n[0].iteNode((parityTmp == 1) ? n[1][1] : n[1][2], n[2]);
410
5256
      Debug("bool-ite")
411
2628
          << "TheoryBoolRewriter::preRewrite: equalityParity n[0], n[1][0] "
412
2628
          << parityTmp << " " << n << ": " << resp << std::endl;
413
2628
      return RewriteResponse(REWRITE_AGAIN, resp);
414
4440658
    } else if(n[2].getKind() == kind::ITE &&
415
3073229
              (parityTmp = equalityParity(n[0], n[2][0])) != 0){
416
      // (parityTmp == 1) then n : (ite c x (ite c y z))
417
      // (parityTmp > 1)  then n : (ite c x (ite (not c) y z)) or
418
      // n: (ite (not c) x (ite c y z))
419
3492
      Node resp = n[0].iteNode(n[1], (parityTmp == 1) ? n[2][2] : n[2][1]);
420
3492
      Debug("bool-ite")
421
1746
          << "TheoryBoolRewriter::preRewrite: equalityParity n[0], n[2][0] "
422
1746
          << parityTmp << " " << n << ": " << resp << std::endl;
423
1746
      return RewriteResponse(REWRITE_AGAIN, resp);
424
    }
425
1365683
    break;
426
  }
427
608766
  default:
428
608766
    return RewriteResponse(REWRITE_DONE, n);
429
  }
430
15463046
  return RewriteResponse(REWRITE_DONE, n);
431
}
432
433
}  // namespace booleans
434
}  // namespace theory
435
27735
}  // namespace cvc5