/
Context.cs
5111 lines (4467 loc) · 196 KB
/
Context.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*++
Copyright (c) 2012 Microsoft Corporation
Module Name:
Context.cs
Abstract:
Z3 Managed API: Context
Author:
Christoph Wintersteiger (cwinter) 2012-03-15
Notes:
--*/
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using System.Diagnostics.Contracts;
using System.Linq;
namespace Microsoft.Z3
{
/// <summary>
/// The main interaction with Z3 happens via the Context.
/// </summary>
[ContractVerification(true)]
public class Context : IDisposable
{
#region Constructors
/// <summary>
/// Constructor.
/// </summary>
public Context()
: base()
{
lock (creation_lock)
{
m_ctx = Native.Z3_mk_context_rc(IntPtr.Zero);
InitContext();
}
}
/// <summary>
/// Constructor.
/// </summary>
/// <remarks>
/// The following parameters can be set:
/// - proof (Boolean) Enable proof generation
/// - debug_ref_count (Boolean) Enable debug support for Z3_ast reference counting
/// - trace (Boolean) Tracing support for VCC
/// - trace_file_name (String) Trace out file for VCC traces
/// - timeout (unsigned) default timeout (in milliseconds) used for solvers
/// - well_sorted_check type checker
/// - auto_config use heuristics to automatically select solver and configure it
/// - model model generation for solvers, this parameter can be overwritten when creating a solver
/// - model_validate validate models produced by solvers
/// - unsat_core unsat-core generation for solvers, this parameter can be overwritten when creating a solver
/// Note that in previous versions of Z3, this constructor was also used to set global and module parameters.
/// For this purpose we should now use <see cref="Global.SetParameter"/>
/// </remarks>
public Context(Dictionary<string, string> settings)
: base()
{
Contract.Requires(settings != null);
lock (creation_lock)
{
IntPtr cfg = Native.Z3_mk_config();
foreach (KeyValuePair<string, string> kv in settings)
Native.Z3_set_param_value(cfg, kv.Key, kv.Value);
m_ctx = Native.Z3_mk_context_rc(cfg);
Native.Z3_del_config(cfg);
InitContext();
}
}
#endregion
#region Symbols
/// <summary>
/// Creates a new symbol using an integer.
/// </summary>
/// <remarks>
/// Not all integers can be passed to this function.
/// The legal range of unsigned integers is 0 to 2^30-1.
/// </remarks>
public IntSymbol MkSymbol(int i)
{
Contract.Ensures(Contract.Result<IntSymbol>() != null);
return new IntSymbol(this, i);
}
/// <summary>
/// Create a symbol using a string.
/// </summary>
public StringSymbol MkSymbol(string name)
{
Contract.Ensures(Contract.Result<StringSymbol>() != null);
return new StringSymbol(this, name);
}
/// <summary>
/// Create an array of symbols.
/// </summary>
internal Symbol[] MkSymbols(string[] names)
{
Contract.Ensures(names == null || Contract.Result<Symbol[]>() != null);
Contract.Ensures(names != null || Contract.Result<Symbol[]>() == null);
Contract.Ensures(Contract.Result<Symbol[]>() == null || Contract.Result<Symbol[]>().Length == names.Length);
Contract.Ensures(Contract.Result<Symbol[]>() == null || Contract.ForAll(Contract.Result<Symbol[]>(), s => s != null));
if (names == null) return null;
Symbol[] result = new Symbol[names.Length];
for (int i = 0; i < names.Length; ++i) result[i] = MkSymbol(names[i]);
return result;
}
#endregion
#region Sorts
private BoolSort m_boolSort = null;
private IntSort m_intSort = null;
private RealSort m_realSort = null;
private SeqSort m_stringSort = null;
/// <summary>
/// Retrieves the Boolean sort of the context.
/// </summary>
public BoolSort BoolSort
{
get
{
Contract.Ensures(Contract.Result<BoolSort>() != null);
if (m_boolSort == null) m_boolSort = new BoolSort(this); return m_boolSort;
}
}
/// <summary>
/// Retrieves the Integer sort of the context.
/// </summary>
public IntSort IntSort
{
get
{
Contract.Ensures(Contract.Result<IntSort>() != null);
if (m_intSort == null) m_intSort = new IntSort(this); return m_intSort;
}
}
/// <summary>
/// Retrieves the Real sort of the context.
/// </summary>
public RealSort RealSort
{
get
{
Contract.Ensures(Contract.Result<RealSort>() != null);
if (m_realSort == null) m_realSort = new RealSort(this); return m_realSort;
}
}
/// <summary>
/// Retrieves the String sort of the context.
/// </summary>
public SeqSort StringSort
{
get
{
Contract.Ensures(Contract.Result<SeqSort>() != null);
if (m_stringSort == null) m_stringSort = new SeqSort(this, Native.Z3_mk_string_sort(nCtx));
return m_stringSort;
}
}
/// <summary>
/// Create a new Boolean sort.
/// </summary>
public BoolSort MkBoolSort()
{
Contract.Ensures(Contract.Result<BoolSort>() != null);
return new BoolSort(this);
}
/// <summary>
/// Create a new uninterpreted sort.
/// </summary>
public UninterpretedSort MkUninterpretedSort(Symbol s)
{
Contract.Requires(s != null);
Contract.Ensures(Contract.Result<UninterpretedSort>() != null);
CheckContextMatch(s);
return new UninterpretedSort(this, s);
}
/// <summary>
/// Create a new uninterpreted sort.
/// </summary>
public UninterpretedSort MkUninterpretedSort(string str)
{
Contract.Ensures(Contract.Result<UninterpretedSort>() != null);
return MkUninterpretedSort(MkSymbol(str));
}
/// <summary>
/// Create a new integer sort.
/// </summary>
public IntSort MkIntSort()
{
Contract.Ensures(Contract.Result<IntSort>() != null);
return new IntSort(this);
}
/// <summary>
/// Create a real sort.
/// </summary>
public RealSort MkRealSort()
{
Contract.Ensures(Contract.Result<RealSort>() != null);
return new RealSort(this);
}
/// <summary>
/// Create a new bit-vector sort.
/// </summary>
public BitVecSort MkBitVecSort(uint size)
{
Contract.Ensures(Contract.Result<BitVecSort>() != null);
return new BitVecSort(this, Native.Z3_mk_bv_sort(nCtx, size));
}
/// <summary>
/// Create a new sequence sort.
/// </summary>
public SeqSort MkSeqSort(Sort s)
{
Contract.Requires(s != null);
Contract.Ensures(Contract.Result<SeqSort>() != null);
return new SeqSort(this, Native.Z3_mk_seq_sort(nCtx, s.NativeObject));
}
/// <summary>
/// Create a new regular expression sort.
/// </summary>
public ReSort MkReSort(SeqSort s)
{
Contract.Requires(s != null);
Contract.Ensures(Contract.Result<ReSort>() != null);
return new ReSort(this, Native.Z3_mk_re_sort(nCtx, s.NativeObject));
}
/// <summary>
/// Create a new array sort.
/// </summary>
public ArraySort MkArraySort(Sort domain, Sort range)
{
Contract.Requires(domain != null);
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<ArraySort>() != null);
CheckContextMatch(domain);
CheckContextMatch(range);
return new ArraySort(this, domain, range);
}
/// <summary>
/// Create a new n-ary array sort.
/// </summary>
public ArraySort MkArraySort(Sort[] domain, Sort range)
{
Contract.Requires(domain != null);
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<ArraySort>() != null);
CheckContextMatch<Sort>(domain);
CheckContextMatch(range);
return new ArraySort(this, domain, range);
}
/// <summary>
/// Create a new tuple sort.
/// </summary>
public TupleSort MkTupleSort(Symbol name, Symbol[] fieldNames, Sort[] fieldSorts)
{
Contract.Requires(name != null);
Contract.Requires(fieldNames != null);
Contract.Requires(Contract.ForAll(fieldNames, fn => fn != null));
Contract.Requires(fieldSorts == null || Contract.ForAll(fieldSorts, fs => fs != null));
Contract.Ensures(Contract.Result<TupleSort>() != null);
CheckContextMatch(name);
CheckContextMatch<Symbol>(fieldNames);
CheckContextMatch<Sort>(fieldSorts);
return new TupleSort(this, name, (uint)fieldNames.Length, fieldNames, fieldSorts);
}
/// <summary>
/// Create a new enumeration sort.
/// </summary>
public EnumSort MkEnumSort(Symbol name, params Symbol[] enumNames)
{
Contract.Requires(name != null);
Contract.Requires(enumNames != null);
Contract.Requires(Contract.ForAll(enumNames, f => f != null));
Contract.Ensures(Contract.Result<EnumSort>() != null);
CheckContextMatch(name);
CheckContextMatch<Symbol>(enumNames);
return new EnumSort(this, name, enumNames);
}
/// <summary>
/// Create a new enumeration sort.
/// </summary>
public EnumSort MkEnumSort(string name, params string[] enumNames)
{
Contract.Requires(enumNames != null);
Contract.Ensures(Contract.Result<EnumSort>() != null);
return new EnumSort(this, MkSymbol(name), MkSymbols(enumNames));
}
/// <summary>
/// Create a new list sort.
/// </summary>
public ListSort MkListSort(Symbol name, Sort elemSort)
{
Contract.Requires(name != null);
Contract.Requires(elemSort != null);
Contract.Ensures(Contract.Result<ListSort>() != null);
CheckContextMatch(name);
CheckContextMatch(elemSort);
return new ListSort(this, name, elemSort);
}
/// <summary>
/// Create a new list sort.
/// </summary>
public ListSort MkListSort(string name, Sort elemSort)
{
Contract.Requires(elemSort != null);
Contract.Ensures(Contract.Result<ListSort>() != null);
CheckContextMatch(elemSort);
return new ListSort(this, MkSymbol(name), elemSort);
}
/// <summary>
/// Create a new finite domain sort.
/// <returns>The result is a sort</returns>
/// </summary>
/// <param name="name">The name used to identify the sort</param>
/// <param name="size">The size of the sort</param>
public FiniteDomainSort MkFiniteDomainSort(Symbol name, ulong size)
{
Contract.Requires(name != null);
Contract.Ensures(Contract.Result<FiniteDomainSort>() != null);
CheckContextMatch(name);
return new FiniteDomainSort(this, name, size);
}
/// <summary>
/// Create a new finite domain sort.
/// <returns>The result is a sort</returns>
/// Elements of the sort are created using <seealso cref="MkNumeral(ulong, Sort)"/>,
/// and the elements range from 0 to <tt>size-1</tt>.
/// </summary>
/// <param name="name">The name used to identify the sort</param>
/// <param name="size">The size of the sort</param>
public FiniteDomainSort MkFiniteDomainSort(string name, ulong size)
{
Contract.Ensures(Contract.Result<FiniteDomainSort>() != null);
return new FiniteDomainSort(this, MkSymbol(name), size);
}
#region Datatypes
/// <summary>
/// Create a datatype constructor.
/// </summary>
/// <param name="name">constructor name</param>
/// <param name="recognizer">name of recognizer function.</param>
/// <param name="fieldNames">names of the constructor fields.</param>
/// <param name="sorts">field sorts, 0 if the field sort refers to a recursive sort.</param>
/// <param name="sortRefs">reference to datatype sort that is an argument to the constructor;
/// if the corresponding sort reference is 0, then the value in sort_refs should be an index
/// referring to one of the recursive datatypes that is declared.</param>
public Constructor MkConstructor(Symbol name, Symbol recognizer, Symbol[] fieldNames = null, Sort[] sorts = null, uint[] sortRefs = null)
{
Contract.Requires(name != null);
Contract.Requires(recognizer != null);
Contract.Ensures(Contract.Result<Constructor>() != null);
return new Constructor(this, name, recognizer, fieldNames, sorts, sortRefs);
}
/// <summary>
/// Create a datatype constructor.
/// </summary>
/// <param name="name"></param>
/// <param name="recognizer"></param>
/// <param name="fieldNames"></param>
/// <param name="sorts"></param>
/// <param name="sortRefs"></param>
/// <returns></returns>
public Constructor MkConstructor(string name, string recognizer, string[] fieldNames = null, Sort[] sorts = null, uint[] sortRefs = null)
{
Contract.Ensures(Contract.Result<Constructor>() != null);
return new Constructor(this, MkSymbol(name), MkSymbol(recognizer), MkSymbols(fieldNames), sorts, sortRefs);
}
/// <summary>
/// Create a new datatype sort.
/// </summary>
public DatatypeSort MkDatatypeSort(Symbol name, Constructor[] constructors)
{
Contract.Requires(name != null);
Contract.Requires(constructors != null);
Contract.Requires(Contract.ForAll(constructors, c => c != null));
Contract.Ensures(Contract.Result<DatatypeSort>() != null);
CheckContextMatch(name);
CheckContextMatch<Constructor>(constructors);
return new DatatypeSort(this, name, constructors);
}
/// <summary>
/// Create a new datatype sort.
/// </summary>
public DatatypeSort MkDatatypeSort(string name, Constructor[] constructors)
{
Contract.Requires(constructors != null);
Contract.Requires(Contract.ForAll(constructors, c => c != null));
Contract.Ensures(Contract.Result<DatatypeSort>() != null);
CheckContextMatch<Constructor>(constructors);
return new DatatypeSort(this, MkSymbol(name), constructors);
}
/// <summary>
/// Create mutually recursive datatypes.
/// </summary>
/// <param name="names">names of datatype sorts</param>
/// <param name="c">list of constructors, one list per sort.</param>
public DatatypeSort[] MkDatatypeSorts(Symbol[] names, Constructor[][] c)
{
Contract.Requires(names != null);
Contract.Requires(c != null);
Contract.Requires(names.Length == c.Length);
Contract.Requires(Contract.ForAll(0, c.Length, j => c[j] != null));
Contract.Requires(Contract.ForAll(names, name => name != null));
Contract.Ensures(Contract.Result<DatatypeSort[]>() != null);
CheckContextMatch<Symbol>(names);
uint n = (uint)names.Length;
ConstructorList[] cla = new ConstructorList[n];
IntPtr[] n_constr = new IntPtr[n];
for (uint i = 0; i < n; i++)
{
Constructor[] constructor = c[i];
Contract.Assume(Contract.ForAll(constructor, arr => arr != null), "Clousot does not support yet quantified formula on multidimensional arrays");
CheckContextMatch<Constructor>(constructor);
cla[i] = new ConstructorList(this, constructor);
n_constr[i] = cla[i].NativeObject;
}
IntPtr[] n_res = new IntPtr[n];
Native.Z3_mk_datatypes(nCtx, n, Symbol.ArrayToNative(names), n_res, n_constr);
DatatypeSort[] res = new DatatypeSort[n];
for (uint i = 0; i < n; i++)
res[i] = new DatatypeSort(this, n_res[i]);
return res;
}
/// <summary>
/// Create mutually recursive data-types.
/// </summary>
/// <param name="names"></param>
/// <param name="c"></param>
/// <returns></returns>
public DatatypeSort[] MkDatatypeSorts(string[] names, Constructor[][] c)
{
Contract.Requires(names != null);
Contract.Requires(c != null);
Contract.Requires(names.Length == c.Length);
Contract.Requires(Contract.ForAll(0, c.Length, j => c[j] != null));
Contract.Requires(Contract.ForAll(names, name => name != null));
Contract.Ensures(Contract.Result<DatatypeSort[]>() != null);
return MkDatatypeSorts(MkSymbols(names), c);
}
/// <summary>
/// Update a datatype field at expression t with value v.
/// The function performs a record update at t. The field
/// that is passed in as argument is updated with value v,
/// the remainig fields of t are unchanged.
/// </summary>
public Expr MkUpdateField(FuncDecl field, Expr t, Expr v)
{
return Expr.Create(this, Native.Z3_datatype_update_field(
nCtx, field.NativeObject,
t.NativeObject, v.NativeObject));
}
#endregion
#endregion
#region Function Declarations
/// <summary>
/// Creates a new function declaration.
/// </summary>
public FuncDecl MkFuncDecl(Symbol name, Sort[] domain, Sort range)
{
Contract.Requires(name != null);
Contract.Requires(range != null);
Contract.Requires(Contract.ForAll(domain, d => d != null));
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch(name);
CheckContextMatch<Sort>(domain);
CheckContextMatch(range);
return new FuncDecl(this, name, domain, range);
}
/// <summary>
/// Creates a new function declaration.
/// </summary>
public FuncDecl MkFuncDecl(Symbol name, Sort domain, Sort range)
{
Contract.Requires(name != null);
Contract.Requires(domain != null);
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch(name);
CheckContextMatch(domain);
CheckContextMatch(range);
Sort[] q = new Sort[] { domain };
return new FuncDecl(this, name, q, range);
}
/// <summary>
/// Creates a new function declaration.
/// </summary>
public FuncDecl MkFuncDecl(string name, Sort[] domain, Sort range)
{
Contract.Requires(range != null);
Contract.Requires(Contract.ForAll(domain, d => d != null));
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch<Sort>(domain);
CheckContextMatch(range);
return new FuncDecl(this, MkSymbol(name), domain, range);
}
/// <summary>
/// Creates a new function declaration.
/// </summary>
public FuncDecl MkFuncDecl(string name, Sort domain, Sort range)
{
Contract.Requires(range != null);
Contract.Requires(domain != null);
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch(domain);
CheckContextMatch(range);
Sort[] q = new Sort[] { domain };
return new FuncDecl(this, MkSymbol(name), q, range);
}
/// <summary>
/// Creates a fresh function declaration with a name prefixed with <paramref name="prefix"/>.
/// </summary>
/// <seealso cref="MkFuncDecl(string,Sort,Sort)"/>
/// <seealso cref="MkFuncDecl(string,Sort[],Sort)"/>
public FuncDecl MkFreshFuncDecl(string prefix, Sort[] domain, Sort range)
{
Contract.Requires(range != null);
Contract.Requires(Contract.ForAll(domain, d => d != null));
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch<Sort>(domain);
CheckContextMatch(range);
return new FuncDecl(this, prefix, domain, range);
}
/// <summary>
/// Creates a new constant function declaration.
/// </summary>
public FuncDecl MkConstDecl(Symbol name, Sort range)
{
Contract.Requires(name != null);
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch(name);
CheckContextMatch(range);
return new FuncDecl(this, name, null, range);
}
/// <summary>
/// Creates a new constant function declaration.
/// </summary>
public FuncDecl MkConstDecl(string name, Sort range)
{
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch(range);
return new FuncDecl(this, MkSymbol(name), null, range);
}
/// <summary>
/// Creates a fresh constant function declaration with a name prefixed with <paramref name="prefix"/>.
/// </summary>
/// <seealso cref="MkFuncDecl(string,Sort,Sort)"/>
/// <seealso cref="MkFuncDecl(string,Sort[],Sort)"/>
public FuncDecl MkFreshConstDecl(string prefix, Sort range)
{
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<FuncDecl>() != null);
CheckContextMatch(range);
return new FuncDecl(this, prefix, null, range);
}
#endregion
#region Bound Variables
/// <summary>
/// Creates a new bound variable.
/// </summary>
/// <param name="index">The de-Bruijn index of the variable</param>
/// <param name="ty">The sort of the variable</param>
public Expr MkBound(uint index, Sort ty)
{
Contract.Requires(ty != null);
Contract.Ensures(Contract.Result<Expr>() != null);
return Expr.Create(this, Native.Z3_mk_bound(nCtx, index, ty.NativeObject));
}
#endregion
#region Quantifier Patterns
/// <summary>
/// Create a quantifier pattern.
/// </summary>
public Pattern MkPattern(params Expr[] terms)
{
Contract.Requires(terms != null);
if (terms.Length == 0)
throw new Z3Exception("Cannot create a pattern from zero terms");
Contract.Ensures(Contract.Result<Pattern>() != null);
Contract.EndContractBlock();
IntPtr[] termsNative = AST.ArrayToNative(terms);
return new Pattern(this, Native.Z3_mk_pattern(nCtx, (uint)terms.Length, termsNative));
}
#endregion
#region Constants
/// <summary>
/// Creates a new Constant of sort <paramref name="range"/> and named <paramref name="name"/>.
/// </summary>
public Expr MkConst(Symbol name, Sort range)
{
Contract.Requires(name != null);
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<Expr>() != null);
CheckContextMatch(name);
CheckContextMatch(range);
return Expr.Create(this, Native.Z3_mk_const(nCtx, name.NativeObject, range.NativeObject));
}
/// <summary>
/// Creates a new Constant of sort <paramref name="range"/> and named <paramref name="name"/>.
/// </summary>
public Expr MkConst(string name, Sort range)
{
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<Expr>() != null);
return MkConst(MkSymbol(name), range);
}
/// <summary>
/// Creates a fresh Constant of sort <paramref name="range"/> and a
/// name prefixed with <paramref name="prefix"/>.
/// </summary>
public Expr MkFreshConst(string prefix, Sort range)
{
Contract.Requires(range != null);
Contract.Ensures(Contract.Result<Expr>() != null);
CheckContextMatch(range);
return Expr.Create(this, Native.Z3_mk_fresh_const(nCtx, prefix, range.NativeObject));
}
/// <summary>
/// Creates a fresh constant from the FuncDecl <paramref name="f"/>.
/// </summary>
/// <param name="f">A decl of a 0-arity function</param>
public Expr MkConst(FuncDecl f)
{
Contract.Requires(f != null);
Contract.Ensures(Contract.Result<Expr>() != null);
return MkApp(f);
}
/// <summary>
/// Create a Boolean constant.
/// </summary>
public BoolExpr MkBoolConst(Symbol name)
{
Contract.Requires(name != null);
Contract.Ensures(Contract.Result<BoolExpr>() != null);
return (BoolExpr)MkConst(name, BoolSort);
}
/// <summary>
/// Create a Boolean constant.
/// </summary>
public BoolExpr MkBoolConst(string name)
{
Contract.Ensures(Contract.Result<BoolExpr>() != null);
return (BoolExpr)MkConst(MkSymbol(name), BoolSort);
}
/// <summary>
/// Creates an integer constant.
/// </summary>
public IntExpr MkIntConst(Symbol name)
{
Contract.Requires(name != null);
Contract.Ensures(Contract.Result<IntExpr>() != null);
return (IntExpr)MkConst(name, IntSort);
}
/// <summary>
/// Creates an integer constant.
/// </summary>
public IntExpr MkIntConst(string name)
{
Contract.Requires(name != null);
Contract.Ensures(Contract.Result<IntExpr>() != null);
return (IntExpr)MkConst(name, IntSort);
}
/// <summary>
/// Creates a real constant.
/// </summary>
public RealExpr MkRealConst(Symbol name)
{
Contract.Requires(name != null);
Contract.Ensures(Contract.Result<RealExpr>() != null);
return (RealExpr)MkConst(name, RealSort);
}
/// <summary>
/// Creates a real constant.
/// </summary>
public RealExpr MkRealConst(string name)
{
Contract.Ensures(Contract.Result<RealExpr>() != null);
return (RealExpr)MkConst(name, RealSort);
}
/// <summary>
/// Creates a bit-vector constant.
/// </summary>
public BitVecExpr MkBVConst(Symbol name, uint size)
{
Contract.Requires(name != null);
Contract.Ensures(Contract.Result<BitVecExpr>() != null);
return (BitVecExpr)MkConst(name, MkBitVecSort(size));
}
/// <summary>
/// Creates a bit-vector constant.
/// </summary>
public BitVecExpr MkBVConst(string name, uint size)
{
Contract.Ensures(Contract.Result<BitVecExpr>() != null);
return (BitVecExpr)MkConst(name, MkBitVecSort(size));
}
#endregion
#region Terms
/// <summary>
/// Create a new function application.
/// </summary>
public Expr MkApp(FuncDecl f, params Expr[] args)
{
Contract.Requires(f != null);
Contract.Requires(args == null || Contract.ForAll(args, a => a != null));
Contract.Ensures(Contract.Result<Expr>() != null);
CheckContextMatch(f);
CheckContextMatch<Expr>(args);
return Expr.Create(this, f, args);
}
/// <summary>
/// Create a new function application.
/// </summary>
public Expr MkApp(FuncDecl f, IEnumerable<Expr> args)
{
Contract.Requires(f != null);
Contract.Requires(args == null || Contract.ForAll(args, a => a != null));
Contract.Ensures(Contract.Result<Expr>() != null);
CheckContextMatch(f);
CheckContextMatch(args);
return Expr.Create(this, f, args.ToArray());
}
#region Propositional
/// <summary>
/// The true Term.
/// </summary>
public BoolExpr MkTrue()
{
Contract.Ensures(Contract.Result<BoolExpr>() != null);
return new BoolExpr(this, Native.Z3_mk_true(nCtx));
}
/// <summary>
/// The false Term.
/// </summary>
public BoolExpr MkFalse()
{
Contract.Ensures(Contract.Result<BoolExpr>() != null);
return new BoolExpr(this, Native.Z3_mk_false(nCtx));
}
/// <summary>
/// Creates a Boolean value.
/// </summary>
public BoolExpr MkBool(bool value)
{
Contract.Ensures(Contract.Result<BoolExpr>() != null);
return value ? MkTrue() : MkFalse();
}
/// <summary>
/// Creates the equality <paramref name="x"/> = <paramref name="y"/>.
/// </summary>
public BoolExpr MkEq(Expr x, Expr y)
{
Contract.Requires(x != null);
Contract.Requires(y != null);
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch(x);
CheckContextMatch(y);
return new BoolExpr(this, Native.Z3_mk_eq(nCtx, x.NativeObject, y.NativeObject));
}
/// <summary>
/// Creates a <c>distinct</c> term.
/// </summary>
public BoolExpr MkDistinct(params Expr[] args)
{
Contract.Requires(args != null);
Contract.Requires(Contract.ForAll(args, a => a != null));
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch<Expr>(args);
return new BoolExpr(this, Native.Z3_mk_distinct(nCtx, (uint)args.Length, AST.ArrayToNative(args)));
}
/// <summary>
/// Mk an expression representing <c>not(a)</c>.
/// </summary>
public BoolExpr MkNot(BoolExpr a)
{
Contract.Requires(a != null);
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch(a);
return new BoolExpr(this, Native.Z3_mk_not(nCtx, a.NativeObject));
}
/// <summary>
/// Create an expression representing an if-then-else: <c>ite(t1, t2, t3)</c>.
/// </summary>
/// <param name="t1">An expression with Boolean sort</param>
/// <param name="t2">An expression </param>
/// <param name="t3">An expression with the same sort as <paramref name="t2"/></param>
public Expr MkITE(BoolExpr t1, Expr t2, Expr t3)
{
Contract.Requires(t1 != null);
Contract.Requires(t2 != null);
Contract.Requires(t3 != null);
Contract.Ensures(Contract.Result<Expr>() != null);
CheckContextMatch(t1);
CheckContextMatch(t2);
CheckContextMatch(t3);
return Expr.Create(this, Native.Z3_mk_ite(nCtx, t1.NativeObject, t2.NativeObject, t3.NativeObject));
}
/// <summary>
/// Create an expression representing <c>t1 iff t2</c>.
/// </summary>
public BoolExpr MkIff(BoolExpr t1, BoolExpr t2)
{
Contract.Requires(t1 != null);
Contract.Requires(t2 != null);
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch(t1);
CheckContextMatch(t2);
return new BoolExpr(this, Native.Z3_mk_iff(nCtx, t1.NativeObject, t2.NativeObject));
}
/// <summary>
/// Create an expression representing <c>t1 -> t2</c>.
/// </summary>
public BoolExpr MkImplies(BoolExpr t1, BoolExpr t2)
{
Contract.Requires(t1 != null);
Contract.Requires(t2 != null);
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch(t1);
CheckContextMatch(t2);
return new BoolExpr(this, Native.Z3_mk_implies(nCtx, t1.NativeObject, t2.NativeObject));
}
/// <summary>
/// Create an expression representing <c>t1 xor t2</c>.
/// </summary>
public BoolExpr MkXor(BoolExpr t1, BoolExpr t2)
{
Contract.Requires(t1 != null);
Contract.Requires(t2 != null);
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch(t1);
CheckContextMatch(t2);
return new BoolExpr(this, Native.Z3_mk_xor(nCtx, t1.NativeObject, t2.NativeObject));
}
/// <summary>
/// Create an expression representing <c>t[0] and t[1] and ...</c>.
/// </summary>
public BoolExpr MkAnd(params BoolExpr[] t)
{
Contract.Requires(t != null);
Contract.Requires(Contract.ForAll(t, a => a != null));
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch<BoolExpr>(t);
return new BoolExpr(this, Native.Z3_mk_and(nCtx, (uint)t.Length, AST.ArrayToNative(t)));
}
/// <summary>
/// Create an expression representing <c>t[0] and t[1] and ...</c>.
/// </summary>
public BoolExpr MkAnd(IEnumerable<BoolExpr> t)
{
Contract.Requires(t != null);
Contract.Requires(Contract.ForAll(t, a => a != null));
Contract.Ensures(Contract.Result<BoolExpr>() != null);
CheckContextMatch<BoolExpr>(t);
return new BoolExpr(this, Native.Z3_mk_and(nCtx, (uint)t.Count(), AST.EnumToNative(t)));