9"""Z3 is a high performance theorem prover developed at Microsoft Research.
11Z3 is used in many applications such as: software/hardware verification and testing,
12constraint solving, analysis of hybrid systems, security, biology (in silico analysis),
13and geometrical problems.
16Please send feedback, comments and/or corrections on the Issue tracker for
17https://github.com/Z3prover/z3.git. Your comments are very valuable.
38... x = BitVec('x', 32)
40... # the expression x + y is type incorrect
42... except Z3Exception as ex:
43... print("failed: %s" % ex)
49from .z3consts
import *
50from .z3printer
import *
51from fractions
import Fraction
56if sys.version_info.major >= 3:
57 from typing
import Iterable, Iterator
59from collections.abc
import Callable
75if sys.version_info.major < 3:
77 return isinstance(v, (int, long))
80 return isinstance(v, int)
92 major = ctypes.c_uint(0)
93 minor = ctypes.c_uint(0)
94 build = ctypes.c_uint(0)
95 rev = ctypes.c_uint(0)
97 return "%s.%s.%s" % (major.value, minor.value, build.value)
101 major = ctypes.c_uint(0)
102 minor = ctypes.c_uint(0)
103 build = ctypes.c_uint(0)
104 rev = ctypes.c_uint(0)
106 return (major.value, minor.value, build.value, rev.value)
115 raise Z3Exception(msg)
119 _z3_assert(ctypes.c_int(n).value == n, name +
" is too large")
123 """Log interaction to a file. This function must be invoked immediately after init(). """
128 """Append user-defined string to interaction log. """
133 """Convert an integer or string into a Z3 symbol."""
141 """Convert a Z3 symbol back into a Python object. """
154 if len(args) == 1
and (isinstance(args[0], tuple)
or isinstance(args[0], list)):
156 elif len(args) == 1
and (isinstance(args[0], set)
or isinstance(args[0], AstVector)):
157 return [arg
for arg
in args[0]]
158 elif len(args) == 1
and isinstance(args[0], Iterator):
170 if isinstance(args, (set, AstVector, tuple)):
171 return [arg
for arg
in args]
179 if isinstance(val, bool):
180 return "true" if val
else "false"
191 """A Context manages all other Z3 objects, global configuration options, etc.
193 Z3Py uses a default global context. For most applications this is sufficient.
194 An application may use multiple Z3 contexts. Objects created in one context
195 cannot be used in another one. However, several objects may be "translated" from
196 one context to another. It is not safe to access Z3 objects from multiple threads.
197 The only exception is the method `interrupt()` that can be used to interrupt() a long
199 The initialization method receives global configuration options for the new context.
204 _z3_assert(len(args) % 2 == 0,
"Argument list must have an even number of elements.")
223 if Z3_del_context
is not None and self.
owner:
229 """Return a reference to the actual C pointer to the Z3 context."""
233 """Interrupt a solver performing a satisfiability test, a tactic processing a goal, or simplify functions.
235 This method can be invoked from a thread different from the one executing the
236 interruptible procedure.
241 """Return the global parameter description set."""
245 """Set the pretty printing mode for ASTs.
247 The following modes are available:
248 - Z3_PRINT_SMTLIB_FULL (0): Print AST nodes in SMTLIB verbose format.
249 - Z3_PRINT_LOW_LEVEL (1): Print AST nodes using a low-level format.
250 - Z3_PRINT_SMTLIB2_COMPLIANT (2): Print AST nodes in SMTLIB 2.x compliant format.
255 >>> c.set_ast_print_mode(Z3_PRINT_SMTLIB2_COMPLIANT)
267 """Return a reference to the global Z3 context.
270 >>> x.ctx == main_ctx()
275 >>> x2 = Real('x', c)
282 if _main_ctx
is None:
299 """Set Z3 global (or module) parameters.
301 >>> set_param(precision=10)
304 _z3_assert(len(args) % 2 == 0,
"Argument list must have an even number of elements.")
308 if not set_pp_option(k, v):
323 """Reset all global (or module) parameters.
329 """Alias for 'set_param' for backward compatibility.
335 """Return the value of a Z3 global (or module) parameter
337 >>> get_param('nlsat.reorder')
340 ptr = (ctypes.c_char_p * 1)()
342 r = z3core._to_pystr(ptr[0])
344 raise Z3Exception(
"failed to retrieve value for '%s'" % name)
356 """Superclass for all Z3 objects that have support for pretty printing."""
362 in_html = in_html_mode()
365 set_html_mode(in_html)
370 """AST are Direct Acyclic Graphs (DAGs) used to represent sorts, declarations and expressions."""
378 if self.
ctx.ref()
is not None and self.
ast is not None and Z3_dec_ref
is not None:
386 return obj_to_string(self)
389 return obj_to_string(self)
392 return self.
eq(other)
405 elif is_eq(self)
and self.num_args() == 2:
406 return self.arg(0).
eq(self.arg(1))
408 raise Z3Exception(
"Symbolic expressions cannot be cast to concrete Boolean values.")
411 """Return a string representing the AST node in s-expression notation.
414 >>> ((x + 1)*x).sexpr()
420 """Return a pointer to the corresponding C Z3_ast object."""
424 """Return unique identifier for object. It can be used for hash-tables and maps."""
428 """Return a reference to the C context where this AST node is stored."""
429 return self.
ctx.ref()
432 """Return `True` if `self` and `other` are structurally identical.
439 >>> n1 = simplify(n1)
440 >>> n2 = simplify(n2)
449 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
455 >>> # Nodes in different contexts can't be mixed.
456 >>> # However, we can translate nodes from one context to another.
457 >>> x.translate(c2) + y
461 _z3_assert(isinstance(target, Context),
"argument must be a Z3 context")
468 """Return a hashcode for the `self`.
470 >>> n1 = simplify(Int('x') + 1)
471 >>> n2 = simplify(2 + Int('x') - 1)
472 >>> n1.hash() == n2.hash()
478 """Return a Python value that is equivalent to `self`."""
483 """Return `True` if `a` is an AST node.
487 >>> is_ast(IntVal(10))
491 >>> is_ast(BoolSort())
493 >>> is_ast(Function('f', IntSort(), IntSort()))
500 return isinstance(a, AstRef)
503def eq(a : AstRef, b : AstRef) -> bool:
504 """Return `True` if `a` and `b` are structurally identical AST nodes.
514 >>> eq(simplify(x + 1), simplify(1 + x))
548 _args = (FuncDecl * sz)()
550 _args[i] = args[i].as_func_decl()
558 _args[i] = args[i].as_ast()
566 _args[i] = args[i].as_ast()
574 elif k == Z3_FUNC_DECL_AST:
591 """A Sort is essentially a type. Every Z3 expression has a sort. A sort is an AST node."""
600 """Return the Z3 internal kind of a sort.
601 This method can be used to test if `self` is one of the Z3 builtin sorts.
604 >>> b.kind() == Z3_BOOL_SORT
606 >>> b.kind() == Z3_INT_SORT
608 >>> A = ArraySort(IntSort(), IntSort())
609 >>> A.kind() == Z3_ARRAY_SORT
611 >>> A.kind() == Z3_INT_SORT
617 """Return `True` if `self` is a subsort of `other`.
619 >>> IntSort().subsort(RealSort())
625 """Try to cast `val` as an element of sort `self`.
627 This method is used in Z3Py to convert Python objects such as integers,
628 floats, longs and strings into Z3 expressions.
631 >>> RealSort().cast(x)
640 """Return the name (string) of sort `self`.
642 >>> BoolSort().name()
644 >>> ArraySort(IntSort(), IntSort()).name()
650 """Return `True` if `self` and `other` are the same Z3 sort.
653 >>> p.sort() == BoolSort()
655 >>> p.sort() == IntSort()
663 """Return `True` if `self` and `other` are not the same Z3 sort.
666 >>> p.sort() != BoolSort()
668 >>> p.sort() != IntSort()
674 """Create the function space Array(self, other)"""
679 return AstRef.__hash__(self)
683 """Return `True` if `s` is a Z3 sort.
685 >>> is_sort(IntSort())
687 >>> is_sort(Int('x'))
689 >>> is_expr(Int('x'))
692 return isinstance(s, SortRef)
697 _z3_assert(isinstance(s, Sort),
"Z3 Sort expected")
699 if k == Z3_BOOL_SORT:
701 elif k == Z3_INT_SORT
or k == Z3_REAL_SORT:
703 elif k == Z3_BV_SORT:
705 elif k == Z3_ARRAY_SORT:
707 elif k == Z3_DATATYPE_SORT:
709 elif k == Z3_FINITE_DOMAIN_SORT:
711 elif k == Z3_FLOATING_POINT_SORT:
713 elif k == Z3_ROUNDING_MODE_SORT:
715 elif k == Z3_RE_SORT:
717 elif k == Z3_SEQ_SORT:
719 elif k == Z3_CHAR_SORT:
721 elif k == Z3_TYPE_VAR:
726def _sort(ctx : Context, a : Any) -> SortRef:
731 """Create a new uninterpreted sort named `name`.
733 If `ctx=None`, then the new sort is declared in the global Z3Py context.
735 >>> A = DeclareSort('A')
736 >>> a = Const('a', A)
737 >>> b = Const('b', A)
749 """Type variable reference"""
759 """Create a new type variable named `name`.
761 If `ctx=None`, then the new sort is declared in the global Z3Py context.
776 """Function declaration. Every constant and function have an associated declaration.
778 The declaration assigns a name, a sort (i.e., type), and for function
779 the sort (i.e., type) of each of its arguments. Note that, in Z3,
780 a constant is a function with 0 arguments.
793 """Return the name of the function declaration `self`.
795 >>> f = Function('f', IntSort(), IntSort())
798 >>> isinstance(f.name(), str)
804 """Return the number of arguments of a function declaration.
805 If `self` is a constant, then `self.arity()` is 0.
807 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
814 """Return the sort of the argument `i` of a function declaration.
815 This method assumes that `0 <= i < self.arity()`.
817 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
826 """Return the sort of the range of a function declaration.
827 For constants, this is the sort of the constant.
829 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
836 """Return the internal kind of a function declaration.
837 It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
840 >>> d = (x + 1).decl()
841 >>> d.kind() == Z3_OP_ADD
843 >>> d.kind() == Z3_OP_MUL
851 result = [
None for i
in range(n)]
854 if k == Z3_PARAMETER_INT:
856 elif k == Z3_PARAMETER_DOUBLE:
858 elif k == Z3_PARAMETER_RATIONAL:
860 elif k == Z3_PARAMETER_SYMBOL:
862 elif k == Z3_PARAMETER_SORT:
864 elif k == Z3_PARAMETER_AST:
866 elif k == Z3_PARAMETER_FUNC_DECL:
868 elif k == Z3_PARAMETER_INTERNAL:
869 result[i] =
"internal parameter"
870 elif k == Z3_PARAMETER_ZSTRING:
871 result[i] =
"internal string"
873 raise Z3Exception(
"Unexpected parameter kind")
877 """Create a Z3 application expression using the function `self`, and the given arguments.
879 The arguments must be Z3 expressions. This method assumes that
880 the sorts of the elements in `args` match the sorts of the
881 domain. Limited coercion is supported. For example, if
882 args[0] is a Python integer, and the function expects a Z3
883 integer, then the argument is automatically converted into a
886 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
896 _args = (Ast * num)()
901 tmp = self.
domain(i).cast(args[i])
903 _args[i] = tmp.as_ast()
908 """Return `True` if `a` is a Z3 function declaration.
910 >>> f = Function('f', IntSort(), IntSort())
917 return isinstance(a, FuncDeclRef)
921 """Create a new Z3 uninterpreted function with the given sorts.
923 >>> f = Function('f', IntSort(), IntSort())
929 _z3_assert(len(sig) > 0,
"At least two arguments expected")
934 dom = (Sort * arity)()
935 for i
in range(arity):
944 """Create a new fresh Z3 uninterpreted function with the given sorts.
948 _z3_assert(len(sig) > 0,
"At least two arguments expected")
953 dom = (z3.Sort * arity)()
954 for i
in range(arity):
967 """Create a new Z3 recursive with the given sorts."""
970 _z3_assert(len(sig) > 0,
"At least two arguments expected")
975 dom = (Sort * arity)()
976 for i
in range(arity):
985 """Set the body of a recursive function.
986 Recursive definitions can be simplified if they are applied to ground
989 >>> fac = RecFunction('fac', IntSort(ctx), IntSort(ctx))
990 >>> n = Int('n', ctx)
991 >>> RecAddDefinition(fac, n, If(n == 0, 1, n*fac(n-1)))
994 >>> s = Solver(ctx=ctx)
995 >>> s.add(fac(n) < 3)
998 >>> s.model().eval(fac(5))
1008 _args[i] = args[i].ast
1019 """Constraints, formulas and terms are expressions in Z3.
1021 Expressions are ASTs. Every expression has a sort.
1022 There are three main kinds of expressions:
1023 function applications, quantifiers and bounded variables.
1024 A constant is a function application with 0 arguments.
1025 For quantifier free problems, all expressions are
1026 function applications.
1036 """Return the sort of expression `self`.
1048 """Shorthand for `self.sort().kind()`.
1050 >>> a = Array('a', IntSort(), IntSort())
1051 >>> a.sort_kind() == Z3_ARRAY_SORT
1053 >>> a.sort_kind() == Z3_INT_SORT
1059 """Return a Z3 expression that represents the constraint `self == other`.
1061 If `other` is `None`, then this method simply returns `False`.
1077 return AstRef.__hash__(self)
1080 """Return a Z3 expression that represents the constraint `self != other`.
1082 If `other` is `None`, then this method simply returns `True`.
1101 """Return the Z3 function declaration associated with a Z3 application.
1103 >>> f = Function('f', IntSort(), IntSort())
1116 """Return the Z3 internal kind of a function application."""
1123 """Return the number of arguments of a Z3 application.
1127 >>> (a + b).num_args()
1129 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1139 """Return argument `idx` of the application `self`.
1141 This method assumes that `self` is a function application with at least `idx+1` arguments.
1145 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1160 """Return a list containing the children of the given expression
1164 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1170 return [self.
arg(i)
for i
in range(self.
num_args())]
1175 """Update the arguments of the expression.
1177 Return a new expression with the same function declaration and updated arguments.
1178 The number of new arguments must match the current number of arguments.
1180 >>> f = Function('f', IntSort(), IntSort(), IntSort())
1193 _args = (Ast * num)()
1194 for i
in range(num):
1195 _args[i] = args[i].
as_ast()
1208 """inverse function to the serialize method on ExprRef.
1209 It is made available to make it easier for users to serialize expressions back and forth between
1210 strings. Solvers can be serialized using the 'sexpr()' method.
1214 if len(s.assertions()) != 1:
1215 raise Z3Exception(
"single assertion expected")
1216 fml = s.assertions()[0]
1217 if fml.num_args() != 1:
1218 raise Z3Exception(
"dummy function 'F' expected")
1222 if isinstance(a, Pattern):
1226 if k == Z3_QUANTIFIER_AST:
1229 if sk == Z3_BOOL_SORT:
1231 if sk == Z3_INT_SORT:
1232 if k == Z3_NUMERAL_AST:
1235 if sk == Z3_REAL_SORT:
1236 if k == Z3_NUMERAL_AST:
1241 if sk == Z3_BV_SORT:
1242 if k == Z3_NUMERAL_AST:
1246 if sk == Z3_ARRAY_SORT:
1248 if sk == Z3_DATATYPE_SORT:
1250 if sk == Z3_FLOATING_POINT_SORT:
1254 return FPRef(a, ctx)
1255 if sk == Z3_FINITE_DOMAIN_SORT:
1256 if k == Z3_NUMERAL_AST:
1260 if sk == Z3_ROUNDING_MODE_SORT:
1262 if sk == Z3_SEQ_SORT:
1264 if sk == Z3_CHAR_SORT:
1266 if sk == Z3_RE_SORT:
1267 return ReRef(a, ctx)
1284 _z3_assert(s1.ctx == s.ctx,
"context mismatch")
1290 if not isinstance(a, ExprRef):
1292 if not isinstance(b, ExprRef):
1306 if isinstance(a, str)
and isinstance(b, SeqRef):
1308 if isinstance(b, str)
and isinstance(a, SeqRef):
1310 if isinstance(a, float)
and isinstance(b, ArithRef):
1312 if isinstance(b, float)
and isinstance(a, ArithRef):
1328 for element
in sequence:
1329 result = func(result, element)
1340 alist = [
_py2expr(a, ctx)
for a
in alist]
1341 s =
_reduce(_coerce_expr_merge, alist,
None)
1342 return [s.cast(a)
for a
in alist]
1346 """Return `True` if `a` is a Z3 expression.
1353 >>> is_expr(IntSort())
1357 >>> is_expr(IntVal(1))
1360 >>> is_expr(ForAll(x, x >= 0))
1362 >>> is_expr(FPVal(1.0))
1365 return isinstance(a, ExprRef)
1369 """Return `True` if `a` is a Z3 function application.
1371 Note that, constants are function applications with 0 arguments.
1378 >>> is_app(IntSort())
1382 >>> is_app(IntVal(1))
1385 >>> is_app(ForAll(x, x >= 0))
1388 if not isinstance(a, ExprRef):
1391 return k == Z3_NUMERAL_AST
or k == Z3_APP_AST
1395 """Return `True` if `a` is Z3 constant/variable expression.
1404 >>> is_const(IntVal(1))
1407 >>> is_const(ForAll(x, x >= 0))
1410 return is_app(a)
and a.num_args() == 0
1414 """Return `True` if `a` is variable.
1416 Z3 uses de-Bruijn indices for representing bound variables in
1424 >>> f = Function('f', IntSort(), IntSort())
1425 >>> # Z3 replaces x with bound variables when ForAll is executed.
1426 >>> q = ForAll(x, f(x) == x)
1432 >>> is_var(b.arg(1))
1439 """Return the de-Bruijn index of the Z3 bounded variable `a`.
1447 >>> f = Function('f', IntSort(), IntSort(), IntSort())
1448 >>> # Z3 replaces x and y with bound variables when ForAll is executed.
1449 >>> q = ForAll([x, y], f(x, y) == x + y)
1451 f(Var(1), Var(0)) == Var(1) + Var(0)
1455 >>> v1 = b.arg(0).arg(0)
1456 >>> v2 = b.arg(0).arg(1)
1461 >>> get_var_index(v1)
1463 >>> get_var_index(v2)
1472 """Return `True` if `a` is an application of the given kind `k`.
1476 >>> is_app_of(n, Z3_OP_ADD)
1478 >>> is_app_of(n, Z3_OP_MUL)
1481 return is_app(a)
and a.kind() == k
1484def If(a, b, c, ctx=None):
1485 """Create a Z3 if-then-else expression.
1489 >>> max = If(x > y, x, y)
1495 if isinstance(a, Probe)
or isinstance(b, Tactic)
or isinstance(c, Tactic):
1496 return Cond(a, b, c, ctx)
1503 _z3_assert(a.ctx == b.ctx,
"Context mismatch")
1508 """Create a Z3 distinct expression.
1515 >>> Distinct(x, y, z)
1517 >>> simplify(Distinct(x, y, z))
1519 >>> simplify(Distinct(x, y, z), blast_distinct=True)
1520 And(Not(x == y), Not(x == z), Not(y == z))
1525 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression")
1534 _z3_assert(a.ctx == b.ctx,
"Context mismatch")
1535 args[0] = a.as_ast()
1536 args[1] = b.as_ast()
1537 return f(a.ctx.ref(), 2, args)
1541 """Create a constant of the given sort.
1543 >>> Const('x', IntSort())
1547 _z3_assert(isinstance(sort, SortRef),
"Z3 sort expected")
1553 """Create several constants of the given sort.
1555 `names` is a string containing the names of all constants to be created.
1556 Blank spaces separate the names of different constants.
1558 >>> x, y, z = Consts('x y z', IntSort())
1562 if isinstance(names, str):
1563 names = names.split(
" ")
1564 return [
Const(name, sort)
for name
in names]
1568 """Create a fresh constant of a specified sort"""
1575def Var(idx : int, s : SortRef) -> ExprRef:
1576 """Create a Z3 free variable. Free variables are used to create quantified formulas.
1577 A free variable with index n is bound when it occurs within the scope of n+1 quantified
1580 >>> Var(0, IntSort())
1582 >>> eq(Var(0, IntSort()), Var(0, BoolSort()))
1592 Create a real free variable. Free variables are used to create quantified formulas.
1593 They are also used to create polynomials.
1602 Create a list of Real free variables.
1603 The variables have ids: 0, 1, ..., n-1
1605 >>> x0, x1, x2, x3 = RealVarVector(4)
1609 return [
RealVar(i, ctx)
for i
in range(n)]
1622 """Try to cast `val` as a Boolean.
1624 >>> x = BoolSort().cast(True)
1634 if isinstance(val, bool):
1638 msg =
"True, False or Z3 Boolean expression expected. Received %s of type %s"
1640 if not self.
eq(val.sort()):
1641 _z3_assert(self.
eq(val.sort()),
"Value cannot be converted into a Z3 Boolean value")
1645 return isinstance(other, ArithSortRef)
1655 """All Boolean expressions are instances of this class."""
1661 if isinstance(other, BoolRef):
1662 other =
If(other, 1, 0)
1663 return If(self, 1, 0) + other
1672 """Create the Z3 expression `self * other`.
1674 if isinstance(other, int)
and other == 1:
1675 return If(self, 1, 0)
1676 if isinstance(other, int)
and other == 0:
1678 if isinstance(other, BoolRef):
1679 other =
If(other, 1, 0)
1680 return If(self, other, 0)
1683 return And(self, other)
1686 return Or(self, other)
1689 return Xor(self, other)
1705 """Return `True` if `a` is a Z3 Boolean expression.
1711 >>> is_bool(And(p, q))
1719 return isinstance(a, BoolRef)
1723 """Return `True` if `a` is the Z3 true expression.
1728 >>> is_true(simplify(p == p))
1733 >>> # True is a Python Boolean expression
1741 """Return `True` if `a` is the Z3 false expression.
1748 >>> is_false(BoolVal(False))
1755 """Return `True` if `a` is a Z3 and expression.
1757 >>> p, q = Bools('p q')
1758 >>> is_and(And(p, q))
1760 >>> is_and(Or(p, q))
1767 """Return `True` if `a` is a Z3 or expression.
1769 >>> p, q = Bools('p q')
1772 >>> is_or(And(p, q))
1779 """Return `True` if `a` is a Z3 implication expression.
1781 >>> p, q = Bools('p q')
1782 >>> is_implies(Implies(p, q))
1784 >>> is_implies(And(p, q))
1791 """Return `True` if `a` is a Z3 not expression.
1803 """Return `True` if `a` is a Z3 equality expression.
1805 >>> x, y = Ints('x y')
1813 """Return `True` if `a` is a Z3 distinct expression.
1815 >>> x, y, z = Ints('x y z')
1816 >>> is_distinct(x == y)
1818 >>> is_distinct(Distinct(x, y, z))
1825 """Return the Boolean Z3 sort. If `ctx=None`, then the global context is used.
1829 >>> p = Const('p', BoolSort())
1832 >>> r = Function('r', IntSort(), IntSort(), BoolSort())
1835 >>> is_bool(r(0, 1))
1843 """Return the Boolean value `True` or `False`. If `ctx=None`, then the global context is used.
1847 >>> is_true(BoolVal(True))
1851 >>> is_false(BoolVal(False))
1862 """Return a Boolean constant named `name`. If `ctx=None`, then the global context is used.
1874 """Return a tuple of Boolean constants.
1876 `names` is a single string containing all names separated by blank spaces.
1877 If `ctx=None`, then the global context is used.
1879 >>> p, q, r = Bools('p q r')
1880 >>> And(p, Or(q, r))
1884 if isinstance(names, str):
1885 names = names.split(
" ")
1886 return [
Bool(name, ctx)
for name
in names]
1890 """Return a list of Boolean constants of size `sz`.
1892 The constants are named using the given prefix.
1893 If `ctx=None`, then the global context is used.
1895 >>> P = BoolVector('p', 3)
1899 And(p__0, p__1, p__2)
1901 return [
Bool(
"%s__%s" % (prefix, i))
for i
in range(sz)]
1905 """Return a fresh Boolean constant in the given context using the given prefix.
1907 If `ctx=None`, then the global context is used.
1909 >>> b1 = FreshBool()
1910 >>> b2 = FreshBool()
1919 """Create a Z3 implies expression.
1921 >>> p, q = Bools('p q')
1933 """Create a Z3 Xor expression.
1935 >>> p, q = Bools('p q')
1938 >>> simplify(Xor(p, q))
1949 """Create a Z3 not expression or probe.
1954 >>> simplify(Not(Not(p)))
1975 """Return `True` if one of the elements of the given collection is a Z3 probe."""
1983 """Create a Z3 and-expression or and-probe.
1985 >>> p, q, r = Bools('p q r')
1988 >>> P = BoolVector('p', 5)
1990 And(p__0, p__1, p__2, p__3, p__4)
1994 last_arg = args[len(args) - 1]
1995 if isinstance(last_arg, Context):
1996 ctx = args[len(args) - 1]
1997 args = args[:len(args) - 1]
1998 elif len(args) == 1
and isinstance(args[0], AstVector):
2000 args = [a
for a
in args[0]]
2006 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression or probe")
2016 """Create a Z3 or-expression or or-probe.
2018 >>> p, q, r = Bools('p q r')
2021 >>> P = BoolVector('p', 5)
2023 Or(p__0, p__1, p__2, p__3, p__4)
2027 last_arg = args[len(args) - 1]
2028 if isinstance(last_arg, Context):
2029 ctx = args[len(args) - 1]
2030 args = args[:len(args) - 1]
2031 elif len(args) == 1
and isinstance(args[0], AstVector):
2033 args = [a
for a
in args[0]]
2039 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression or probe")
2055 """Patterns are hints for quantifier instantiation.
2067 """Return `True` if `a` is a Z3 pattern (hint for quantifier instantiation.
2069 >>> f = Function('f', IntSort(), IntSort())
2071 >>> q = ForAll(x, f(x) == 0, patterns = [ f(x) ])
2073 ForAll(x, f(x) == 0)
2074 >>> q.num_patterns()
2076 >>> is_pattern(q.pattern(0))
2081 return isinstance(a, PatternRef)
2085 """Create a Z3 multi-pattern using the given expressions `*args`
2087 >>> f = Function('f', IntSort(), IntSort())
2088 >>> g = Function('g', IntSort(), IntSort())
2090 >>> q = ForAll(x, f(x) != g(x), patterns = [ MultiPattern(f(x), g(x)) ])
2092 ForAll(x, f(x) != g(x))
2093 >>> q.num_patterns()
2095 >>> is_pattern(q.pattern(0))
2098 MultiPattern(f(Var(0)), g(Var(0)))
2101 _z3_assert(len(args) > 0,
"At least one argument expected")
2122 """Universally and Existentially quantified formulas."""
2131 """Return the Boolean sort or sort of Lambda."""
2137 """Return `True` if `self` is a universal quantifier.
2139 >>> f = Function('f', IntSort(), IntSort())
2141 >>> q = ForAll(x, f(x) == 0)
2144 >>> q = Exists(x, f(x) != 0)
2151 """Return `True` if `self` is an existential quantifier.
2153 >>> f = Function('f', IntSort(), IntSort())
2155 >>> q = ForAll(x, f(x) == 0)
2158 >>> q = Exists(x, f(x) != 0)
2165 """Return `True` if `self` is a lambda expression.
2167 >>> f = Function('f', IntSort(), IntSort())
2169 >>> q = Lambda(x, f(x))
2172 >>> q = Exists(x, f(x) != 0)
2179 """Return the Z3 expression `self[arg]`.
2186 """Return the weight annotation of `self`.
2188 >>> f = Function('f', IntSort(), IntSort())
2190 >>> q = ForAll(x, f(x) == 0)
2193 >>> q = ForAll(x, f(x) == 0, weight=10)
2200 """Return the skolem id of `self`.
2205 """Return the quantifier id of `self`.
2210 """Return the number of patterns (i.e., quantifier instantiation hints) in `self`.
2212 >>> f = Function('f', IntSort(), IntSort())
2213 >>> g = Function('g', IntSort(), IntSort())
2215 >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2216 >>> q.num_patterns()
2222 """Return a pattern (i.e., quantifier instantiation hints) in `self`.
2224 >>> f = Function('f', IntSort(), IntSort())
2225 >>> g = Function('g', IntSort(), IntSort())
2227 >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2228 >>> q.num_patterns()
2240 """Return the number of no-patterns."""
2244 """Return a no-pattern."""
2250 """Return the expression being quantified.
2252 >>> f = Function('f', IntSort(), IntSort())
2254 >>> q = ForAll(x, f(x) == 0)
2261 """Return the number of variables bounded by this quantifier.
2263 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2266 >>> q = ForAll([x, y], f(x, y) >= x)
2273 """Return a string representing a name used when displaying the quantifier.
2275 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2278 >>> q = ForAll([x, y], f(x, y) >= x)
2289 """Return the sort of a bound variable.
2291 >>> f = Function('f', IntSort(), RealSort(), IntSort())
2294 >>> q = ForAll([x, y], f(x, y) >= x)
2305 """Return a list containing a single element self.body()
2307 >>> f = Function('f', IntSort(), IntSort())
2309 >>> q = ForAll(x, f(x) == 0)
2313 return [self.
body()]
2317 """Return `True` if `a` is a Z3 quantifier.
2319 >>> f = Function('f', IntSort(), IntSort())
2321 >>> q = ForAll(x, f(x) == 0)
2322 >>> is_quantifier(q)
2324 >>> is_quantifier(f(x))
2327 return isinstance(a, QuantifierRef)
2330def _mk_quantifier(is_forall, vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2335 _z3_assert(all([
is_expr(p)
for p
in no_patterns]),
"no patterns are Z3 expressions")
2346 _vs = (Ast * num_vars)()
2347 for i
in range(num_vars):
2349 _vs[i] = vs[i].as_ast()
2351 num_pats = len(patterns)
2352 _pats = (Pattern * num_pats)()
2353 for i
in range(num_pats):
2354 _pats[i] = patterns[i].ast
2361 num_no_pats, _no_pats,
2362 body.as_ast()), ctx)
2365def ForAll(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2366 """Create a Z3 forall formula.
2368 The parameters `weight`, `qid`, `skid`, `patterns` and `no_patterns` are optional annotations.
2370 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2373 >>> ForAll([x, y], f(x, y) >= x)
2374 ForAll([x, y], f(x, y) >= x)
2375 >>> ForAll([x, y], f(x, y) >= x, patterns=[ f(x, y) ])
2376 ForAll([x, y], f(x, y) >= x)
2377 >>> ForAll([x, y], f(x, y) >= x, weight=10)
2378 ForAll([x, y], f(x, y) >= x)
2380 return _mk_quantifier(
True, vs, body, weight, qid, skid, patterns, no_patterns)
2383def Exists(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2384 """Create a Z3 exists formula.
2386 The parameters `weight`, `qif`, `skid`, `patterns` and `no_patterns` are optional annotations.
2389 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2392 >>> q = Exists([x, y], f(x, y) >= x, skid="foo")
2394 Exists([x, y], f(x, y) >= x)
2395 >>> is_quantifier(q)
2397 >>> r = Tactic('nnf')(q).as_expr()
2398 >>> is_quantifier(r)
2401 return _mk_quantifier(
False, vs, body, weight, qid, skid, patterns, no_patterns)
2405 """Create a Z3 lambda expression.
2407 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2408 >>> mem0 = Array('mem0', IntSort(), IntSort())
2409 >>> lo, hi, e, i = Ints('lo hi e i')
2410 >>> mem1 = Lambda([i], If(And(lo <= i, i <= hi), e, mem0[i]))
2412 Lambda(i, If(And(lo <= i, i <= hi), e, mem0[i]))
2418 _vs = (Ast * num_vars)()
2419 for i
in range(num_vars):
2421 _vs[i] = vs[i].as_ast()
2432 """Real and Integer sorts."""
2435 """Return `True` if `self` is of the sort Real.
2440 >>> (x + 1).is_real()
2446 return self.
kind() == Z3_REAL_SORT
2449 """Return `True` if `self` is of the sort Integer.
2454 >>> (x + 1).is_int()
2460 return self.
kind() == Z3_INT_SORT
2466 """Return `True` if `self` is a subsort of `other`."""
2470 """Try to cast `val` as an Integer or Real.
2472 >>> IntSort().cast(10)
2474 >>> is_int(IntSort().cast(10))
2478 >>> RealSort().cast(10)
2480 >>> is_real(RealSort().cast(10))
2489 if val_s.is_int()
and self.
is_real():
2491 if val_s.is_bool()
and self.
is_int():
2492 return If(val, 1, 0)
2493 if val_s.is_bool()
and self.
is_real():
2496 _z3_assert(
False,
"Z3 Integer/Real expression expected")
2503 msg =
"int, long, float, string (numeral), or Z3 Integer/Real expression expected. Got %s"
2508 """Return `True` if s is an arithmetical sort (type).
2510 >>> is_arith_sort(IntSort())
2512 >>> is_arith_sort(RealSort())
2514 >>> is_arith_sort(BoolSort())
2516 >>> n = Int('x') + 1
2517 >>> is_arith_sort(n.sort())
2520 return isinstance(s, ArithSortRef)
2524 """Integer and Real expressions."""
2527 """Return the sort (type) of the arithmetical expression `self`.
2531 >>> (Real('x') + 1).sort()
2537 """Return `True` if `self` is an integer expression.
2542 >>> (x + 1).is_int()
2545 >>> (x + y).is_int()
2551 """Return `True` if `self` is an real expression.
2556 >>> (x + 1).is_real()
2562 """Create the Z3 expression `self + other`.
2575 """Create the Z3 expression `other + self`.
2585 """Create the Z3 expression `self * other`.
2594 if isinstance(other, BoolRef):
2595 return If(other, self, 0)
2600 """Create the Z3 expression `other * self`.
2610 """Create the Z3 expression `self - other`.
2623 """Create the Z3 expression `other - self`.
2633 """Create the Z3 expression `self**other` (** is the power operator).
2640 >>> simplify(IntVal(2)**8)
2647 """Create the Z3 expression `other**self` (** is the power operator).
2654 >>> simplify(2**IntVal(8))
2661 """Create the Z3 expression `other/self`.
2684 """Create the Z3 expression `other/self`."""
2688 """Create the Z3 expression `other/self`.
2705 """Create the Z3 expression `other/self`."""
2709 """Create the Z3 expression `other%self`.
2715 >>> simplify(IntVal(10) % IntVal(3))
2720 _z3_assert(a.is_int(),
"Z3 integer expression expected")
2724 """Create the Z3 expression `other%self`.
2732 _z3_assert(a.is_int(),
"Z3 integer expression expected")
2736 """Return an expression representing `-self`.
2756 """Create the Z3 expression `other <= self`.
2758 >>> x, y = Ints('x y')
2769 """Create the Z3 expression `other < self`.
2771 >>> x, y = Ints('x y')
2782 """Create the Z3 expression `other > self`.
2784 >>> x, y = Ints('x y')
2795 """Create the Z3 expression `other >= self`.
2797 >>> x, y = Ints('x y')
2808 """Return an expression representing `abs(self)`.
2813 >>> eq(abs(x), Abs(x))
2820 """Return `True` if `a` is an arithmetical expression.
2829 >>> is_arith(IntVal(1))
2837 return isinstance(a, ArithRef)
2841 """Return `True` if `a` is an integer expression.
2848 >>> is_int(IntVal(1))
2860 """Return `True` if `a` is a real expression.
2872 >>> is_real(RealVal(1))
2887 """Return `True` if `a` is an integer value of sort Int.
2889 >>> is_int_value(IntVal(1))
2893 >>> is_int_value(Int('x'))
2895 >>> n = Int('x') + 1
2900 >>> is_int_value(n.arg(1))
2902 >>> is_int_value(RealVal("1/3"))
2904 >>> is_int_value(RealVal(1))
2911 """Return `True` if `a` is rational value of sort Real.
2913 >>> is_rational_value(RealVal(1))
2915 >>> is_rational_value(RealVal("3/5"))
2917 >>> is_rational_value(IntVal(1))
2919 >>> is_rational_value(1)
2921 >>> n = Real('x') + 1
2924 >>> is_rational_value(n.arg(1))
2926 >>> is_rational_value(Real('x'))
2933 """Return `True` if `a` is an algebraic value of sort Real.
2935 >>> is_algebraic_value(RealVal("3/5"))
2937 >>> n = simplify(Sqrt(2))
2940 >>> is_algebraic_value(n)
2947 """Return `True` if `a` is an expression of the form b + c.
2949 >>> x, y = Ints('x y')
2959 """Return `True` if `a` is an expression of the form b * c.
2961 >>> x, y = Ints('x y')
2971 """Return `True` if `a` is an expression of the form b - c.
2973 >>> x, y = Ints('x y')
2983 """Return `True` if `a` is an expression of the form b / c.
2985 >>> x, y = Reals('x y')
2990 >>> x, y = Ints('x y')
3000 """Return `True` if `a` is an expression of the form b div c.
3002 >>> x, y = Ints('x y')
3012 """Return `True` if `a` is an expression of the form b % c.
3014 >>> x, y = Ints('x y')
3024 """Return `True` if `a` is an expression of the form b <= c.
3026 >>> x, y = Ints('x y')
3036 """Return `True` if `a` is an expression of the form b < c.
3038 >>> x, y = Ints('x y')
3048 """Return `True` if `a` is an expression of the form b >= c.
3050 >>> x, y = Ints('x y')
3060 """Return `True` if `a` is an expression of the form b > c.
3062 >>> x, y = Ints('x y')
3072 """Return `True` if `a` is an expression of the form IsInt(b).
3075 >>> is_is_int(IsInt(x))
3084 """Return `True` if `a` is an expression of the form ToReal(b).
3099 """Return `True` if `a` is an expression of the form ToInt(b).
3114 """Integer values."""
3117 """Return a Z3 integer numeral as a Python long (bignum) numeral.
3130 """Return a Z3 integer numeral as a Python string.
3138 """Return a Z3 integer numeral as a Python binary string.
3140 >>> v.as_binary_string()
3150 """Rational values."""
3153 """ Return the numerator of a Z3 rational numeral.
3155 >>> is_rational_value(RealVal("3/5"))
3157 >>> n = RealVal("3/5")
3160 >>> is_rational_value(Q(3,5))
3162 >>> Q(3,5).numerator()
3168 """ Return the denominator of a Z3 rational numeral.
3170 >>> is_rational_value(Q(3,5))
3179 """ Return the numerator as a Python long.
3181 >>> v = RealVal(10000000000)
3186 >>> v.numerator_as_long() + 1 == 10000000001
3192 """ Return the denominator as a Python long.
3194 >>> v = RealVal("1/3")
3197 >>> v.denominator_as_long()
3216 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3218 >>> v = RealVal("1/5")
3221 >>> v = RealVal("1/3")
3228 """Return a Z3 rational numeral as a Python string.
3237 """Return a Z3 rational as a Python Fraction object.
3239 >>> v = RealVal("1/5")
3250 """Algebraic irrational values."""
3253 """Return a Z3 rational number that approximates the algebraic number `self`.
3254 The result `r` is such that |r - self| <= 1/10^precision
3256 >>> x = simplify(Sqrt(2))
3258 6838717160008073720548335/4835703278458516698824704
3265 """Return a string representation of the algebraic number `self` in decimal notation
3266 using `prec` decimal places.
3268 >>> x = simplify(Sqrt(2))
3269 >>> x.as_decimal(10)
3271 >>> x.as_decimal(20)
3272 '1.41421356237309504880?'
3284 if isinstance(a, bool):
3288 if isinstance(a, float):
3290 if isinstance(a, str):
3295 _z3_assert(
False,
"Python bool, int, long or float expected")
3299 """Return the integer sort in the given context. If `ctx=None`, then the global context is used.
3303 >>> x = Const('x', IntSort())
3306 >>> x.sort() == IntSort()
3308 >>> x.sort() == BoolSort()
3316 """Return the real sort in the given context. If `ctx=None`, then the global context is used.
3320 >>> x = Const('x', RealSort())
3325 >>> x.sort() == RealSort()
3333 if isinstance(val, float):
3334 return str(int(val))
3335 elif isinstance(val, bool):
3345 """Return a Z3 integer value. If `ctx=None`, then the global context is used.
3357 """Return a Z3 real value.
3359 `val` may be a Python int, long, float or string representing a number in decimal or rational notation.
3360 If `ctx=None`, then the global context is used.
3364 >>> RealVal(1).sort()
3376 """Return a Z3 rational a/b.
3378 If `ctx=None`, then the global context is used.
3380 Note: Division by zero (b == 0) is allowed in Z3 symbolic expressions.
3381 Z3 can reason about such expressions symbolically.
3385 >>> RatVal(3,5).sort()
3389 _z3_assert(
_is_int(a)
or isinstance(a, str),
"First argument cannot be converted into an integer")
3390 _z3_assert(
_is_int(b)
or isinstance(b, str),
"Second argument cannot be converted into an integer")
3395def Q(a, b, ctx=None):
3396 """Return a Z3 rational a/b.
3398 If `ctx=None`, then the global context is used.
3409 """Return an integer constant named `name`. If `ctx=None`, then the global context is used.
3422 """Return a tuple of Integer constants.
3424 >>> x, y, z = Ints('x y z')
3429 if isinstance(names, str):
3430 names = names.split(
" ")
3431 return [
Int(name, ctx)
for name
in names]
3435 """Return a list of integer constants of size `sz`.
3437 >>> X = IntVector('x', 3)
3444 return [
Int(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3448 """Return a fresh integer constant in the given context using the given prefix.
3462 """Return a real constant named `name`. If `ctx=None`, then the global context is used.
3475 """Return a tuple of real constants.
3477 >>> x, y, z = Reals('x y z')
3480 >>> Sum(x, y, z).sort()
3484 if isinstance(names, str):
3485 names = names.split(
" ")
3486 return [
Real(name, ctx)
for name
in names]
3490 """Return a list of real constants of size `sz`.
3492 >>> X = RealVector('x', 3)
3501 return [
Real(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3505 """Return a fresh real constant in the given context using the given prefix.
3519 """ Return the Z3 expression ToReal(a).
3531 if isinstance(a, BoolRef):
3534 _z3_assert(a.is_int(),
"Z3 integer expression expected.")
3539 """ Return the Z3 expression ToInt(a).
3551 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3557 """ Return the Z3 predicate IsInt(a).
3560 >>> IsInt(x + "1/2")
3562 >>> solve(IsInt(x + "1/2"), x > 0, x < 1)
3564 >>> solve(IsInt(x + "1/2"), x > 0, x < 1, x != "1/2")
3568 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3574 """ Return a Z3 expression which represents the square root of a.
3587 """ Return a Z3 expression which represents the cubic root of a.
3606 """Bit-vector sort."""
3609 """Return the size (number of bits) of the bit-vector sort `self`.
3611 >>> b = BitVecSort(32)
3621 """Try to cast `val` as a Bit-Vector.
3623 >>> b = BitVecSort(32)
3626 >>> b.cast(10).sexpr()
3639 """Return True if `s` is a Z3 bit-vector sort.
3641 >>> is_bv_sort(BitVecSort(32))
3643 >>> is_bv_sort(IntSort())
3646 return isinstance(s, BitVecSortRef)
3650 """Bit-vector expressions."""
3653 """Return the sort of the bit-vector expression `self`.
3655 >>> x = BitVec('x', 32)
3658 >>> x.sort() == BitVecSort(32)
3664 """Return the number of bits of the bit-vector expression `self`.
3666 >>> x = BitVec('x', 32)
3669 >>> Concat(x, x).size()
3675 """Create the Z3 expression `self + other`.
3677 >>> x = BitVec('x', 32)
3678 >>> y = BitVec('y', 32)
3688 """Create the Z3 expression `other + self`.
3690 >>> x = BitVec('x', 32)
3698 """Create the Z3 expression `self * other`.
3700 >>> x = BitVec('x', 32)
3701 >>> y = BitVec('y', 32)
3711 """Create the Z3 expression `other * self`.
3713 >>> x = BitVec('x', 32)
3721 """Create the Z3 expression `self - other`.
3723 >>> x = BitVec('x', 32)
3724 >>> y = BitVec('y', 32)
3734 """Create the Z3 expression `other - self`.
3736 >>> x = BitVec('x', 32)
3744 """Create the Z3 expression bitwise-or `self | other`.
3746 >>> x = BitVec('x', 32)
3747 >>> y = BitVec('y', 32)
3757 """Create the Z3 expression bitwise-or `other | self`.
3759 >>> x = BitVec('x', 32)
3767 """Create the Z3 expression bitwise-and `self & other`.
3769 >>> x = BitVec('x', 32)
3770 >>> y = BitVec('y', 32)
3780 """Create the Z3 expression bitwise-or `other & self`.
3782 >>> x = BitVec('x', 32)
3790 """Create the Z3 expression bitwise-xor `self ^ other`.
3792 >>> x = BitVec('x', 32)
3793 >>> y = BitVec('y', 32)
3803 """Create the Z3 expression bitwise-xor `other ^ self`.
3805 >>> x = BitVec('x', 32)
3815 >>> x = BitVec('x', 32)
3822 """Return an expression representing `-self`.
3824 >>> x = BitVec('x', 32)
3833 """Create the Z3 expression bitwise-not `~self`.
3835 >>> x = BitVec('x', 32)
3844 """Create the Z3 expression (signed) division `self / other`.
3846 Use the function UDiv() for unsigned division.
3848 >>> x = BitVec('x', 32)
3849 >>> y = BitVec('y', 32)
3856 >>> UDiv(x, y).sexpr()
3863 """Create the Z3 expression (signed) division `self / other`."""
3867 """Create the Z3 expression (signed) division `other / self`.
3869 Use the function UDiv() for unsigned division.
3871 >>> x = BitVec('x', 32)
3874 >>> (10 / x).sexpr()
3875 '(bvsdiv #x0000000a x)'
3876 >>> UDiv(10, x).sexpr()
3877 '(bvudiv #x0000000a x)'
3883 """Create the Z3 expression (signed) division `other / self`."""
3887 """Create the Z3 expression (signed) mod `self % other`.
3889 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3891 >>> x = BitVec('x', 32)
3892 >>> y = BitVec('y', 32)
3899 >>> URem(x, y).sexpr()
3901 >>> SRem(x, y).sexpr()
3908 """Create the Z3 expression (signed) mod `other % self`.
3910 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3912 >>> x = BitVec('x', 32)
3915 >>> (10 % x).sexpr()
3916 '(bvsmod #x0000000a x)'
3917 >>> URem(10, x).sexpr()
3918 '(bvurem #x0000000a x)'
3919 >>> SRem(10, x).sexpr()
3920 '(bvsrem #x0000000a x)'
3926 """Create the Z3 expression (signed) `other <= self`.
3928 Use the function ULE() for unsigned less than or equal to.
3930 >>> x, y = BitVecs('x y', 32)
3933 >>> (x <= y).sexpr()
3935 >>> ULE(x, y).sexpr()
3942 """Create the Z3 expression (signed) `other < self`.
3944 Use the function ULT() for unsigned less than.
3946 >>> x, y = BitVecs('x y', 32)
3951 >>> ULT(x, y).sexpr()
3958 """Create the Z3 expression (signed) `other > self`.
3960 Use the function UGT() for unsigned greater than.
3962 >>> x, y = BitVecs('x y', 32)
3967 >>> UGT(x, y).sexpr()
3974 """Create the Z3 expression (signed) `other >= self`.
3976 Use the function UGE() for unsigned greater than or equal to.
3978 >>> x, y = BitVecs('x y', 32)
3981 >>> (x >= y).sexpr()
3983 >>> UGE(x, y).sexpr()
3990 """Create the Z3 expression (arithmetical) right shift `self >> other`
3992 Use the function LShR() for the right logical shift
3994 >>> x, y = BitVecs('x y', 32)
3997 >>> (x >> y).sexpr()
3999 >>> LShR(x, y).sexpr()
4003 >>> BitVecVal(4, 3).as_signed_long()
4005 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
4007 >>> simplify(BitVecVal(4, 3) >> 1)
4009 >>> simplify(LShR(BitVecVal(4, 3), 1))
4011 >>> simplify(BitVecVal(2, 3) >> 1)
4013 >>> simplify(LShR(BitVecVal(2, 3), 1))
4020 """Create the Z3 expression left shift `self << other`
4022 >>> x, y = BitVecs('x y', 32)
4025 >>> (x << y).sexpr()
4027 >>> simplify(BitVecVal(2, 3) << 1)
4034 """Create the Z3 expression (arithmetical) right shift `other` >> `self`.
4036 Use the function LShR() for the right logical shift
4038 >>> x = BitVec('x', 32)
4041 >>> (10 >> x).sexpr()
4042 '(bvashr #x0000000a x)'
4048 """Create the Z3 expression left shift `other << self`.
4050 Use the function LShR() for the right logical shift
4052 >>> x = BitVec('x', 32)
4055 >>> (10 << x).sexpr()
4056 '(bvshl #x0000000a x)'
4063 """Bit-vector values."""
4066 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4068 >>> v = BitVecVal(0xbadc0de, 32)
4071 >>> print("0x%.8x" % v.as_long())
4077 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4078 The most significant bit is assumed to be the sign.
4080 >>> BitVecVal(4, 3).as_signed_long()
4082 >>> BitVecVal(7, 3).as_signed_long()
4084 >>> BitVecVal(3, 3).as_signed_long()
4086 >>> BitVecVal(2**32 - 1, 32).as_signed_long()
4088 >>> BitVecVal(2**64 - 1, 64).as_signed_long()
4093 if val >= 2**(sz - 1):
4095 if val < -2**(sz - 1):
4106 """Return the Python value of a Z3 bit-vector numeral."""
4112 """Return `True` if `a` is a Z3 bit-vector expression.
4114 >>> b = BitVec('b', 32)
4122 return isinstance(a, BitVecRef)
4126 """Return `True` if `a` is a Z3 bit-vector numeral value.
4128 >>> b = BitVec('b', 32)
4131 >>> b = BitVecVal(10, 32)
4141 """Return the Z3 expression BV2Int(a).
4143 >>> b = BitVec('b', 3)
4144 >>> BV2Int(b).sort()
4149 >>> x > BV2Int(b, is_signed=False)
4151 >>> x > BV2Int(b, is_signed=True)
4152 x > If(b < 0, BV2Int(b) - 8, BV2Int(b))
4153 >>> solve(x > BV2Int(b), b == 1, x < 3)
4157 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4164 """Return the z3 expression Int2BV(a, num_bits).
4165 It is a bit-vector of width num_bits and represents the
4166 modulo of a by 2^num_bits
4173 """Return a Z3 bit-vector sort of the given size. If `ctx=None`, then the global context is used.
4175 >>> Byte = BitVecSort(8)
4176 >>> Word = BitVecSort(16)
4179 >>> x = Const('x', Byte)
4180 >>> eq(x, BitVec('x', 8))
4188 """Return a bit-vector value with the given number of bits. If `ctx=None`, then the global context is used.
4190 >>> v = BitVecVal(10, 32)
4193 >>> print("0x%.8x" % v.as_long())
4205 """Return a bit-vector constant named `name`. `bv` may be the number of bits of a bit-vector sort.
4206 If `ctx=None`, then the global context is used.
4208 >>> x = BitVec('x', 16)
4215 >>> word = BitVecSort(16)
4216 >>> x2 = BitVec('x', word)
4220 if isinstance(bv, BitVecSortRef):
4229 """Return a tuple of bit-vector constants of size bv.
4231 >>> x, y, z = BitVecs('x y z', 16)
4238 >>> Product(x, y, z)
4240 >>> simplify(Product(x, y, z))
4244 if isinstance(names, str):
4245 names = names.split(
" ")
4246 return [
BitVec(name, bv, ctx)
for name
in names]
4250 """Create a Z3 bit-vector concatenation expression.
4252 >>> v = BitVecVal(1, 4)
4253 >>> Concat(v, v+1, v)
4254 Concat(Concat(1, 1 + 1), 1)
4255 >>> simplify(Concat(v, v+1, v))
4257 >>> print("%.3x" % simplify(Concat(v, v+1, v)).as_long())
4263 _z3_assert(sz >= 2,
"At least two arguments expected.")
4270 if is_seq(args[0])
or isinstance(args[0], str):
4273 _z3_assert(all([
is_seq(a)
for a
in args]),
"All arguments must be sequence expressions.")
4276 v[i] = args[i].as_ast()
4281 _z3_assert(all([
is_re(a)
for a
in args]),
"All arguments must be regular expressions.")
4284 v[i] = args[i].as_ast()
4288 _z3_assert(all([
is_bv(a)
for a
in args]),
"All arguments must be Z3 bit-vector expressions.")
4290 for i
in range(sz - 1):
4296 """Create a Z3 bit-vector extraction expression or sequence extraction expression.
4298 Extract is overloaded to work with both bit-vectors and sequences:
4300 **Bit-vector extraction**: Extract(high, low, bitvector)
4301 Extracts bits from position `high` down to position `low` (both inclusive).
4302 - high: int - the highest bit position to extract (0-indexed from right)
4303 - low: int - the lowest bit position to extract (0-indexed from right)
4304 - bitvector: BitVecRef - the bit-vector to extract from
4305 Returns a new bit-vector containing bits [high:low]
4307 **Sequence extraction**: Extract(sequence, offset, length)
4308 Extracts a subsequence starting at the given offset with the specified length.
4309 The functions SubString and SubSeq are redirected to this form of Extract.
4310 - sequence: SeqRef or str - the sequence to extract from
4311 - offset: int - the starting position (0-indexed)
4312 - length: int - the number of elements to extract
4313 Returns a new sequence containing the extracted subsequence
4315 >>> # Bit-vector extraction examples
4316 >>> x = BitVec('x', 8)
4317 >>> Extract(6, 2, x) # Extract bits 6 down to 2 (5 bits total)
4319 >>> Extract(6, 2, x).sort() # Result is a 5-bit vector
4321 >>> Extract(7, 0, x) # Extract all 8 bits
4323 >>> Extract(3, 3, x) # Extract single bit at position 3
4326 >>> # Sequence extraction examples
4327 >>> s = StringVal("hello")
4328 >>> Extract(s, 1, 3) # Extract 3 characters starting at position 1
4329 str.substr("hello", 1, 3)
4330 >>> simplify(Extract(StringVal("abcd"), 2, 1)) # Extract 1 character at position 2
4332 >>> simplify(Extract(StringVal("abcd"), 0, 2)) # Extract first 2 characters
4335 if isinstance(high, str):
4342 _z3_assert(low <= high,
"First argument must be greater than or equal to second argument")
4344 "First and second arguments must be non negative integers")
4345 _z3_assert(
is_bv(a),
"Third argument must be a Z3 bit-vector expression")
4351 _z3_assert(
is_bv(a)
or is_bv(b),
"First or second argument must be a Z3 bit-vector expression")
4355 """Create the Z3 expression (unsigned) `other <= self`.
4357 Use the operator <= for signed less than or equal to.
4359 >>> x, y = BitVecs('x y', 32)
4362 >>> (x <= y).sexpr()
4364 >>> ULE(x, y).sexpr()
4373 """Create the Z3 expression (unsigned) `other < self`.
4375 Use the operator < for signed less than.
4377 >>> x, y = BitVecs('x y', 32)
4382 >>> ULT(x, y).sexpr()
4391 """Create the Z3 expression (unsigned) `other >= self`.
4393 Use the operator >= for signed greater than or equal to.
4395 >>> x, y = BitVecs('x y', 32)
4398 >>> (x >= y).sexpr()
4400 >>> UGE(x, y).sexpr()
4409 """Create the Z3 expression (unsigned) `other > self`.
4411 Use the operator > for signed greater than.
4413 >>> x, y = BitVecs('x y', 32)
4418 >>> UGT(x, y).sexpr()
4427 """Create the Z3 expression (unsigned) division `self / other`.
4429 Use the operator / for signed division.
4431 >>> x = BitVec('x', 32)
4432 >>> y = BitVec('y', 32)
4435 >>> UDiv(x, y).sort()
4439 >>> UDiv(x, y).sexpr()
4448 """Create the Z3 expression (unsigned) remainder `self % other`.
4450 Use the operator % for signed modulus, and SRem() for signed remainder.
4452 >>> x = BitVec('x', 32)
4453 >>> y = BitVec('y', 32)
4456 >>> URem(x, y).sort()
4460 >>> URem(x, y).sexpr()
4469 """Create the Z3 expression signed remainder.
4471 Use the operator % for signed modulus, and URem() for unsigned remainder.
4473 >>> x = BitVec('x', 32)
4474 >>> y = BitVec('y', 32)
4477 >>> SRem(x, y).sort()
4481 >>> SRem(x, y).sexpr()
4490 """Create the Z3 expression logical right shift.
4492 Use the operator >> for the arithmetical right shift.
4494 >>> x, y = BitVecs('x y', 32)
4497 >>> (x >> y).sexpr()
4499 >>> LShR(x, y).sexpr()
4503 >>> BitVecVal(4, 3).as_signed_long()
4505 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
4507 >>> simplify(BitVecVal(4, 3) >> 1)
4509 >>> simplify(LShR(BitVecVal(4, 3), 1))
4511 >>> simplify(BitVecVal(2, 3) >> 1)
4513 >>> simplify(LShR(BitVecVal(2, 3), 1))
4522 """Return an expression representing `a` rotated to the left `b` times.
4524 >>> a, b = BitVecs('a b', 16)
4525 >>> RotateLeft(a, b)
4527 >>> simplify(RotateLeft(a, 0))
4529 >>> simplify(RotateLeft(a, 16))
4538 """Return an expression representing `a` rotated to the right `b` times.
4540 >>> a, b = BitVecs('a b', 16)
4541 >>> RotateRight(a, b)
4543 >>> simplify(RotateRight(a, 0))
4545 >>> simplify(RotateRight(a, 16))
4554 """Return a bit-vector expression with `n` extra sign-bits.
4556 >>> x = BitVec('x', 16)
4557 >>> n = SignExt(8, x)
4564 >>> v0 = BitVecVal(2, 2)
4569 >>> v = simplify(SignExt(6, v0))
4574 >>> print("%.x" % v.as_long())
4579 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4584 """Return a bit-vector expression with `n` extra zero-bits.
4586 >>> x = BitVec('x', 16)
4587 >>> n = ZeroExt(8, x)
4594 >>> v0 = BitVecVal(2, 2)
4599 >>> v = simplify(ZeroExt(6, v0))
4607 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4612 """Return an expression representing `n` copies of `a`.
4614 >>> x = BitVec('x', 8)
4615 >>> n = RepeatBitVec(4, x)
4620 >>> v0 = BitVecVal(10, 4)
4621 >>> print("%.x" % v0.as_long())
4623 >>> v = simplify(RepeatBitVec(4, v0))
4626 >>> print("%.x" % v.as_long())
4631 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4636 """Return the reduction-and expression of `a`."""
4638 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4643 """Return the reduction-or expression of `a`."""
4645 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4650 """A predicate the determines that bit-vector addition does not overflow"""
4657 """A predicate the determines that signed bit-vector addition does not underflow"""
4664 """A predicate the determines that bit-vector subtraction does not overflow"""
4671 """A predicate the determines that bit-vector subtraction does not underflow"""
4678 """A predicate the determines that bit-vector signed division does not overflow"""
4685 """A predicate the determines that bit-vector unary negation does not overflow"""
4687 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4692 """A predicate the determines that bit-vector multiplication does not overflow"""
4699 """A predicate the determines that bit-vector signed multiplication does not underflow"""
4715 """Return the domain of the array sort `self`.
4717 >>> A = ArraySort(IntSort(), BoolSort())
4724 """Return the domain of the array sort `self`.
4729 """Return the range of the array sort `self`.
4731 >>> A = ArraySort(IntSort(), BoolSort())
4739 """Array expressions. """
4742 """Return the array sort of the array expression `self`.
4744 >>> a = Array('a', IntSort(), BoolSort())
4751 """Shorthand for `self.sort().domain()`.
4753 >>> a = Array('a', IntSort(), BoolSort())
4760 """Shorthand for self.sort().domain_n(i)`."""
4764 """Shorthand for `self.sort().range()`.
4766 >>> a = Array('a', IntSort(), BoolSort())
4773 """Return the Z3 expression `self[arg]`.
4775 >>> a = Array('a', IntSort(), BoolSort())
4789 if isinstance(arg, tuple):
4790 args = [ar.sort().domain_n(i).cast(arg[i])
for i
in range(len(arg))]
4793 arg = ar.sort().domain().cast(arg)
4802 """Return `True` if `a` is a Z3 array expression.
4804 >>> a = Array('a', IntSort(), IntSort())
4807 >>> is_array(Store(a, 0, 1))
4812 return isinstance(a, ArrayRef)
4816 """Return `True` if `a` is a Z3 constant array.
4818 >>> a = K(IntSort(), 10)
4819 >>> is_const_array(a)
4821 >>> a = Array('a', IntSort(), IntSort())
4822 >>> is_const_array(a)
4829 """Return `True` if `a` is a Z3 constant array.
4831 >>> a = K(IntSort(), 10)
4834 >>> a = Array('a', IntSort(), IntSort())
4842 """Return `True` if `a` is a Z3 map array expression.
4844 >>> f = Function('f', IntSort(), IntSort())
4845 >>> b = Array('b', IntSort(), IntSort())
4858 """Return `True` if `a` is a Z3 default array expression.
4859 >>> d = Default(K(IntSort(), 10))
4863 return is_app_of(a, Z3_OP_ARRAY_DEFAULT)
4867 """Return the function declaration associated with a Z3 map array expression.
4869 >>> f = Function('f', IntSort(), IntSort())
4870 >>> b = Array('b', IntSort(), IntSort())
4872 >>> eq(f, get_map_func(a))
4876 >>> get_map_func(a)(0)
4891 """Return the Z3 array sort with the given domain and range sorts.
4893 >>> A = ArraySort(IntSort(), BoolSort())
4900 >>> AA = ArraySort(IntSort(), A)
4902 Array(Int, Array(Int, Bool))
4906 _z3_assert(len(sig) > 1,
"At least two arguments expected")
4907 arity = len(sig) - 1
4913 _z3_assert(s.ctx == r.ctx,
"Context mismatch")
4917 dom = (Sort * arity)()
4918 for i
in range(arity):
4924 """Return an array constant named `name` with the given domain and range sorts.
4926 >>> a = Array('a', IntSort(), IntSort())
4938 """Return a Z3 store array expression.
4940 >>> a = Array('a', IntSort(), IntSort())
4941 >>> i, v = Ints('i v')
4942 >>> s = Update(a, i, v)
4945 >>> prove(s[i] == v)
4948 >>> prove(Implies(i != j, s[j] == a[j]))
4956 raise Z3Exception(
"array update requires index and value arguments")
4960 i = a.sort().domain().cast(i)
4961 v = a.sort().range().cast(v)
4963 v = a.sort().range().cast(args[-1])
4964 idxs = [a.sort().domain_n(i).cast(args[i])
for i
in range(len(args)-1)]
4970 """ Return a default value for array expression.
4971 >>> b = K(IntSort(), 1)
4972 >>> prove(Default(b) == 1)
4981 """Return a Z3 store array expression.
4983 >>> a = Array('a', IntSort(), IntSort())
4984 >>> i, v = Ints('i v')
4985 >>> s = Store(a, i, v)
4988 >>> prove(s[i] == v)
4991 >>> prove(Implies(i != j, s[j] == a[j]))
4998 """Return a Z3 select array expression.
5000 >>> a = Array('a', IntSort(), IntSort())
5004 >>> eq(Select(a, i), a[i])
5014 """Return a Z3 map array expression.
5016 >>> f = Function('f', IntSort(), IntSort(), IntSort())
5017 >>> a1 = Array('a1', IntSort(), IntSort())
5018 >>> a2 = Array('a2', IntSort(), IntSort())
5019 >>> b = Map(f, a1, a2)
5022 >>> prove(b[0] == f(a1[0], a2[0]))
5027 _z3_assert(len(args) > 0,
"At least one Z3 array expression expected")
5030 _z3_assert(len(args) == f.arity(),
"Number of arguments mismatch")
5037 """Return a Z3 constant array expression.
5039 >>> a = K(IntSort(), 10)
5059 """Return extensionality index for one-dimensional arrays.
5060 >> a, b = Consts('a b', SetSort(IntSort()))
5070 """Return `True` if `a` is a Z3 array select application.
5072 >>> a = Array('a', IntSort(), IntSort())
5083 """Return `True` if `a` is a Z3 array store application.
5085 >>> a = Array('a', IntSort(), IntSort())
5088 >>> is_store(Store(a, 0, 1))
5101 """ Create a set sort over element sort s"""
5106 """Create the empty set
5107 >>> EmptySet(IntSort())
5115 """Create the full set
5116 >>> FullSet(IntSort())
5124 """ Take the union of sets
5125 >>> a = Const('a', SetSort(IntSort()))
5126 >>> b = Const('b', SetSort(IntSort()))
5137 """ Take the union of sets
5138 >>> a = Const('a', SetSort(IntSort()))
5139 >>> b = Const('b', SetSort(IntSort()))
5140 >>> SetIntersect(a, b)
5150 """ Add element e to set s
5151 >>> a = Const('a', SetSort(IntSort()))
5161 """ Remove element e to set s
5162 >>> a = Const('a', SetSort(IntSort()))
5172 """ The complement of set s
5173 >>> a = Const('a', SetSort(IntSort()))
5174 >>> SetComplement(a)
5182 """ The set difference of a and b
5183 >>> a = Const('a', SetSort(IntSort()))
5184 >>> b = Const('b', SetSort(IntSort()))
5185 >>> SetDifference(a, b)
5193 """ Check if e is a member of set s
5194 >>> a = Const('a', SetSort(IntSort()))
5204 """ Check if a is a subset of b
5205 >>> a = Const('a', SetSort(IntSort()))
5206 >>> b = Const('b', SetSort(IntSort()))
5221 """Return `True` if acc is pair of the form (String, Datatype or Sort). """
5222 if not isinstance(acc, tuple):
5226 return isinstance(acc[0], str)
and (isinstance(acc[1], Datatype)
or is_sort(acc[1]))
5230 """Helper class for declaring Z3 datatypes.
5232 >>> List = Datatype('List')
5233 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5234 >>> List.declare('nil')
5235 >>> List = List.create()
5236 >>> # List is now a Z3 declaration
5239 >>> List.cons(10, List.nil)
5241 >>> List.cons(10, List.nil).sort()
5243 >>> cons = List.cons
5247 >>> n = cons(1, cons(0, nil))
5249 cons(1, cons(0, nil))
5250 >>> simplify(cdr(n))
5252 >>> simplify(car(n))
5268 _z3_assert(isinstance(name, str),
"String expected")
5269 _z3_assert(isinstance(rec_name, str),
"String expected")
5272 "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)",
5277 """Declare constructor named `name` with the given accessors `args`.
5278 Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort
5279 or a reference to the datatypes being declared.
5281 In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
5282 declares the constructor named `cons` that builds a new List using an integer and a List.
5283 It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer
5284 of a `cons` cell, and `cdr` the list of a `cons` cell. After all constructors were declared,
5285 we use the method create() to create the actual datatype in Z3.
5287 >>> List = Datatype('List')
5288 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5289 >>> List.declare('nil')
5290 >>> List = List.create()
5293 _z3_assert(isinstance(name, str),
"String expected")
5294 _z3_assert(name !=
"",
"Constructor name cannot be empty")
5301 """Create a Z3 datatype based on the constructors declared using the method `declare()`.
5303 The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
5305 >>> List = Datatype('List')
5306 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5307 >>> List.declare('nil')
5308 >>> List = List.create()
5311 >>> List.cons(10, List.nil)
5318 """Auxiliary object used to create Z3 datatypes."""
5325 if self.
ctx.ref()
is not None and Z3_del_constructor
is not None:
5330 """Auxiliary object used to create Z3 datatypes."""
5337 if self.
ctx.ref()
is not None and Z3_del_constructor_list
is not None:
5342 """Create mutually recursive Z3 datatypes using 1 or more Datatype helper objects.
5344 In the following example we define a Tree-List using two mutually recursive datatypes.
5346 >>> TreeList = Datatype('TreeList')
5347 >>> Tree = Datatype('Tree')
5348 >>> # Tree has two constructors: leaf and node
5349 >>> Tree.declare('leaf', ('val', IntSort()))
5350 >>> # a node contains a list of trees
5351 >>> Tree.declare('node', ('children', TreeList))
5352 >>> TreeList.declare('nil')
5353 >>> TreeList.declare('cons', ('car', Tree), ('cdr', TreeList))
5354 >>> Tree, TreeList = CreateDatatypes(Tree, TreeList)
5355 >>> Tree.val(Tree.leaf(10))
5357 >>> simplify(Tree.val(Tree.leaf(10)))
5359 >>> n1 = Tree.node(TreeList.cons(Tree.leaf(10), TreeList.cons(Tree.leaf(20), TreeList.nil)))
5361 node(cons(leaf(10), cons(leaf(20), nil)))
5362 >>> n2 = Tree.node(TreeList.cons(n1, TreeList.nil))
5363 >>> simplify(n2 == n1)
5365 >>> simplify(TreeList.car(Tree.children(n2)) == n1)
5370 _z3_assert(len(ds) > 0,
"At least one Datatype must be specified")
5371 _z3_assert(all([isinstance(d, Datatype)
for d
in ds]),
"Arguments must be Datatypes")
5372 _z3_assert(all([d.ctx == ds[0].ctx
for d
in ds]),
"Context mismatch")
5373 _z3_assert(all([d.constructors != []
for d
in ds]),
"Non-empty Datatypes expected")
5376 names = (Symbol * num)()
5377 out = (Sort * num)()
5378 clists = (ConstructorList * num)()
5380 for i
in range(num):
5383 num_cs = len(d.constructors)
5384 cs = (Constructor * num_cs)()
5385 for j
in range(num_cs):
5386 c = d.constructors[j]
5391 fnames = (Symbol * num_fs)()
5392 sorts = (Sort * num_fs)()
5393 refs = (ctypes.c_uint * num_fs)()
5394 for k
in range(num_fs):
5398 if isinstance(ftype, Datatype):
5401 ds.count(ftype) == 1,
5402 "One and only one occurrence of each datatype is expected",
5405 refs[k] = ds.index(ftype)
5409 sorts[k] = ftype.ast
5418 for i
in range(num):
5420 num_cs = dref.num_constructors()
5421 for j
in range(num_cs):
5422 cref = dref.constructor(j)
5423 cref_name = cref.name()
5424 cref_arity = cref.arity()
5425 if cref.arity() == 0:
5427 setattr(dref, cref_name, cref)
5428 rref = dref.recognizer(j)
5429 setattr(dref,
"is_" + cref_name, rref)
5430 for k
in range(cref_arity):
5431 aref = dref.accessor(j, k)
5432 setattr(dref, aref.name(), aref)
5434 return tuple(result)
5438 """Datatype sorts."""
5441 """Return the number of constructors in the given Z3 datatype.
5443 >>> List = Datatype('List')
5444 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5445 >>> List.declare('nil')
5446 >>> List = List.create()
5447 >>> # List is now a Z3 declaration
5448 >>> List.num_constructors()
5454 """Return a constructor of the datatype `self`.
5456 >>> List = Datatype('List')
5457 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5458 >>> List.declare('nil')
5459 >>> List = List.create()
5460 >>> # List is now a Z3 declaration
5461 >>> List.num_constructors()
5463 >>> List.constructor(0)
5465 >>> List.constructor(1)
5473 """In Z3, each constructor has an associated recognizer predicate.
5475 If the constructor is named `name`, then the recognizer `is_name`.
5477 >>> List = Datatype('List')
5478 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5479 >>> List.declare('nil')
5480 >>> List = List.create()
5481 >>> # List is now a Z3 declaration
5482 >>> List.num_constructors()
5484 >>> List.recognizer(0)
5486 >>> List.recognizer(1)
5488 >>> simplify(List.is_nil(List.cons(10, List.nil)))
5490 >>> simplify(List.is_cons(List.cons(10, List.nil)))
5492 >>> l = Const('l', List)
5493 >>> simplify(List.is_cons(l))
5501 """In Z3, each constructor has 0 or more accessor.
5502 The number of accessors is equal to the arity of the constructor.
5504 >>> List = Datatype('List')
5505 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5506 >>> List.declare('nil')
5507 >>> List = List.create()
5508 >>> List.num_constructors()
5510 >>> List.constructor(0)
5512 >>> num_accs = List.constructor(0).arity()
5515 >>> List.accessor(0, 0)
5517 >>> List.accessor(0, 1)
5519 >>> List.constructor(1)
5521 >>> num_accs = List.constructor(1).arity()
5535 """Datatype expressions."""
5538 """Return the datatype sort of the datatype expression `self`."""
5542 """Return a new datatype expression with the specified field updated.
5545 field_accessor: The accessor function declaration for the field to update
5546 new_value: The new value for the field
5549 A new datatype expression with the field updated, other fields unchanged
5552 >>> Person = Datatype('Person')
5553 >>> Person.declare('person', ('name', StringSort()), ('age', IntSort()))
5554 >>> Person = Person.create()
5555 >>> person_age = Person.accessor(0, 1) # age accessor
5556 >>> p = Const('p', Person)
5557 >>> p2 = p.update_field(person_age, IntVal(30))
5568 """Create a reference to a sort that was declared, or will be declared, as a recursive datatype.
5571 name: name of the datatype sort
5572 params: optional list/tuple of sort parameters for parametric datatypes
5573 ctx: Z3 context (optional)
5576 >>> # Non-parametric datatype
5577 >>> TreeRef = DatatypeSort('Tree')
5578 >>> # Parametric datatype with one parameter
5579 >>> ListIntRef = DatatypeSort('List', [IntSort()])
5580 >>> # Parametric datatype with multiple parameters
5581 >>> PairRef = DatatypeSort('Pair', [IntSort(), BoolSort()])
5584 if params
is None or len(params) == 0:
5587 _params = (Sort * len(params))()
5588 for i
in range(len(params)):
5589 _params[i] = params[i].ast
5593 """Create a named tuple sort base on a set of underlying sorts
5595 >>> pair, mk_pair, (first, second) = TupleSort("pair", [IntSort(), StringSort()])
5598 projects = [(
"project%d" % i, sorts[i])
for i
in range(len(sorts))]
5599 tuple.declare(name, *projects)
5600 tuple = tuple.create()
5601 return tuple, tuple.constructor(0), [tuple.accessor(0, i)
for i
in range(len(sorts))]
5605 """Create a named tagged union sort base on a set of underlying sorts
5607 >>> sum, ((inject0, extract0), (inject1, extract1)) = DisjointSum("+", [IntSort(), StringSort()])
5610 for i
in range(len(sorts)):
5611 sum.declare(
"inject%d" % i, (
"project%d" % i, sorts[i]))
5613 return sum, [(sum.constructor(i), sum.accessor(i, 0))
for i
in range(len(sorts))]
5617 """Return a new enumeration sort named `name` containing the given values.
5619 The result is a pair (sort, list of constants).
5621 >>> Color, (red, green, blue) = EnumSort('Color', ['red', 'green', 'blue'])
5624 _z3_assert(isinstance(name, str),
"Name must be a string")
5625 _z3_assert(all([isinstance(v, str)
for v
in values]),
"Enumeration sort values must be strings")
5626 _z3_assert(len(values) > 0,
"At least one value expected")
5629 _val_names = (Symbol * num)()
5630 for i
in range(num):
5631 _val_names[i] =
to_symbol(values[i], ctx)
5632 _values = (FuncDecl * num)()
5633 _testers = (FuncDecl * num)()
5637 for i
in range(num):
5639 V = [a()
for a
in V]
5650 """Set of parameters used to configure Solvers, Tactics and Simplifiers in Z3.
5652 Consider using the function `args2params` to create instances of this object.
5667 if self.
ctx.ref()
is not None and Z3_params_dec_ref
is not None:
5671 """Set parameter name with value val."""
5673 _z3_assert(isinstance(name, str),
"parameter name must be a string")
5675 if isinstance(val, bool):
5679 elif isinstance(val, float):
5681 elif isinstance(val, str):
5691 _z3_assert(isinstance(ds, ParamDescrsRef),
"parameter description set expected")
5696 """Convert python arguments into a Z3_params object.
5697 A ':' is added to the keywords, and '_' is replaced with '-'
5699 >>> args2params(['model', True, 'relevancy', 2], {'elim_and' : True})
5700 (params model true relevancy 2 elim_and true)
5703 _z3_assert(len(arguments) % 2 == 0,
"Argument list must have an even number of elements.")
5719 """Set of parameter descriptions for Solvers, Tactics and Simplifiers in Z3.
5723 _z3_assert(isinstance(descr, ParamDescrs),
"parameter description object expected")
5729 return ParamsDescrsRef(self.
descr, self.
ctx)
5732 if self.
ctx.ref()
is not None and Z3_param_descrs_dec_ref
is not None:
5736 """Return the size of in the parameter description `self`.
5741 """Return the size of in the parameter description `self`.
5746 """Return the i-th parameter name in the parameter description `self`.
5751 """Return the kind of the parameter named `n`.
5756 """Return the documentation string of the parameter named `n`.
5777 """Goal is a collection of constraints we want to find a solution or show to be unsatisfiable (infeasible).
5779 Goals are processed using Tactics. A Tactic transforms a goal into a set of subgoals.
5780 A goal has a solution if one of its subgoals has a solution.
5781 A goal is unsatisfiable if all subgoals are unsatisfiable.
5784 def __init__(self, models=True, unsat_cores=False, proofs=False, ctx=None, goal=None):
5787 "If goal is different from None, then ctx must be also different from None")
5790 if self.
goal is None:
5795 if self.
goal is not None and self.
ctx.ref()
is not None and Z3_goal_dec_ref
is not None:
5799 """Return the depth of the goal `self`.
5800 The depth corresponds to the number of tactics applied to `self`.
5802 >>> x, y = Ints('x y')
5804 >>> g.add(x == 0, y >= x + 1)
5807 >>> r = Then('simplify', 'solve-eqs')(g)
5808 >>> # r has 1 subgoal
5817 """Return `True` if `self` contains the `False` constraints.
5819 >>> x, y = Ints('x y')
5821 >>> g.inconsistent()
5823 >>> g.add(x == 0, x == 1)
5826 >>> g.inconsistent()
5828 >>> g2 = Tactic('propagate-values')(g)[0]
5829 >>> g2.inconsistent()
5835 """Return the precision (under-approximation, over-approximation, or precise) of the goal `self`.
5838 >>> g.prec() == Z3_GOAL_PRECISE
5840 >>> x, y = Ints('x y')
5841 >>> g.add(x == y + 1)
5842 >>> g.prec() == Z3_GOAL_PRECISE
5844 >>> t = With(Tactic('add-bounds'), add_bound_lower=0, add_bound_upper=10)
5847 [x == y + 1, x <= 10, x >= 0, y <= 10, y >= 0]
5848 >>> g2.prec() == Z3_GOAL_PRECISE
5850 >>> g2.prec() == Z3_GOAL_UNDER
5856 """Alias for `prec()`.
5859 >>> g.precision() == Z3_GOAL_PRECISE
5865 """Return the number of constraints in the goal `self`.
5870 >>> x, y = Ints('x y')
5871 >>> g.add(x == 0, y > x)
5878 """Return the number of constraints in the goal `self`.
5883 >>> x, y = Ints('x y')
5884 >>> g.add(x == 0, y > x)
5891 """Return a constraint in the goal `self`.
5894 >>> x, y = Ints('x y')
5895 >>> g.add(x == 0, y > x)
5904 """Return a constraint in the goal `self`.
5907 >>> x, y = Ints('x y')
5908 >>> g.add(x == 0, y > x)
5916 if arg < 0
or arg >= len(self):
5918 return self.
get(arg)
5921 """Assert constraints into the goal.
5925 >>> g.assert_exprs(x > 0, x < 2)
5940 >>> g.append(x > 0, x < 2)
5951 >>> g.insert(x > 0, x < 2)
5962 >>> g.add(x > 0, x < 2)
5969 """Retrieve model from a satisfiable goal
5970 >>> a, b = Ints('a b')
5972 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
5973 >>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
5976 [Or(b == 0, b == 1), Not(0 <= b)]
5978 [Or(b == 0, b == 1), Not(1 <= b)]
5979 >>> # Remark: the subgoal r[0] is unsatisfiable
5980 >>> # Creating a solver for solving the second subgoal
5987 >>> # Model s.model() does not assign a value to `a`
5988 >>> # It is a model for subgoal `r[1]`, but not for goal `g`
5989 >>> # The method convert_model creates a model for `g` from a model for `r[1]`.
5990 >>> r[1].convert_model(s.model())
5994 _z3_assert(isinstance(model, ModelRef),
"Z3 Model expected")
5998 return obj_to_string(self)
6001 """Return a textual representation of the s-expression representing the goal."""
6005 """Return a textual representation of the goal in DIMACS format."""
6009 """Copy goal `self` to context `target`.
6017 >>> g2 = g.translate(c2)
6020 >>> g.ctx == main_ctx()
6024 >>> g2.ctx == main_ctx()
6028 _z3_assert(isinstance(target, Context),
"target must be a context")
6038 """Return a new simplified goal.
6040 This method is essentially invoking the simplify tactic.
6044 >>> g.add(x + 1 >= 2)
6047 >>> g2 = g.simplify()
6050 >>> # g was not modified
6055 return t.apply(self, *arguments, **keywords)[0]
6058 """Return goal `self` as a single Z3 expression.
6077 return And([self.
get(i)
for i
in range(len(self))], self.
ctx)
6087 """A collection (vector) of ASTs."""
6096 assert ctx
is not None
6101 if self.
vector is not None and self.
ctx.ref()
is not None and Z3_ast_vector_dec_ref
is not None:
6105 """Return the size of the vector `self`.
6110 >>> A.push(Int('x'))
6111 >>> A.push(Int('x'))
6118 """Return the AST at position `i`.
6121 >>> A.push(Int('x') + 1)
6122 >>> A.push(Int('y'))
6129 if isinstance(i, int):
6137 elif isinstance(i, slice):
6139 for ii
in range(*i.indices(self.
__len__())):
6147 """Update AST at position `i`.
6150 >>> A.push(Int('x') + 1)
6151 >>> A.push(Int('y'))
6160 if i < 0
or i >= self.
__len__():
6165 """Add `v` in the end of the vector.
6170 >>> A.push(Int('x'))
6177 """Resize the vector to `sz` elements.
6183 >>> for i in range(10): A[i] = Int('x')
6190 """Return `True` if the vector contains `item`.
6213 """Copy vector `self` to context `other_ctx`.
6219 >>> B = A.translate(c2)
6235 return obj_to_string(self)
6238 """Return a textual representation of the s-expression representing the vector."""
6249 """A mapping from ASTs to ASTs."""
6258 assert ctx
is not None
6266 if self.
map is not None and self.
ctx.ref()
is not None and Z3_ast_map_dec_ref
is not None:
6270 """Return the size of the map.
6276 >>> M[x] = IntVal(1)
6283 """Return `True` if the map contains key `key`.
6296 """Retrieve the value associated with key `key`.
6307 """Add/Update key `k` with value `v`.
6316 >>> M[x] = IntVal(1)
6326 """Remove the entry associated with key `k`.
6340 """Remove all entries from the map.
6345 >>> M[x+x] = IntVal(1)
6355 """Return an AstVector containing all keys in the map.
6360 >>> M[x+x] = IntVal(1)
6374 """Store the value of the interpretation of a function in a particular point."""
6385 if self.
ctx.ref()
is not None and Z3_func_entry_dec_ref
is not None:
6389 """Return the number of arguments in the given entry.
6391 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6393 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6398 >>> f_i.num_entries()
6400 >>> e = f_i.entry(0)
6407 """Return the value of argument `idx`.
6409 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6411 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6416 >>> f_i.num_entries()
6418 >>> e = f_i.entry(0)
6429 ... except IndexError:
6430 ... print("index error")
6438 """Return the value of the function at point `self`.
6440 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6442 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6447 >>> f_i.num_entries()
6449 >>> e = f_i.entry(0)
6460 """Return entry `self` as a Python list.
6461 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6463 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6468 >>> f_i.num_entries()
6470 >>> e = f_i.entry(0)
6475 args.append(self.
value())
6483 """Stores the interpretation of a function in a Z3 model."""
6488 if self.
f is not None:
6492 if self.
f is not None and self.
ctx.ref()
is not None and Z3_func_interp_dec_ref
is not None:
6497 Return the `else` value for a function interpretation.
6498 Return None if Z3 did not specify the `else` value for
6501 >>> f = Function('f', IntSort(), IntSort())
6503 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6509 >>> m[f].else_value()
6519 """Return the number of entries/points in the function interpretation `self`.
6521 >>> f = Function('f', IntSort(), IntSort())
6523 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6529 >>> m[f].num_entries()
6535 """Return the number of arguments for each entry in the function interpretation `self`.
6537 >>> f = Function('f', IntSort(), IntSort())
6539 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6549 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6551 >>> f = Function('f', IntSort(), IntSort())
6553 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6559 >>> m[f].num_entries()
6569 """Copy model 'self' to context 'other_ctx'.
6580 """Return the function interpretation as a Python list.
6581 >>> f = Function('f', IntSort(), IntSort())
6583 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6597 return obj_to_string(self)
6601 """Model/Solution of a satisfiability problem (aka system of constraints)."""
6604 assert ctx
is not None
6610 if self.
ctx.ref()
is not None and Z3_model_dec_ref
is not None:
6614 return obj_to_string(self)
6617 """Return a textual representation of the s-expression representing the model."""
6620 def eval(self, t, model_completion=False):
6621 """Evaluate the expression `t` in the model `self`.
6622 If `model_completion` is enabled, then a default interpretation is automatically added
6623 for symbols that do not have an interpretation in the model `self`.
6627 >>> s.add(x > 0, x < 2)
6640 >>> m.eval(y, model_completion=True)
6642 >>> # Now, m contains an interpretation for y
6649 raise Z3Exception(
"failed to evaluate expression in the model")
6652 """Alias for `eval`.
6656 >>> s.add(x > 0, x < 2)
6660 >>> m.evaluate(x + 1)
6662 >>> m.evaluate(x == 1)
6665 >>> m.evaluate(y + x)
6669 >>> m.evaluate(y, model_completion=True)
6671 >>> # Now, m contains an interpretation for y
6672 >>> m.evaluate(y + x)
6675 return self.
eval(t, model_completion)
6678 """Return the number of constant and function declarations in the model `self`.
6680 >>> f = Function('f', IntSort(), IntSort())
6683 >>> s.add(x > 0, f(x) != x)
6692 return num_consts + num_funcs
6695 """Return the interpretation for a given declaration or constant.
6697 >>> f = Function('f', IntSort(), IntSort())
6700 >>> s.add(x > 0, x < 2, f(x) == 0)
6710 _z3_assert(isinstance(decl, FuncDeclRef)
or is_const(decl),
"Z3 declaration expected")
6714 if decl.arity() == 0:
6716 if _r.value
is None:
6732 sz = fi.num_entries()
6736 e =
Store(e, fe.arg_value(0), fe.value())
6747 """Return the number of uninterpreted sorts that contain an interpretation in the model `self`.
6749 >>> A = DeclareSort('A')
6750 >>> a, b = Consts('a b', A)
6762 """Return the uninterpreted sort at position `idx` < self.num_sorts().
6764 >>> A = DeclareSort('A')
6765 >>> B = DeclareSort('B')
6766 >>> a1, a2 = Consts('a1 a2', A)
6767 >>> b1, b2 = Consts('b1 b2', B)
6769 >>> s.add(a1 != a2, b1 != b2)
6785 """Return all uninterpreted sorts that have an interpretation in the model `self`.
6787 >>> A = DeclareSort('A')
6788 >>> B = DeclareSort('B')
6789 >>> a1, a2 = Consts('a1 a2', A)
6790 >>> b1, b2 = Consts('b1 b2', B)
6792 >>> s.add(a1 != a2, b1 != b2)
6802 """Return the interpretation for the uninterpreted sort `s` in the model `self`.
6804 >>> A = DeclareSort('A')
6805 >>> a, b = Consts('a b', A)
6811 >>> m.get_universe(A)
6815 _z3_assert(isinstance(s, SortRef),
"Z3 sort expected")
6822 """If `idx` is an integer, then the declaration at position `idx` in the model `self` is returned.
6823 If `idx` is a declaration, then the actual interpretation is returned.
6825 The elements can be retrieved using position or the actual declaration.
6827 >>> f = Function('f', IntSort(), IntSort())
6830 >>> s.add(x > 0, x < 2, f(x) == 0)
6844 >>> for d in m: print("%s -> %s" % (d, m[d]))
6851 if idx < 0
or idx >= len(self):
6854 if (idx < num_consts):
6858 if isinstance(idx, FuncDeclRef):
6862 if isinstance(idx, SortRef):
6865 _z3_assert(
False,
"Integer, Z3 declaration, or Z3 constant expected. Use model.eval instead for complicated expressions")
6869 """Return a list with all symbols that have an interpretation in the model `self`.
6870 >>> f = Function('f', IntSort(), IntSort())
6873 >>> s.add(x > 0, x < 2, f(x) == 0)
6888 """Update the interpretation of a constant"""
6891 if is_func_decl(x)
and x.arity() != 0
and isinstance(value, FuncInterp):
6895 for i
in range(value.num_entries()):
6900 v.push(e.arg_value(j))
6905 raise Z3Exception(
"Expecting 0-ary function or constant expression")
6910 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
6913 _z3_assert(isinstance(target, Context),
"argument must be a Z3 context")
6918 """Perform model-based projection on fml with respect to vars.
6919 Assume that the model satisfies fml. Then compute a projection fml_p, such
6920 that vars do not occur free in fml_p, fml_p is true in the model and
6921 fml_p => exists vars . fml
6923 ctx = self.
ctx.ref()
6924 _vars = (Ast * len(vars))()
6925 for i
in range(len(vars)):
6926 _vars[i] = vars[i].as_ast()
6930 """Perform model-based projection, but also include realizer terms for the projected variables"""
6931 ctx = self.
ctx.ref()
6932 _vars = (Ast * len(vars))()
6933 for i
in range(len(vars)):
6934 _vars[i] = vars[i].as_ast()
6936 result = Z3_qe_model_project_with_witness(ctx, self.
model, len(vars), _vars, fml.ast, defs.map)
6951 for k, v
in eval.items():
6952 mdl.update_value(k, v)
6957 """Return true if n is a Z3 expression of the form (_ as-array f)."""
6958 return isinstance(n, ExprRef)
and Z3_is_as_array(n.ctx.ref(), n.as_ast())
6962 """Return the function declaration f associated with a Z3 expression of the form (_ as-array f)."""
6975 """Statistics for `Solver.check()`."""
6986 if self.
ctx.ref()
is not None and Z3_stats_dec_ref
is not None:
6993 out.write(u(
'<table border="1" cellpadding="2" cellspacing="0">'))
6996 out.write(u(
'<tr style="background-color:#CFCFCF">'))
6999 out.write(u(
"<tr>"))
7001 out.write(u(
"<td>%s</td><td>%s</td></tr>" % (k, v)))
7002 out.write(u(
"</table>"))
7003 return out.getvalue()
7008 """Return the number of statistical counters.
7011 >>> s = Then('simplify', 'nlsat').solver()
7015 >>> st = s.statistics()
7022 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
7025 >>> s = Then('simplify', 'nlsat').solver()
7029 >>> st = s.statistics()
7033 ('nlsat propagations', 2)
7035 ('nlsat restarts', 1)
7037 if idx >= len(self):
7046 """Return the list of statistical counters.
7049 >>> s = Then('simplify', 'nlsat').solver()
7053 >>> st = s.statistics()
7058 """Return the value of a particular statistical counter.
7061 >>> s = Then('simplify', 'nlsat').solver()
7065 >>> st = s.statistics()
7066 >>> st.get_key_value('nlsat propagations')
7069 for idx
in range(len(self)):
7075 raise Z3Exception(
"unknown key")
7078 """Access the value of statistical using attributes.
7080 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
7081 we should use '_' (e.g., 'nlsat_propagations').
7084 >>> s = Then('simplify', 'nlsat').solver()
7088 >>> st = s.statistics()
7089 >>> st.nlsat_propagations
7094 key = name.replace(
"_",
" ")
7098 raise AttributeError
7108 """Represents the result of a satisfiability check: sat, unsat, unknown.
7114 >>> isinstance(r, CheckSatResult)
7125 return isinstance(other, CheckSatResult)
and self.
r == other.r
7128 return not self.
__eq__(other)
7132 if self.
r == Z3_L_TRUE:
7134 elif self.
r == Z3_L_FALSE:
7135 return "<b>unsat</b>"
7137 return "<b>unknown</b>"
7139 if self.
r == Z3_L_TRUE:
7141 elif self.
r == Z3_L_FALSE:
7147 in_html = in_html_mode()
7150 set_html_mode(in_html)
7161 Solver API provides methods for implementing the main SMT 2.0 commands:
7162 push, pop, check, get-model, etc.
7165 def __init__(self, solver=None, ctx=None, logFile=None):
7166 assert solver
is None or ctx
is not None
7175 if logFile
is not None:
7176 self.
set(
"smtlib2_log", logFile)
7179 if self.
solver is not None and self.
ctx.ref()
is not None and Z3_solver_dec_ref
is not None:
7190 """Set a configuration option.
7191 The method `help()` return a string containing all available options.
7194 >>> # The option MBQI can be set using three different approaches.
7195 >>> s.set(mbqi=True)
7196 >>> s.set('MBQI', True)
7197 >>> s.set(':mbqi', True)
7203 """Create a backtracking point.
7225 """Backtrack \\c num backtracking points.
7247 """Return the current number of backtracking points.
7265 """Remove all asserted constraints and backtracking points created using `push()`.
7279 """Assert constraints into the solver.
7283 >>> s.assert_exprs(x > 0, x < 2)
7290 if isinstance(arg, Goal)
or isinstance(arg, AstVector):
7298 """Assert constraints into the solver.
7302 >>> s.add(x > 0, x < 2)
7313 """Assert constraints into the solver.
7317 >>> s.append(x > 0, x < 2)
7324 """Assert constraints into the solver.
7328 >>> s.insert(x > 0, x < 2)
7335 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
7337 If `p` is a string, it will be automatically converted into a Boolean constant.
7342 >>> s.set(unsat_core=True)
7343 >>> s.assert_and_track(x > 0, 'p1')
7344 >>> s.assert_and_track(x != 1, 'p2')
7345 >>> s.assert_and_track(x < 0, p3)
7346 >>> print(s.check())
7348 >>> c = s.unsat_core()
7358 if isinstance(p, str):
7360 _z3_assert(isinstance(a, BoolRef),
"Boolean expression expected")
7365 """Check whether the assertions in the given solver plus the optional assumptions are consistent or not.
7371 >>> s.add(x > 0, x < 2)
7374 >>> s.model().eval(x)
7380 >>> s.add(2**x == 4)
7386 num = len(assumptions)
7387 _assumptions = (Ast * num)()
7388 for i
in range(num):
7389 _assumptions[i] = s.cast(assumptions[i]).as_ast()
7394 """Return a model for the last `check()`.
7396 This function raises an exception if
7397 a model is not available (e.g., last `check()` returned unsat).
7401 >>> s.add(a + 2 == 0)
7410 raise Z3Exception(
"model is not available")
7413 """Import model converter from other into the current solver"""
7414 Z3_solver_import_model_converter(self.ctx.ref(), other.solver, self.solver)
7416 def interrupt(self):
7417 """Interrupt the execution of the solver object.
7418 Remarks: This ensures that the interrupt applies only
7419 to the given solver object and it applies only if it is running.
7421 Z3_solver_interrupt(self.ctx.ref(), self.solver)
7423 def unsat_core(self):
7424 """Return a subset (as an AST vector) of the assumptions provided to the last check().
7426 These are the assumptions Z3 used in the unsatisfiability proof.
7427 Assumptions are available in Z3. They are used to extract unsatisfiable cores.
7428 They may be also used to "retract" assumptions. Note that, assumptions are not really
7429 "soft constraints", but they can be used to implement them.
7431 >>> p1, p2, p3 = Bools('p1 p2 p3')
7432 >>> x, y = Ints('x y')
7434 >>> s.add(Implies(p1, x > 0))
7435 >>> s.add(Implies(p2, y > x))
7436 >>> s.add(Implies(p2, y < 1))
7437 >>> s.add(Implies(p3, y > -3))
7438 >>> s.check(p1, p2, p3)
7440 >>> core = s.unsat_core()
7449 >>> # "Retracting" p2
7453 return AstVector(Z3_solver_get_unsat_core(self.ctx.ref(), self.solver), self.ctx)
7455 def consequences(self, assumptions, variables):
7456 """Determine fixed values for the variables based on the solver state and assumptions.
7458 >>> a, b, c, d = Bools('a b c d')
7459 >>> s.add(Implies(a,b), Implies(b, c))
7460 >>> s.consequences([a],[b,c,d])
7461 (sat, [Implies(a, b), Implies(a, c)])
7462 >>> s.consequences([Not(c),d],[a,b,c,d])
7463 (sat, [Implies(d, d), Implies(Not(c), Not(c)), Implies(Not(c), Not(b)), Implies(Not(c), Not(a))])
7465 if isinstance(assumptions, list):
7466 _asms = AstVector(None, self.ctx)
7467 for a in assumptions:
7470 if isinstance(variables, list):
7471 _vars = AstVector(None, self.ctx)
7475 _z3_assert(isinstance(assumptions, AstVector), "ast vector expected")
7476 _z3_assert(isinstance(variables, AstVector), "ast vector expected")
7477 consequences = AstVector(None, self.ctx)
7478 r = Z3_solver_get_consequences(self.ctx.ref(), self.solver, assumptions.vector,
7479 variables.vector, consequences.vector)
7480 sz = len(consequences)
7481 consequences = [consequences[i] for i in range(sz)]
7482 return CheckSatResult(r), consequences
7484 def from_file(self, filename):
7485 """Parse assertions from a file"""
7486 Z3_solver_from_file(self.ctx.ref(), self.solver, filename)
7488 def from_string(self, s):
7489 """Parse assertions from a string"""
7490 Z3_solver_from_string(self.ctx.ref(), self.solver, s)
7492 def cube(self, vars=None):
7494 The method takes an optional set of variables that restrict which
7495 variables may be used as a starting point for cubing.
7496 If vars is not None, then the first case split is based on a variable in
7499 self.cube_vs = AstVector(None, self.ctx)
7500 if vars is not None:
7502 self.cube_vs.push(v)
7504 lvl = self.backtrack_level
7505 self.backtrack_level = 4000000000
7506 r = AstVector(Z3_solver_cube(self.ctx.ref(), self.solver, self.cube_vs.vector, lvl), self.ctx)
7507 if (len(r) == 1 and is_false(r[0])):
7513 def cube_vars(self):
7514 """Access the set of variables that were touched by the most recently generated cube.
7515 This set of variables can be used as a starting point for additional cubes.
7516 The idea is that variables that appear in clauses that are reduced by the most recent
7517 cube are likely more useful to cube on."""
7521 """Retrieve congruence closure root of the term t relative to the current search state
7522 The function primarily works for SimpleSolver. Terms and variables that are
7523 eliminated during pre-processing are not visible to the congruence closure.
7525 t = _py2expr(t, self.ctx)
7526 return _to_expr_ref(Z3_solver_congruence_root(self.ctx.ref(), self.solver, t.ast), self.ctx)
7529 """Retrieve congruence closure sibling of the term t relative to the current search state
7530 The function primarily works for SimpleSolver. Terms and variables that are
7531 eliminated during pre-processing are not visible to the congruence closure.
7533 t = _py2expr(t, self.ctx)
7534 return _to_expr_ref(Z3_solver_congruence_next(self.ctx.ref(), self.solver, t.ast), self.ctx)
7536 def explain_congruent(self, a, b):
7537 """Explain congruence of a and b relative to the current search state"""
7538 a = _py2expr(a, self.ctx)
7539 b = _py2expr(b, self.ctx)
7540 return _to_expr_ref(Z3_solver_congruence_explain(self.ctx.ref(), self.solver, a.ast, b.ast), self.ctx)
7543 def solve_for(self, ts):
7544 """Retrieve a solution for t relative to linear equations maintained in the current state."""
7545 vars = AstVector(ctx=self.ctx);
7546 terms = AstVector(ctx=self.ctx);
7547 guards = AstVector(ctx=self.ctx);
7549 t = _py2expr(t, self.ctx)
7551 Z3_solver_solve_for(self.ctx.ref(), self.solver, vars.vector, terms.vector, guards.vector)
7552 return [(vars[i], terms[i], guards[i]) for i in range(len(vars))]
7556 """Return a proof for the last `check()`. Proof construction must be enabled."""
7557 return _to_expr_ref(Z3_solver_get_proof(self.ctx.ref(), self.solver), self.ctx)
7559 def assertions(self):
7560 """Return an AST vector containing all added constraints.
7571 return AstVector(Z3_solver_get_assertions(self.ctx.ref(), self.solver), self.ctx)
7574 """Return an AST vector containing all currently inferred units.
7576 return AstVector(Z3_solver_get_units(self.ctx.ref(), self.solver), self.ctx)
7578 def non_units(self):
7579 """Return an AST vector containing all atomic formulas in solver state that are not units.
7581 return AstVector(Z3_solver_get_non_units(self.ctx.ref(), self.solver), self.ctx)
7583 def trail_levels(self):
7584 """Return trail and decision levels of the solver state after a check() call.
7586 trail = self.trail()
7587 levels = (ctypes.c_uint * len(trail))()
7588 Z3_solver_get_levels(self.ctx.ref(), self.solver, trail.vector, len(trail), levels)
7589 return trail, levels
7591 def set_initial_value(self, var, value):
7592 """initialize the solver's state by setting the initial value of var to value
7595 value = s.cast(value)
7596 Z3_solver_set_initial_value(self.ctx.ref(), self.solver, var.ast, value.ast)
7599 """Return trail of the solver state after a check() call.
7601 return AstVector(Z3_solver_get_trail(self.ctx.ref(), self.solver), self.ctx)
7603 def statistics(self):
7604 """Return statistics for the last `check()`.
7606 >>> s = SimpleSolver()
7611 >>> st = s.statistics()
7612 >>> st.get_key_value('final checks')
7619 return Statistics(Z3_solver_get_statistics(self.ctx.ref(), self.solver), self.ctx)
7621 def reason_unknown(self):
7622 """Return a string describing why the last `check()` returned `unknown`.
7625 >>> s = SimpleSolver()
7626 >>> s.add(x == 2**x)
7629 >>> s.reason_unknown()
7630 '(incomplete (theory arithmetic))'
7632 return Z3_solver_get_reason_unknown(self.ctx.ref(), self.solver)
7635 """Display a string describing all available options."""
7636 print(Z3_solver_get_help(self.ctx.ref(), self.solver))
7638 def param_descrs(self):
7639 """Return the parameter description set."""
7640 return ParamDescrsRef(Z3_solver_get_param_descrs(self.ctx.ref(), self.solver), self.ctx)
7643 """Return a formatted string with all added constraints."""
7644 return obj_to_string(self)
7646 def translate(self, target):
7647 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
7651 >>> s1 = Solver(ctx=c1)
7652 >>> s2 = s1.translate(c2)
7655 _z3_assert(isinstance(target, Context), "argument must be a Z3 context")
7656 solver = Z3_solver_translate(self.ctx.ref(), self.solver, target.ref())
7657 return Solver(solver, target)
7660 return self.translate(self.ctx)
7662 def __deepcopy__(self, memo={}):
7663 return self.translate(self.ctx)
7666 """Return a formatted string (in Lisp-like format) with all added constraints.
7668 return Z3_solver_to_string(self.ctx.ref(), self.solver)
7670 def dimacs(self, include_names=True):
7671 """Return a textual representation of the solver in DIMACS format."""
7672 return Z3_solver_to_dimacs_string(self.ctx.ref(), self.solver, include_names)
7675 """return SMTLIB2 formatted benchmark for solver's assertions"""
7676 es = self.assertions()
7682 for i in range(sz1):
7683 v[i] = es[i].as_ast()
7685 e = es[sz1].as_ast()
7687 e = BoolVal(True, self.ctx).as_ast()
7688 return Z3_benchmark_to_smtlib_string(
7689 self.ctx.ref(), "benchmark generated from python API", "", "unknown", "", sz1, v, e,
7692 def solutions(self, t):
7693 """Returns an iterator over solutions that satisfy the constraints.
7695 The parameter `t` is an expression whose values should be returned.
7698 >>> x, y, z = Ints("x y z")
7699 >>> s.add(x * x == 4)
7700 >>> print(list(s.solutions(x)))
7703 >>> s.add(x >= 0, x < 10)
7704 >>> print(list(s.solutions(x)))
7705 [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
7707 >>> s.add(x >= 0, y < 10, y == 2*x)
7708 >>> print(list(s.solutions([x, y])))
7709 [[0, 0], [1, 2], [2, 4], [3, 6], [4, 8]]
7712 s.add(self.assertions())
7714 if isinstance(t, (list, tuple)):
7715 while s.check() == sat:
7716 result = [s.model().eval(t_, model_completion=True) for t_ in t]
7718 s.add(*(t_ != result_ for t_, result_ in zip(t, result)))
7720 while s.check() == sat:
7721 result = s.model().eval(t, model_completion=True)
7726def SolverFor(logic, ctx=None, logFile=None):
7727 """Create a solver customized for the given logic.
7729 The parameter `logic` is a string. It should be contains
7730 the name of a SMT-LIB logic.
7731 See http://www.smtlib.org/ for the name of all available logics.
7733 >>> s = SolverFor("QF_LIA")
7743 logic = to_symbol(logic)
7744 return Solver(Z3_mk_solver_for_logic(ctx.ref(), logic), ctx, logFile)
7747def SimpleSolver(ctx=None, logFile=None):
7748 """Return a simple general purpose solver with limited amount of preprocessing.
7750 >>> s = SimpleSolver()
7757 return Solver(Z3_mk_simple_solver(ctx.ref()), ctx, logFile)
7759#########################################
7763#########################################
7766class Fixedpoint(Z3PPObject):
7767 """Fixedpoint API provides methods for solving with recursive predicates"""
7769 def __init__(self, fixedpoint=None, ctx=None):
7770 assert fixedpoint is None or ctx is not None
7771 self.ctx = _get_ctx(ctx)
7772 self.fixedpoint = None
7773 if fixedpoint is None:
7774 self.fixedpoint = Z3_mk_fixedpoint(self.ctx.ref())
7776 self.fixedpoint = fixedpoint
7777 Z3_fixedpoint_inc_ref(self.ctx.ref(), self.fixedpoint)
7780 def __deepcopy__(self, memo={}):
7781 return FixedPoint(self.fixedpoint, self.ctx)
7784 if self.fixedpoint is not None and self.ctx.ref() is not None and Z3_fixedpoint_dec_ref is not None:
7785 Z3_fixedpoint_dec_ref(self.ctx.ref(), self.fixedpoint)
7787 def set(self, *args, **keys):
7788 """Set a configuration option. The method `help()` return a string containing all available options.
7790 p = args2params(args, keys, self.ctx)
7791 Z3_fixedpoint_set_params(self.ctx.ref(), self.fixedpoint, p.params)
7794 """Display a string describing all available options."""
7795 print(Z3_fixedpoint_get_help(self.ctx.ref(), self.fixedpoint))
7797 def param_descrs(self):
7798 """Return the parameter description set."""
7799 return ParamDescrsRef(Z3_fixedpoint_get_param_descrs(self.ctx.ref(), self.fixedpoint), self.ctx)
7801 def assert_exprs(self, *args):
7802 """Assert constraints as background axioms for the fixedpoint solver."""
7803 args = _get_args(args)
7804 s = BoolSort(self.ctx)
7806 if isinstance(arg, Goal) or isinstance(arg, AstVector):
7808 f = self.abstract(f)
7809 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, f.as_ast())
7812 arg = self.abstract(arg)
7813 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, arg.as_ast())
7815 def add(self, *args):
7816 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7817 self.assert_exprs(*args)
7819 def __iadd__(self, fml):
7823 def append(self, *args):
7824 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7825 self.assert_exprs(*args)
7827 def insert(self, *args):
7828 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7829 self.assert_exprs(*args)
7831 def add_rule(self, head, body=None, name=None):
7832 """Assert rules defining recursive predicates to the fixedpoint solver.
7835 >>> s = Fixedpoint()
7836 >>> s.register_relation(a.decl())
7837 >>> s.register_relation(b.decl())
7845 name = to_symbol(name, self.ctx)
7847 head = self.abstract(head)
7848 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, head.as_ast(), name)
7850 body = _get_args(body)
7851 f = self.abstract(Implies(And(body, self.ctx), head))
7852 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7854 def rule(self, head, body=None, name=None):
7855 """Assert rules defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7856 self.add_rule(head, body, name)
7858 def fact(self, head, name=None):
7859 """Assert facts defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7860 self.add_rule(head, None, name)
7862 def query(self, *query):
7863 """Query the fixedpoint engine whether formula is derivable.
7864 You can also pass an tuple or list of recursive predicates.
7866 query = _get_args(query)
7868 if sz >= 1 and isinstance(query[0], FuncDeclRef):
7869 _decls = (FuncDecl * sz)()
7874 r = Z3_fixedpoint_query_relations(self.ctx.ref(), self.fixedpoint, sz, _decls)
7879 query = And(query, self.ctx)
7880 query = self.abstract(query, False)
7881 r = Z3_fixedpoint_query(self.ctx.ref(), self.fixedpoint, query.as_ast())
7882 return CheckSatResult(r)
7884 def query_from_lvl(self, lvl, *query):
7885 """Query the fixedpoint engine whether formula is derivable starting at the given query level.
7887 query = _get_args(query)
7889 if sz >= 1 and isinstance(query[0], FuncDecl):
7890 _z3_assert(False, "unsupported")
7896 query = self.abstract(query, False)
7897 r = Z3_fixedpoint_query_from_lvl(self.ctx.ref(), self.fixedpoint, query.as_ast(), lvl)
7898 return CheckSatResult(r)
7900 def update_rule(self, head, body, name):
7904 name = to_symbol(name, self.ctx)
7905 body = _get_args(body)
7906 f = self.abstract(Implies(And(body, self.ctx), head))
7907 Z3_fixedpoint_update_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7909 def get_answer(self):
7910 """Retrieve answer from last query call."""
7911 r = Z3_fixedpoint_get_answer(self.ctx.ref(), self.fixedpoint)
7912 return _to_expr_ref(r, self.ctx)
7914 def get_ground_sat_answer(self):
7915 """Retrieve a ground cex from last query call."""
7916 r = Z3_fixedpoint_get_ground_sat_answer(self.ctx.ref(), self.fixedpoint)
7917 return _to_expr_ref(r, self.ctx)
7919 def get_rules_along_trace(self):
7920 """retrieve rules along the counterexample trace"""
7921 return AstVector(Z3_fixedpoint_get_rules_along_trace(self.ctx.ref(), self.fixedpoint), self.ctx)
7923 def get_rule_names_along_trace(self):
7924 """retrieve rule names along the counterexample trace"""
7925 # this is a hack as I don't know how to return a list of symbols from C++;
7926 # obtain names as a single string separated by semicolons
7927 names = _symbol2py(self.ctx, Z3_fixedpoint_get_rule_names_along_trace(self.ctx.ref(), self.fixedpoint))
7928 # split into individual names
7929 return names.split(";")
7931 def get_num_levels(self, predicate):
7932 """Retrieve number of levels used for predicate in PDR engine"""
7933 return Z3_fixedpoint_get_num_levels(self.ctx.ref(), self.fixedpoint, predicate.ast)
7935 def get_cover_delta(self, level, predicate):
7936 """Retrieve properties known about predicate for the level'th unfolding.
7937 -1 is treated as the limit (infinity)
7939 r = Z3_fixedpoint_get_cover_delta(self.ctx.ref(), self.fixedpoint, level, predicate.ast)
7940 return _to_expr_ref(r, self.ctx)
7942 def add_cover(self, level, predicate, property):
7943 """Add property to predicate for the level'th unfolding.
7944 -1 is treated as infinity (infinity)
7946 Z3_fixedpoint_add_cover(self.ctx.ref(), self.fixedpoint, level, predicate.ast, property.ast)
7948 def register_relation(self, *relations):
7949 """Register relation as recursive"""
7950 relations = _get_args(relations)
7952 Z3_fixedpoint_register_relation(self.ctx.ref(), self.fixedpoint, f.ast)
7954 def set_predicate_representation(self, f, *representations):
7955 """Control how relation is represented"""
7956 representations = _get_args(representations)
7957 representations = [to_symbol(s) for s in representations]
7958 sz = len(representations)
7959 args = (Symbol * sz)()
7961 args[i] = representations[i]
7962 Z3_fixedpoint_set_predicate_representation(self.ctx.ref(), self.fixedpoint, f.ast, sz, args)
7964 def parse_string(self, s):
7965 """Parse rules and queries from a string"""
7966 return AstVector(Z3_fixedpoint_from_string(self.ctx.ref(), self.fixedpoint, s), self.ctx)
7968 def parse_file(self, f):
7969 """Parse rules and queries from a file"""
7970 return AstVector(Z3_fixedpoint_from_file(self.ctx.ref(), self.fixedpoint, f), self.ctx)
7972 def get_rules(self):
7973 """retrieve rules that have been added to fixedpoint context"""
7974 return AstVector(Z3_fixedpoint_get_rules(self.ctx.ref(), self.fixedpoint), self.ctx)
7976 def get_assertions(self):
7977 """retrieve assertions that have been added to fixedpoint context"""
7978 return AstVector(Z3_fixedpoint_get_assertions(self.ctx.ref(), self.fixedpoint), self.ctx)
7981 """Return a formatted string with all added rules and constraints."""
7985 """Return a formatted string (in Lisp-like format) with all added constraints.
7986 We say the string is in s-expression format.
7988 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, 0, (Ast * 0)())
7990 def to_string(self, queries):
7991 """Return a formatted string (in Lisp-like format) with all added constraints.
7992 We say the string is in s-expression format.
7993 Include also queries.
7995 args, len = _to_ast_array(queries)
7996 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, len, args)
7998 def statistics(self):
7999 """Return statistics for the last `query()`.
8001 return Statistics(Z3_fixedpoint_get_statistics(self.ctx.ref(), self.fixedpoint), self.ctx)
8003 def reason_unknown(self):
8004 """Return a string describing why the last `query()` returned `unknown`.
8006 return Z3_fixedpoint_get_reason_unknown(self.ctx.ref(), self.fixedpoint)
8008 def declare_var(self, *vars):
8009 """Add variable or several variables.
8010 The added variable or variables will be bound in the rules
8013 vars = _get_args(vars)
8017 def abstract(self, fml, is_forall=True):
8021 return ForAll(self.vars, fml)
8023 return Exists(self.vars, fml)
8026#########################################
8030#########################################
8032class FiniteDomainSortRef(SortRef):
8033 """Finite domain sort."""
8036 """Return the size of the finite domain sort"""
8037 r = (ctypes.c_ulonglong * 1)()
8038 if Z3_get_finite_domain_sort_size(self.ctx_ref(), self.ast, r):
8041 raise Z3Exception("Failed to retrieve finite domain sort size")
8044def FiniteDomainSort(name, sz, ctx=None):
8045 """Create a named finite domain sort of a given size sz"""
8046 if not isinstance(name, Symbol):
8047 name = to_symbol(name)
8049 return FiniteDomainSortRef(Z3_mk_finite_domain_sort(ctx.ref(), name, sz), ctx)
8052def is_finite_domain_sort(s):
8053 """Return True if `s` is a Z3 finite-domain sort.
8055 >>> is_finite_domain_sort(FiniteDomainSort('S', 100))
8057 >>> is_finite_domain_sort(IntSort())
8060 return isinstance(s, FiniteDomainSortRef)
8063class FiniteDomainRef(ExprRef):
8064 """Finite-domain expressions."""
8067 """Return the sort of the finite-domain expression `self`."""
8068 return FiniteDomainSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
8070 def as_string(self):
8071 """Return a Z3 floating point expression as a Python string."""
8072 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
8075def is_finite_domain(a):
8076 """Return `True` if `a` is a Z3 finite-domain expression.
8078 >>> s = FiniteDomainSort('S', 100)
8079 >>> b = Const('b', s)
8080 >>> is_finite_domain(b)
8082 >>> is_finite_domain(Int('x'))
8085 return isinstance(a, FiniteDomainRef)
8088class FiniteDomainNumRef(FiniteDomainRef):
8089 """Integer values."""
8092 """Return a Z3 finite-domain numeral as a Python long (bignum) numeral.
8094 >>> s = FiniteDomainSort('S', 100)
8095 >>> v = FiniteDomainVal(3, s)
8101 return int(self.as_string())
8103 def as_string(self):
8104 """Return a Z3 finite-domain numeral as a Python string.
8106 >>> s = FiniteDomainSort('S', 100)
8107 >>> v = FiniteDomainVal(42, s)
8111 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
8114def FiniteDomainVal(val, sort, ctx=None):
8115 """Return a Z3 finite-domain value. If `ctx=None`, then the global context is used.
8117 >>> s = FiniteDomainSort('S', 256)
8118 >>> FiniteDomainVal(255, s)
8120 >>> FiniteDomainVal('100', s)
8124 _z3_assert(is_finite_domain_sort(sort), "Expected finite-domain sort")
8126 return FiniteDomainNumRef(Z3_mk_numeral(ctx.ref(), _to_int_str(val), sort.ast), ctx)
8129def is_finite_domain_value(a):
8130 """Return `True` if `a` is a Z3 finite-domain value.
8132 >>> s = FiniteDomainSort('S', 100)
8133 >>> b = Const('b', s)
8134 >>> is_finite_domain_value(b)
8136 >>> b = FiniteDomainVal(10, s)
8139 >>> is_finite_domain_value(b)
8142 return is_finite_domain(a) and _is_numeral(a.ctx, a.as_ast())
8145#########################################
8149#########################################
8151class OptimizeObjective:
8152 def __init__(self, opt, value, is_max):
8155 self._is_max = is_max
8159 return _to_expr_ref(Z3_optimize_get_lower(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8163 return _to_expr_ref(Z3_optimize_get_upper(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8165 def lower_values(self):
8167 return AstVector(Z3_optimize_get_lower_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8169 def upper_values(self):
8171 return AstVector(Z3_optimize_get_upper_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8180 return "%s:%s" % (self._value, self._is_max)
8186def _global_on_model(ctx):
8187 (fn, mdl) = _on_models[ctx]
8191_on_model_eh = on_model_eh_type(_global_on_model)
8194class Optimize(Z3PPObject):
8195 """Optimize API provides methods for solving using objective functions and weighted soft constraints"""
8197 def __init__(self, optimize=None, ctx=None):
8198 self.ctx = _get_ctx(ctx)
8199 if optimize is None:
8200 self.optimize = Z3_mk_optimize(self.ctx.ref())
8202 self.optimize = optimize
8203 self._on_models_id = None
8204 Z3_optimize_inc_ref(self.ctx.ref(), self.optimize)
8206 def __deepcopy__(self, memo={}):
8207 return Optimize(self.optimize, self.ctx)
8210 if self.optimize is not None and self.ctx.ref() is not None and Z3_optimize_dec_ref is not None:
8211 Z3_optimize_dec_ref(self.ctx.ref(), self.optimize)
8212 if self._on_models_id is not None:
8213 del _on_models[self._on_models_id]
8215 def __enter__(self):
8219 def __exit__(self, *exc_info):
8222 def set(self, *args, **keys):
8223 """Set a configuration option.
8224 The method `help()` return a string containing all available options.
8226 p = args2params(args, keys, self.ctx)
8227 Z3_optimize_set_params(self.ctx.ref(), self.optimize, p.params)
8230 """Display a string describing all available options."""
8231 print(Z3_optimize_get_help(self.ctx.ref(), self.optimize))
8233 def param_descrs(self):
8234 """Return the parameter description set."""
8235 return ParamDescrsRef(Z3_optimize_get_param_descrs(self.ctx.ref(), self.optimize), self.ctx)
8237 def assert_exprs(self, *args):
8238 """Assert constraints as background axioms for the optimize solver."""
8239 args = _get_args(args)
8240 s = BoolSort(self.ctx)
8242 if isinstance(arg, Goal) or isinstance(arg, AstVector):
8244 Z3_optimize_assert(self.ctx.ref(), self.optimize, f.as_ast())
8247 Z3_optimize_assert(self.ctx.ref(), self.optimize, arg.as_ast())
8249 def add(self, *args):
8250 """Assert constraints as background axioms for the optimize solver. Alias for assert_expr."""
8251 self.assert_exprs(*args)
8253 def __iadd__(self, fml):
8257 def assert_and_track(self, a, p):
8258 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
8260 If `p` is a string, it will be automatically converted into a Boolean constant.
8265 >>> s.assert_and_track(x > 0, 'p1')
8266 >>> s.assert_and_track(x != 1, 'p2')
8267 >>> s.assert_and_track(x < 0, p3)
8268 >>> print(s.check())
8270 >>> c = s.unsat_core()
8280 if isinstance(p, str):
8281 p = Bool(p, self.ctx)
8282 _z3_assert(isinstance(a, BoolRef), "Boolean expression expected")
8283 _z3_assert(isinstance(p, BoolRef) and is_const(p), "Boolean expression expected")
8284 Z3_optimize_assert_and_track(self.ctx.ref(), self.optimize, a.as_ast(), p.as_ast())
8286 def add_soft(self, arg, weight="1", id=None):
8287 """Add soft constraint with optional weight and optional identifier.
8288 If no weight is supplied, then the penalty for violating the soft constraint
8290 Soft constraints are grouped by identifiers. Soft constraints that are
8291 added without identifiers are grouped by default.
8294 weight = "%d" % weight
8295 elif isinstance(weight, float):
8296 weight = "%f" % weight
8297 if not isinstance(weight, str):
8298 raise Z3Exception("weight should be a string or an integer")
8301 id = to_symbol(id, self.ctx)
8304 v = Z3_optimize_assert_soft(self.ctx.ref(), self.optimize, a.as_ast(), weight, id)
8305 return OptimizeObjective(self, v, False)
8306 if sys.version_info.major >= 3 and isinstance(arg, Iterable):
8307 return [asoft(a) for a in arg]
8310 def set_initial_value(self, var, value):
8311 """initialize the solver's state by setting the initial value of var to value
8314 value = s.cast(value)
8315 Z3_optimize_set_initial_value(self.ctx.ref(), self.optimize, var.ast, value.ast)
8317 def maximize(self, arg):
8318 """Add objective function to maximize."""
8319 return OptimizeObjective(
8321 Z3_optimize_maximize(self.ctx.ref(), self.optimize, arg.as_ast()),
8325 def minimize(self, arg):
8326 """Add objective function to minimize."""
8327 return OptimizeObjective(
8329 Z3_optimize_minimize(self.ctx.ref(), self.optimize, arg.as_ast()),
8334 """create a backtracking point for added rules, facts and assertions"""
8335 Z3_optimize_push(self.ctx.ref(), self.optimize)
8338 """restore to previously created backtracking point"""
8339 Z3_optimize_pop(self.ctx.ref(), self.optimize)
8341 def check(self, *assumptions):
8342 """Check consistency and produce optimal values."""
8343 assumptions = _get_args(assumptions)
8344 num = len(assumptions)
8345 _assumptions = (Ast * num)()
8346 for i in range(num):
8347 _assumptions[i] = assumptions[i].as_ast()
8348 return CheckSatResult(Z3_optimize_check(self.ctx.ref(), self.optimize, num, _assumptions))
8350 def reason_unknown(self):
8351 """Return a string that describes why the last `check()` returned `unknown`."""
8352 return Z3_optimize_get_reason_unknown(self.ctx.ref(), self.optimize)
8355 """Return a model for the last check()."""
8357 return ModelRef(Z3_optimize_get_model(self.ctx.ref(), self.optimize), self.ctx)
8359 raise Z3Exception("model is not available")
8361 def unsat_core(self):
8362 return AstVector(Z3_optimize_get_unsat_core(self.ctx.ref(), self.optimize), self.ctx)
8364 def lower(self, obj):
8365 if not isinstance(obj, OptimizeObjective):
8366 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8369 def upper(self, obj):
8370 if not isinstance(obj, OptimizeObjective):
8371 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8374 def lower_values(self, obj):
8375 if not isinstance(obj, OptimizeObjective):
8376 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8377 return obj.lower_values()
8379 def upper_values(self, obj):
8380 if not isinstance(obj, OptimizeObjective):
8381 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8382 return obj.upper_values()
8384 def from_file(self, filename):
8385 """Parse assertions and objectives from a file"""
8386 Z3_optimize_from_file(self.ctx.ref(), self.optimize, filename)
8388 def from_string(self, s):
8389 """Parse assertions and objectives from a string"""
8390 Z3_optimize_from_string(self.ctx.ref(), self.optimize, s)
8392 def assertions(self):
8393 """Return an AST vector containing all added constraints."""
8394 return AstVector(Z3_optimize_get_assertions(self.ctx.ref(), self.optimize), self.ctx)
8396 def objectives(self):
8397 """returns set of objective functions"""
8398 return AstVector(Z3_optimize_get_objectives(self.ctx.ref(), self.optimize), self.ctx)
8401 """Return a formatted string with all added rules and constraints."""
8405 """Return a formatted string (in Lisp-like format) with all added constraints.
8406 We say the string is in s-expression format.
8408 return Z3_optimize_to_string(self.ctx.ref(), self.optimize)
8410 def statistics(self):
8411 """Return statistics for the last check`.
8413 return Statistics(Z3_optimize_get_statistics(self.ctx.ref(), self.optimize), self.ctx)
8415 def set_on_model(self, on_model):
8416 """Register a callback that is invoked with every incremental improvement to
8417 objective values. The callback takes a model as argument.
8418 The life-time of the model is limited to the callback so the
8419 model has to be (deep) copied if it is to be used after the callback
8421 id = len(_on_models) + 41
8422 mdl = Model(self.ctx)
8423 _on_models[id] = (on_model, mdl)
8424 self._on_models_id = id
8425 Z3_optimize_register_model_eh(
8426 self.ctx.ref(), self.optimize, mdl.model, ctypes.c_void_p(id), _on_model_eh,
8430#########################################
8434#########################################
8435class ApplyResult(Z3PPObject):
8436 """An ApplyResult object contains the subgoals produced by a tactic when applied to a goal.
8437 It also contains model and proof converters.
8440 def __init__(self, result, ctx):
8441 self.result = result
8443 Z3_apply_result_inc_ref(self.ctx.ref(), self.result)
8445 def __deepcopy__(self, memo={}):
8446 return ApplyResult(self.result, self.ctx)
8449 if self.ctx.ref() is not None and Z3_apply_result_dec_ref is not None:
8450 Z3_apply_result_dec_ref(self.ctx.ref(), self.result)
8453 """Return the number of subgoals in `self`.
8455 >>> a, b = Ints('a b')
8457 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8458 >>> t = Tactic('split-clause')
8462 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
8465 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
8469 return int(Z3_apply_result_get_num_subgoals(self.ctx.ref(), self.result))
8471 def __getitem__(self, idx):
8472 """Return one of the subgoals stored in ApplyResult object `self`.
8474 >>> a, b = Ints('a b')
8476 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8477 >>> t = Tactic('split-clause')
8480 [a == 0, Or(b == 0, b == 1), a > b]
8482 [a == 1, Or(b == 0, b == 1), a > b]
8486 if idx < 0 or idx >= len(self):
8488 return Goal(goal=Z3_apply_result_get_subgoal(self.ctx.ref(), self.result, idx), ctx=self.ctx)
8491 return obj_to_string(self)
8494 """Return a textual representation of the s-expression representing the set of subgoals in `self`."""
8495 return Z3_apply_result_to_string(self.ctx.ref(), self.result)
8498 """Return a Z3 expression consisting of all subgoals.
8503 >>> g.add(Or(x == 2, x == 3))
8504 >>> r = Tactic('simplify')(g)
8506 [[Not(x <= 1), Or(x == 2, x == 3)]]
8508 And(Not(x <= 1), Or(x == 2, x == 3))
8509 >>> r = Tactic('split-clause')(g)
8511 [[x > 1, x == 2], [x > 1, x == 3]]
8513 Or(And(x > 1, x == 2), And(x > 1, x == 3))
8517 return BoolVal(False, self.ctx)
8519 return self[0].as_expr()
8521 return Or([self[i].as_expr() for i in range(len(self))])
8523#########################################
8527#########################################
8530 """Simplifiers act as pre-processing utilities for solvers.
8531 Build a custom simplifier and add it to a solve
r"""
8533 def __init__(self, simplifier, ctx=None):
8534 self.ctx = _get_ctx(ctx)
8535 self.simplifier = None
8536 if isinstance(simplifier, SimplifierObj):
8537 self.simplifier = simplifier
8538 elif isinstance(simplifier, list):
8539 simps = [Simplifier(s, ctx) for s in simplifier]
8540 self.simplifier = simps[0].simplifier
8541 for i in range(1, len(simps)):
8542 self.simplifier = Z3_simplifier_and_then(self.ctx.ref(), self.simplifier, simps[i].simplifier)
8543 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8547 _z3_assert(isinstance(simplifier, str), "simplifier name expected")
8549 self.simplifier = Z3_mk_simplifier(self.ctx.ref(), str(simplifier))
8551 raise Z3Exception("unknown simplifier '%s'" % simplifier)
8552 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8554 def __deepcopy__(self, memo={}):
8555 return Simplifier(self.simplifier, self.ctx)
8558 if self.simplifier is not None and self.ctx.ref() is not None and Z3_simplifier_dec_ref is not None:
8559 Z3_simplifier_dec_ref(self.ctx.ref(), self.simplifier)
8561 def using_params(self, *args, **keys):
8562 """Return a simplifier that uses the given configuration options"""
8563 p = args2params(args, keys, self.ctx)
8564 return Simplifier(Z3_simplifier_using_params(self.ctx.ref(), self.simplifier, p.params), self.ctx)
8566 def add(self, solver):
8567 """Return a solver that applies the simplification pre-processing specified by the simplifie
r"""
8568 return Solver(Z3_solver_add_simplifier(self.ctx.ref(), solver.solver, self.simplifier), self.ctx)
8571 """Display a string containing a description of the available options for the `self` simplifier."""
8572 print(Z3_simplifier_get_help(self.ctx.ref(), self.simplifier))
8574 def param_descrs(self):
8575 """Return the parameter description set."""
8576 return ParamDescrsRef(Z3_simplifier_get_param_descrs(self.ctx.ref(), self.simplifier), self.ctx)
8579#########################################
8583#########################################
8587 """Tactics transform, solver and/or simplify sets of constraints (Goal).
8588 A Tactic can be converted into a Solver using the method solver().
8590 Several combinators are available for creating new tactics using the built-in ones:
8591 Then(), OrElse(), FailIf(), Repeat(), When(), Cond().
8594 def __init__(self, tactic, ctx=None):
8595 self.ctx = _get_ctx(ctx)
8597 if isinstance(tactic, TacticObj):
8598 self.tactic = tactic
8601 _z3_assert(isinstance(tactic, str), "tactic name expected")
8603 self.tactic = Z3_mk_tactic(self.ctx.ref(), str(tactic))
8605 raise Z3Exception("unknown tactic '%s'" % tactic)
8606 Z3_tactic_inc_ref(self.ctx.ref(), self.tactic)
8608 def __deepcopy__(self, memo={}):
8609 return Tactic(self.tactic, self.ctx)
8612 if self.tactic is not None and self.ctx.ref() is not None and Z3_tactic_dec_ref is not None:
8613 Z3_tactic_dec_ref(self.ctx.ref(), self.tactic)
8615 def solver(self, logFile=None):
8616 """Create a solver using the tactic `self`.
8618 The solver supports the methods `push()` and `pop()`, but it
8619 will always solve each `check()` from scratch.
8621 >>> t = Then('simplify', 'nlsat')
8624 >>> s.add(x**2 == 2, x > 0)
8630 return Solver(Z3_mk_solver_from_tactic(self.ctx.ref(), self.tactic), self.ctx, logFile)
8632 def apply(self, goal, *arguments, **keywords):
8633 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8635 >>> x, y = Ints('x y')
8636 >>> t = Tactic('solve-eqs')
8637 >>> t.apply(And(x == 0, y >= x + 1))
8641 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expressions expected")
8642 goal = _to_goal(goal)
8643 if len(arguments) > 0 or len(keywords) > 0:
8644 p = args2params(arguments, keywords, self.ctx)
8645 return ApplyResult(Z3_tactic_apply_ex(self.ctx.ref(), self.tactic, goal.goal, p.params), self.ctx)
8647 return ApplyResult(Z3_tactic_apply(self.ctx.ref(), self.tactic, goal.goal), self.ctx)
8649 def __call__(self, goal, *arguments, **keywords):
8650 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8652 >>> x, y = Ints('x y')
8653 >>> t = Tactic('solve-eqs')
8654 >>> t(And(x == 0, y >= x + 1))
8657 return self.apply(goal, *arguments, **keywords)
8660 """Display a string containing a description of the available options for the `self` tactic."""
8661 print(Z3_tactic_get_help(self.ctx.ref(), self.tactic))
8663 def param_descrs(self):
8664 """Return the parameter description set."""
8665 return ParamDescrsRef(Z3_tactic_get_param_descrs(self.ctx.ref(), self.tactic), self.ctx)
8669 if isinstance(a, BoolRef):
8670 goal = Goal(ctx=a.ctx)
8677def _to_tactic(t, ctx=None):
8678 if isinstance(t, Tactic):
8681 return Tactic(t, ctx)
8684def _and_then(t1, t2, ctx=None):
8685 t1 = _to_tactic(t1, ctx)
8686 t2 = _to_tactic(t2, ctx)
8688 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8689 return Tactic(Z3_tactic_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8692def _or_else(t1, t2, ctx=None):
8693 t1 = _to_tactic(t1, ctx)
8694 t2 = _to_tactic(t2, ctx)
8696 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8697 return Tactic(Z3_tactic_or_else(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8700def AndThen(*ts, **ks):
8701 """Return a tactic that applies the tactics in `*ts` in sequence.
8703 >>> x, y = Ints('x y')
8704 >>> t = AndThen(Tactic('simplify'), Tactic('solve-eqs'))
8705 >>> t(And(x == 0, y > x + 1))
8707 >>> t(And(x == 0, y > x + 1)).as_expr()
8711 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8712 ctx = ks.get("ctx", None)
8715 for i in range(num - 1):
8716 r = _and_then(r, ts[i + 1], ctx)
8721 """Return a tactic that applies the tactics in `*ts` in sequence. Shorthand for AndThen(*ts, **ks).
8723 >>> x, y = Ints('x y')
8724 >>> t = Then(Tactic('simplify'), Tactic('solve-eqs'))
8725 >>> t(And(x == 0, y > x + 1))
8727 >>> t(And(x == 0, y > x + 1)).as_expr()
8730 return AndThen(*ts, **ks)
8733def OrElse(*ts, **ks):
8734 """Return a tactic that applies the tactics in `*ts` until one of them succeeds (it doesn't fail).
8737 >>> t = OrElse(Tactic('split-clause'), Tactic('skip'))
8738 >>> # Tactic split-clause fails if there is no clause in the given goal.
8741 >>> t(Or(x == 0, x == 1))
8742 [[x == 0], [x == 1]]
8745 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8746 ctx = ks.get("ctx", None)
8749 for i in range(num - 1):
8750 r = _or_else(r, ts[i + 1], ctx)
8754def ParOr(*ts, **ks):
8755 """Return a tactic that applies the tactics in `*ts` in parallel until one of them succeeds (it doesn't fail).
8758 >>> t = ParOr(Tactic('simplify'), Tactic('fail'))
8763 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8764 ctx = _get_ctx(ks.get("ctx", None))
8765 ts = [_to_tactic(t, ctx) for t in ts]
8767 _args = (TacticObj * sz)()
8769 _args[i] = ts[i].tactic
8770 return Tactic(Z3_tactic_par_or(ctx.ref(), sz, _args), ctx)
8773def ParThen(t1, t2, ctx=None):
8774 """Return a tactic that applies t1 and then t2 to every subgoal produced by t1.
8775 The subgoals are processed in parallel.
8777 >>> x, y = Ints('x y')
8778 >>> t = ParThen(Tactic('split-clause'), Tactic('propagate-values'))
8779 >>> t(And(Or(x == 1, x == 2), y == x + 1))
8780 [[x == 1, y == 2], [x == 2, y == 3]]
8782 t1 = _to_tactic(t1, ctx)
8783 t2 = _to_tactic(t2, ctx)
8785 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8786 return Tactic(Z3_tactic_par_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8789def ParAndThen(t1, t2, ctx=None):
8790 """Alias for ParThen(t1, t2, ctx)."""
8791 return ParThen(t1, t2, ctx)
8794def With(t, *args, **keys):
8795 """Return a tactic that applies tactic `t` using the given configuration options.
8797 >>> x, y = Ints('x y')
8798 >>> t = With(Tactic('simplify'), som=True)
8799 >>> t((x + 1)*(y + 2) == 0)
8800 [[2*x + y + x*y == -2]]
8802 ctx = keys.pop("ctx", None)
8803 t = _to_tactic(t, ctx)
8804 p = args2params(args, keys, t.ctx)
8805 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8808def WithParams(t, p):
8809 """Return a tactic that applies tactic `t` using the given configuration options.
8811 >>> x, y = Ints('x y')
8813 >>> p.set("som", True)
8814 >>> t = WithParams(Tactic('simplify'), p)
8815 >>> t((x + 1)*(y + 2) == 0)
8816 [[2*x + y + x*y == -2]]
8818 t = _to_tactic(t, None)
8819 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8822def Repeat(t, max=4294967295, ctx=None):
8823 """Return a tactic that keeps applying `t` until the goal is not modified anymore
8824 or the maximum number of iterations `max` is reached.
8826 >>> x, y = Ints('x y')
8827 >>> c = And(Or(x == 0, x == 1), Or(y == 0, y == 1), x > y)
8828 >>> t = Repeat(OrElse(Tactic('split-clause'), Tactic('skip')))
8830 >>> for subgoal in r: print(subgoal)
8831 [x == 0, y == 0, x > y]
8832 [x == 0, y == 1, x > y]
8833 [x == 1, y == 0, x > y]
8834 [x == 1, y == 1, x > y]
8835 >>> t = Then(t, Tactic('propagate-values'))
8839 t = _to_tactic(t, ctx)
8840 return Tactic(Z3_tactic_repeat(t.ctx.ref(), t.tactic, max), t.ctx)
8843def TryFor(t, ms, ctx=None):
8844 """Return a tactic that applies `t` to a given goal for `ms` milliseconds.
8846 If `t` does not terminate in `ms` milliseconds, then it fails.
8848 t = _to_tactic(t, ctx)
8849 return Tactic(Z3_tactic_try_for(t.ctx.ref(), t.tactic, ms), t.ctx)
8852def tactics(ctx=None):
8853 """Return a list of all available tactics in Z3.
8856 >>> l.count('simplify') == 1
8860 return [Z3_get_tactic_name(ctx.ref(), i) for i in range(Z3_get_num_tactics(ctx.ref()))]
8863def tactic_description(name, ctx=None):
8864 """Return a short description for the tactic named `name`.
8866 >>> d = tactic_description('simplify')
8869 return Z3_tactic_get_descr(ctx.ref(), name)
8872def describe_tactics():
8873 """Display a (tabular) description of all available tactics in Z3."""
8876 print('<table border="1" cellpadding="2" cellspacing="0">')
8879 print('<tr style="background-color:#CFCFCF">')
8884 print("<td>%s</td><td>%s</td></tr>" % (t, insert_line_breaks(tactic_description(t), 40)))
8888 print("%s : %s" % (t, tactic_description(t)))
8892 """Probes are used to inspect a goal (aka problem) and collect information that may be used
8893 to decide which solver and/or preprocessing step will be used.
8896 def __init__(self, probe, ctx=None):
8897 self.ctx = _get_ctx(ctx)
8899 if isinstance(probe, ProbeObj):
8901 elif isinstance(probe, float):
8902 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8903 elif _is_int(probe):
8904 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8905 elif isinstance(probe, bool):
8907 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8909 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8912 _z3_assert(isinstance(probe, str), "probe name expected")
8914 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8916 raise Z3Exception("unknown probe '%s'" % probe)
8917 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8919 def __deepcopy__(self, memo={}):
8920 return Probe(self.probe, self.ctx)
8923 if self.probe is not None and self.ctx.ref() is not None and Z3_probe_dec_ref is not None:
8924 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8926 def __lt__(self, other):
8927 """Return a probe that evaluates to "true" when the value returned by `self`
8928 is less than the value returned by `other`.
8930 >>> p = Probe('size') < 10
8938 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8940 def __gt__(self, other):
8941 """Return a probe that evaluates to "true" when the value returned by `self`
8942 is greater than the value returned by `other`.
8944 >>> p = Probe('size') > 10
8952 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8954 def __le__(self, other):
8955 """Return a probe that evaluates to "true" when the value returned by `self`
8956 is less than or equal to the value returned by `other`.
8958 >>> p = Probe('size') <= 2
8966 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8968 def __ge__(self, other):
8969 """Return a probe that evaluates to "true" when the value returned by `self`
8970 is greater than or equal to the value returned by `other`.
8972 >>> p = Probe('size') >= 2
8980 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8982 def __eq__(self, other):
8983 """Return a probe that evaluates to "true" when the value returned by `self`
8984 is equal to the value returned by `other`.
8986 >>> p = Probe('size') == 2
8994 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8996 def __ne__(self, other):
8997 """Return a probe that evaluates to "true" when the value returned by `self`
8998 is not equal to the value returned by `other`.
9000 >>> p = Probe('size') != 2
9008 p = self.__eq__(other)
9009 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
9011 def __call__(self, goal):
9012 """Evaluate the probe `self` in the given goal.
9014 >>> p = Probe('size')
9024 >>> p = Probe('num-consts')
9027 >>> p = Probe('is-propositional')
9030 >>> p = Probe('is-qflia')
9035 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
9036 goal = _to_goal(goal)
9037 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
9041 """Return `True` if `p` is a Z3 probe.
9043 >>> is_probe(Int('x'))
9045 >>> is_probe(Probe('memory'))
9048 return isinstance(p, Probe)
9051def _to_probe(p, ctx=None):
9055 return Probe(p, ctx)
9058def probes(ctx=None):
9059 """Return a list of all available probes in Z3.
9062 >>> l.count('memory') == 1
9066 return [Z3_get_probe_name(ctx.ref(), i) for i in range(Z3_get_num_probes(ctx.ref()))]
9069def probe_description(name, ctx=None):
9070 """Return a short description for the probe named `name`.
9072 >>> d = probe_description('memory')
9075 return Z3_probe_get_descr(ctx.ref(), name)
9078def describe_probes():
9079 """Display a (tabular) description of all available probes in Z3."""
9082 print('<table border="1" cellpadding="2" cellspacing="0">')
9085 print('<tr style="background-color:#CFCFCF">')
9090 print("<td>%s</td><td>%s</td></tr>" % (p, insert_line_breaks(probe_description(p), 40)))
9094 print("%s : %s" % (p, probe_description(p)))
9097def _probe_nary(f, args, ctx):
9099 _z3_assert(len(args) > 0, "At least one argument expected")
9101 r = _to_probe(args[0], ctx)
9102 for i in range(num - 1):
9103 r = Probe(f(ctx.ref(), r.probe, _to_probe(args[i + 1], ctx).probe), ctx)
9107def _probe_and(args, ctx):
9108 return _probe_nary(Z3_probe_and, args, ctx)
9111def _probe_or(args, ctx):
9112 return _probe_nary(Z3_probe_or, args, ctx)
9115def FailIf(p, ctx=None):
9116 """Return a tactic that fails if the probe `p` evaluates to true.
9117 Otherwise, it returns the input goal unmodified.
9119 In the following example, the tactic applies 'simplify' if and only if there are
9120 more than 2 constraints in the goal.
9122 >>> t = OrElse(FailIf(Probe('size') > 2), Tactic('simplify'))
9123 >>> x, y = Ints('x y')
9129 >>> g.add(x == y + 1)
9131 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9133 p = _to_probe(p, ctx)
9134 return Tactic(Z3_tactic_fail_if(p.ctx.ref(), p.probe), p.ctx)
9137def When(p, t, ctx=None):
9138 """Return a tactic that applies tactic `t` only if probe `p` evaluates to true.
9139 Otherwise, it returns the input goal unmodified.
9141 >>> t = When(Probe('size') > 2, Tactic('simplify'))
9142 >>> x, y = Ints('x y')
9148 >>> g.add(x == y + 1)
9150 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9152 p = _to_probe(p, ctx)
9153 t = _to_tactic(t, ctx)
9154 return Tactic(Z3_tactic_when(t.ctx.ref(), p.probe, t.tactic), t.ctx)
9157def Cond(p, t1, t2, ctx=None):
9158 """Return a tactic that applies tactic `t1` to a goal if probe `p` evaluates to true, and `t2` otherwise.
9160 >>> t = Cond(Probe('is-qfnra'), Tactic('qfnra'), Tactic('smt'))
9162 p = _to_probe(p, ctx)
9163 t1 = _to_tactic(t1, ctx)
9164 t2 = _to_tactic(t2, ctx)
9165 return Tactic(Z3_tactic_cond(t1.ctx.ref(), p.probe, t1.tactic, t2.tactic), t1.ctx)
9167#########################################
9171#########################################
9174def simplify(a, *arguments, **keywords):
9175 """Simplify the expression `a` using the given options.
9177 This function has many options. Use `help_simplify` to obtain the complete list.
9181 >>> simplify(x + 1 + y + x + 1)
9183 >>> simplify((x + 1)*(y + 1), som=True)
9185 >>> simplify(Distinct(x, y, 1), blast_distinct=True)
9186 And(Not(x == y), Not(x == 1), Not(y == 1))
9187 >>> simplify(And(x == 0, y == 1), elim_and=True)
9188 Not(Or(Not(x == 0), Not(y == 1)))
9191 _z3_assert(is_expr(a), "Z3 expression expected")
9192 if len(arguments) > 0 or len(keywords) > 0:
9193 p = args2params(arguments, keywords, a.ctx)
9194 return _to_expr_ref(Z3_simplify_ex(a.ctx_ref(), a.as_ast(), p.params), a.ctx)
9196 return _to_expr_ref(Z3_simplify(a.ctx_ref(), a.as_ast()), a.ctx)
9200 """Return a string describing all options available for Z3 `simplify` procedure."""
9201 print(Z3_simplify_get_help(main_ctx().ref()))
9204def simplify_param_descrs():
9205 """Return the set of parameter descriptions for Z3 `simplify` procedure."""
9206 return ParamDescrsRef(Z3_simplify_get_param_descrs(main_ctx().ref()), main_ctx())
9209def substitute(t, *m):
9210 """Apply substitution m on t, m is a list of pairs of the form (from, to).
9211 Every occurrence in t of from is replaced with to.
9215 >>> substitute(x + 1, (x, y + 1))
9217 >>> f = Function('f', IntSort(), IntSort())
9218 >>> substitute(f(x) + f(y), (f(x), IntVal(1)), (f(y), IntVal(1)))
9221 if isinstance(m, tuple):
9223 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9226 _z3_assert(is_expr(t), "Z3 expression expected")
9228 all([isinstance(p, tuple) and is_expr(p[0]) and is_expr(p[1]) for p in m]),
9229 "Z3 invalid substitution, expression pairs expected.")
9231 all([p[0].sort().eq(p[1].sort()) for p in m]),
9232 'Z3 invalid substitution, mismatching "from" and "to" sorts.')
9234 _from = (Ast * num)()
9236 for i in range(num):
9237 _from[i] = m[i][0].as_ast()
9238 _to[i] = m[i][1].as_ast()
9239 return _to_expr_ref(Z3_substitute(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9242def substitute_vars(t, *m):
9243 """Substitute the free variables in t with the expression in m.
9245 >>> v0 = Var(0, IntSort())
9246 >>> v1 = Var(1, IntSort())
9248 >>> f = Function('f', IntSort(), IntSort(), IntSort())
9249 >>> # replace v0 with x+1 and v1 with x
9250 >>> substitute_vars(f(v0, v1), x + 1, x)
9254 _z3_assert(is_expr(t), "Z3 expression expected")
9255 _z3_assert(all([is_expr(n) for n in m]), "Z3 invalid substitution, list of expressions expected.")
9258 for i in range(num):
9259 _to[i] = m[i].as_ast()
9260 return _to_expr_ref(Z3_substitute_vars(t.ctx.ref(), t.as_ast(), num, _to), t.ctx)
9262def substitute_funs(t, *m):
9263 """Apply substitution m on t, m is a list of pairs of a function and expression (from, to)
9264 Every occurrence in to of the function from is replaced with the expression to.
9265 The expression to can have free variables, that refer to the arguments of from.
9268 if isinstance(m, tuple):
9270 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9273 _z3_assert(is_expr(t), "Z3 expression expected")
9274 _z3_assert(all([isinstance(p, tuple) and is_func_decl(p[0]) and is_expr(p[1]) for p in m]), "Z3 invalid substitution, function pairs expected.")
9276 _from = (FuncDecl * num)()
9278 for i in range(num):
9279 _from[i] = m[i][0].as_func_decl()
9280 _to[i] = m[i][1].as_ast()
9281 return _to_expr_ref(Z3_substitute_funs(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9285 """Create the sum of the Z3 expressions.
9287 >>> a, b, c = Ints('a b c')
9292 >>> A = IntVector('a', 5)
9294 a__0 + a__1 + a__2 + a__3 + a__4
9296 args = _get_args(args)
9299 ctx = _ctx_from_ast_arg_list(args)
9301 return _reduce(lambda a, b: a + b, args, 0)
9302 args = _coerce_expr_list(args, ctx)
9304 return _reduce(lambda a, b: a + b, args, 0)
9306 _args, sz = _to_ast_array(args)
9307 return ArithRef(Z3_mk_add(ctx.ref(), sz, _args), ctx)
9311 """Create the product of the Z3 expressions.
9313 >>> a, b, c = Ints('a b c')
9314 >>> Product(a, b, c)
9316 >>> Product([a, b, c])
9318 >>> A = IntVector('a', 5)
9320 a__0*a__1*a__2*a__3*a__4
9322 args = _get_args(args)
9325 ctx = _ctx_from_ast_arg_list(args)
9327 return _reduce(lambda a, b: a * b, args, 1)
9328 args = _coerce_expr_list(args, ctx)
9330 return _reduce(lambda a, b: a * b, args, 1)
9332 _args, sz = _to_ast_array(args)
9333 return ArithRef(Z3_mk_mul(ctx.ref(), sz, _args), ctx)
9336 """Create the absolute value of an arithmetic expression"""
9337 return If(arg > 0, arg, -arg)
9341 """Create an at-most Pseudo-Boolean k constraint.
9343 >>> a, b, c = Bools('a b c')
9344 >>> f = AtMost(a, b, c, 2)
9346 args = _get_args(args)
9348 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9349 ctx = _ctx_from_ast_arg_list(args)
9351 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9352 args1 = _coerce_expr_list(args[:-1], ctx)
9354 _args, sz = _to_ast_array(args1)
9355 return BoolRef(Z3_mk_atmost(ctx.ref(), sz, _args, k), ctx)
9359 """Create an at-least Pseudo-Boolean k constraint.
9361 >>> a, b, c = Bools('a b c')
9362 >>> f = AtLeast(a, b, c, 2)
9364 args = _get_args(args)
9366 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9367 ctx = _ctx_from_ast_arg_list(args)
9369 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9370 args1 = _coerce_expr_list(args[:-1], ctx)
9372 _args, sz = _to_ast_array(args1)
9373 return BoolRef(Z3_mk_atleast(ctx.ref(), sz, _args, k), ctx)
9376def _reorder_pb_arg(arg):
9378 if not _is_int(b) and _is_int(a):
9383def _pb_args_coeffs(args, default_ctx=None):
9384 args = _get_args_ast_list(args)
9386 return _get_ctx(default_ctx), 0, (Ast * 0)(), (ctypes.c_int * 0)()
9387 args = [_reorder_pb_arg(arg) for arg in args]
9388 args, coeffs = zip(*args)
9390 _z3_assert(len(args) > 0, "Non empty list of arguments expected")
9391 ctx = _ctx_from_ast_arg_list(args)
9393 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9394 args = _coerce_expr_list(args, ctx)
9395 _args, sz = _to_ast_array(args)
9396 _coeffs = (ctypes.c_int * len(coeffs))()
9397 for i in range(len(coeffs)):
9398 _z3_check_cint_overflow(coeffs[i], "coefficient")
9399 _coeffs[i] = coeffs[i]
9400 return ctx, sz, _args, _coeffs, args
9404 """Create a Pseudo-Boolean inequality k constraint.
9406 >>> a, b, c = Bools('a b c')
9407 >>> f = PbLe(((a,1),(b,3),(c,2)), 3)
9409 _z3_check_cint_overflow(k, "k")
9410 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9411 return BoolRef(Z3_mk_pble(ctx.ref(), sz, _args, _coeffs, k), ctx)
9415 """Create a Pseudo-Boolean inequality k constraint.
9417 >>> a, b, c = Bools('a b c')
9418 >>> f = PbGe(((a,1),(b,3),(c,2)), 3)
9420 _z3_check_cint_overflow(k, "k")
9421 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9422 return BoolRef(Z3_mk_pbge(ctx.ref(), sz, _args, _coeffs, k), ctx)
9425def PbEq(args, k, ctx=None):
9426 """Create a Pseudo-Boolean equality k constraint.
9428 >>> a, b, c = Bools('a b c')
9429 >>> f = PbEq(((a,1),(b,3),(c,2)), 3)
9431 _z3_check_cint_overflow(k, "k")
9432 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9433 return BoolRef(Z3_mk_pbeq(ctx.ref(), sz, _args, _coeffs, k), ctx)
9436def solve(*args, **keywords):
9437 """Solve the constraints `*args`.
9439 This is a simple function for creating demonstrations. It creates a solver,
9440 configure it using the options in `keywords`, adds the constraints
9441 in `args`, and invokes check.
9444 >>> solve(a > 0, a < 2)
9447 show = keywords.pop("show", False)
9455 print("no solution")
9457 print("failed to solve")
9466def solve_using(s, *args, **keywords):
9467 """Solve the constraints `*args` using solver `s`.
9469 This is a simple function for creating demonstrations. It is similar to `solve`,
9470 but it uses the given solver `s`.
9471 It configures solver `s` using the options in `keywords`, adds the constraints
9472 in `args`, and invokes check.
9474 show = keywords.pop("show", False)
9476 _z3_assert(isinstance(s, Solver), "Solver object expected")
9484 print("no solution")
9486 print("failed to solve")
9497def prove(claim, show=False, **keywords):
9498 """Try to prove the given claim.
9500 This is a simple function for creating demonstrations. It tries to prove
9501 `claim` by showing the negation is unsatisfiable.
9503 >>> p, q = Bools('p q')
9504 >>> prove(Not(And(p, q)) == Or(Not(p), Not(q)))
9508 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9518 print("failed to prove")
9521 print("counterexample")
9525def _solve_html(*args, **keywords):
9526 """Version of function `solve` that renders HTML output."""
9527 show = keywords.pop("show", False)
9532 print("<b>Problem:</b>")
9536 print("<b>no solution</b>")
9538 print("<b>failed to solve</b>")
9545 print("<b>Solution:</b>")
9549def _solve_using_html(s, *args, **keywords):
9550 """Version of function `solve_using` that renders HTML."""
9551 show = keywords.pop("show", False)
9553 _z3_assert(isinstance(s, Solver), "Solver object expected")
9557 print("<b>Problem:</b>")
9561 print("<b>no solution</b>")
9563 print("<b>failed to solve</b>")
9570 print("<b>Solution:</b>")
9574def _prove_html(claim, show=False, **keywords):
9575 """Version of function `prove` that renders HTML."""
9577 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9585 print("<b>proved</b>")
9587 print("<b>failed to prove</b>")
9590 print("<b>counterexample</b>")
9594def _dict2sarray(sorts, ctx):
9596 _names = (Symbol * sz)()
9597 _sorts = (Sort * sz)()
9602 _z3_assert(isinstance(k, str), "String expected")
9603 _z3_assert(is_sort(v), "Z3 sort expected")
9604 _names[i] = to_symbol(k, ctx)
9607 return sz, _names, _sorts
9610def _dict2darray(decls, ctx):
9612 _names = (Symbol * sz)()
9613 _decls = (FuncDecl * sz)()
9618 _z3_assert(isinstance(k, str), "String expected")
9619 _z3_assert(is_func_decl(v) or is_const(v), "Z3 declaration or constant expected")
9620 _names[i] = to_symbol(k, ctx)
9622 _decls[i] = v.decl().ast
9626 return sz, _names, _decls
9629 def __init__(self, ctx= None):
9630 self.ctx = _get_ctx(ctx)
9631 self.pctx = Z3_mk_parser_context(self.ctx.ref())
9632 Z3_parser_context_inc_ref(self.ctx.ref(), self.pctx)
9635 if self.ctx.ref() is not None and self.pctx is not None and Z3_parser_context_dec_ref is not None:
9636 Z3_parser_context_dec_ref(self.ctx.ref(), self.pctx)
9639 def add_sort(self, sort):
9640 Z3_parser_context_add_sort(self.ctx.ref(), self.pctx, sort.as_ast())
9642 def add_decl(self, decl):
9643 Z3_parser_context_add_decl(self.ctx.ref(), self.pctx, decl.as_ast())
9645 def from_string(self, s):
9646 return AstVector(Z3_parser_context_from_string(self.ctx.ref(), self.pctx, s), self.ctx)
9648def parse_smt2_string(s, sorts={}, decls={}, ctx=None):
9649 """Parse a string in SMT 2.0 format using the given sorts and decls.
9651 The arguments sorts and decls are Python dictionaries used to initialize
9652 the symbol table used for the SMT 2.0 parser.
9654 >>> parse_smt2_string('(declare-const x Int) (assert (> x 0)) (assert (< x 10))')
9656 >>> x, y = Ints('x y')
9657 >>> f = Function('f', IntSort(), IntSort())
9658 >>> parse_smt2_string('(assert (> (+ foo (g bar)) 0))', decls={ 'foo' : x, 'bar' : y, 'g' : f})
9660 >>> parse_smt2_string('(declare-const a U) (assert (> a 0))', sorts={ 'U' : IntSort() })
9664 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9665 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9666 return AstVector(Z3_parse_smtlib2_string(ctx.ref(), s, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9669def parse_smt2_file(f, sorts={}, decls={}, ctx=None):
9670 """Parse a file in SMT 2.0 format using the given sorts and decls.
9672 This function is similar to parse_smt2_string().
9675 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9676 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9677 return AstVector(Z3_parse_smtlib2_file(ctx.ref(), f, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9680#########################################
9682# Floating-Point Arithmetic
9684#########################################
9687# Global default rounding mode
9688_dflt_rounding_mode = Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN
9689_dflt_fpsort_ebits = 11
9690_dflt_fpsort_sbits = 53
9693def get_default_rounding_mode(ctx=None):
9694 """Retrieves the global default rounding mode."""
9695 global _dflt_rounding_mode
9696 if _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_ZERO:
9698 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_NEGATIVE:
9700 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_POSITIVE:
9702 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN:
9704 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY:
9708_ROUNDING_MODES = frozenset({
9709 Z3_OP_FPA_RM_TOWARD_ZERO,
9710 Z3_OP_FPA_RM_TOWARD_NEGATIVE,
9711 Z3_OP_FPA_RM_TOWARD_POSITIVE,
9712 Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN,
9713 Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY
9717def set_default_rounding_mode(rm, ctx=None):
9718 global _dflt_rounding_mode
9719 if is_fprm_value(rm):
9720 _dflt_rounding_mode = rm.kind()
9722 _z3_assert(_dflt_rounding_mode in _ROUNDING_MODES, "illegal rounding mode")
9723 _dflt_rounding_mode = rm
9726def get_default_fp_sort(ctx=None):
9727 return FPSort(_dflt_fpsort_ebits, _dflt_fpsort_sbits, ctx)
9730def set_default_fp_sort(ebits, sbits, ctx=None):
9731 global _dflt_fpsort_ebits
9732 global _dflt_fpsort_sbits
9733 _dflt_fpsort_ebits = ebits
9734 _dflt_fpsort_sbits = sbits
9737def _dflt_rm(ctx=None):
9738 return get_default_rounding_mode(ctx)
9741def _dflt_fps(ctx=None):
9742 return get_default_fp_sort(ctx)
9745def _coerce_fp_expr_list(alist, ctx):
9746 first_fp_sort = None
9749 if first_fp_sort is None:
9750 first_fp_sort = a.sort()
9751 elif first_fp_sort == a.sort():
9752 pass # OK, same as before
9754 # we saw at least 2 different float sorts; something will
9755 # throw a sort mismatch later, for now assume None.
9756 first_fp_sort = None
9760 for i in range(len(alist)):
9762 is_repr = isinstance(a, str) and a.contains("2**(") and a.endswith(")")
9763 if is_repr or _is_int(a) or isinstance(a, (float, bool)):
9764 r.append(FPVal(a, None, first_fp_sort, ctx))
9767 return _coerce_expr_list(r, ctx)
9772class FPSortRef(SortRef):
9773 """Floating-point sort."""
9776 """Retrieves the number of bits reserved for the exponent in the FloatingPoint sort `self`.
9777 >>> b = FPSort(8, 24)
9781 return int(Z3_fpa_get_ebits(self.ctx_ref(), self.ast))
9784 """Retrieves the number of bits reserved for the significand in the FloatingPoint sort `self`.
9785 >>> b = FPSort(8, 24)
9789 return int(Z3_fpa_get_sbits(self.ctx_ref(), self.ast))
9791 def cast(self, val):
9792 """Try to cast `val` as a floating-point expression.
9793 >>> b = FPSort(8, 24)
9796 >>> b.cast(1.0).sexpr()
9797 '(fp #b0 #x7f #b00000000000000000000000)'
9801 _z3_assert(self.ctx == val.ctx, "Context mismatch")
9804 return FPVal(val, None, self, self.ctx)
9807def Float16(ctx=None):
9808 """Floating-point 16-bit (half) sort."""
9810 return FPSortRef(Z3_mk_fpa_sort_16(ctx.ref()), ctx)
9813def FloatHalf(ctx=None):
9814 """Floating-point 16-bit (half) sort."""
9816 return FPSortRef(Z3_mk_fpa_sort_half(ctx.ref()), ctx)
9819def Float32(ctx=None):
9820 """Floating-point 32-bit (single) sort."""
9822 return FPSortRef(Z3_mk_fpa_sort_32(ctx.ref()), ctx)
9825def FloatSingle(ctx=None):
9826 """Floating-point 32-bit (single) sort."""
9828 return FPSortRef(Z3_mk_fpa_sort_single(ctx.ref()), ctx)
9831def Float64(ctx=None):
9832 """Floating-point 64-bit (double) sort."""
9834 return FPSortRef(Z3_mk_fpa_sort_64(ctx.ref()), ctx)
9837def FloatDouble(ctx=None):
9838 """Floating-point 64-bit (double) sort."""
9840 return FPSortRef(Z3_mk_fpa_sort_double(ctx.ref()), ctx)
9843def Float128(ctx=None):
9844 """Floating-point 128-bit (quadruple) sort."""
9846 return FPSortRef(Z3_mk_fpa_sort_128(ctx.ref()), ctx)
9849def FloatQuadruple(ctx=None):
9850 """Floating-point 128-bit (quadruple) sort."""
9852 return FPSortRef(Z3_mk_fpa_sort_quadruple(ctx.ref()), ctx)
9855class FPRMSortRef(SortRef):
9856 """"Floating-point rounding mode sort."""
9860 """Return True if `s` is a Z3 floating-point sort.
9862 >>> is_fp_sort(FPSort(8, 24))
9864 >>> is_fp_sort(IntSort())
9867 return isinstance(s, FPSortRef)
9871 """Return True if `s` is a Z3 floating-point rounding mode sort.
9873 >>> is_fprm_sort(FPSort(8, 24))
9875 >>> is_fprm_sort(RNE().sort())
9878 return isinstance(s, FPRMSortRef)
9883class FPRef(ExprRef):
9884 """Floating-point expressions."""
9887 """Return the sort of the floating-point expression `self`.
9889 >>> x = FP('1.0', FPSort(8, 24))
9892 >>> x.sort() == FPSort(8, 24)
9895 return FPSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
9898 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9899 >>> b = FPSort(8, 24)
9903 return self.sort().ebits()
9906 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9907 >>> b = FPSort(8, 24)
9911 return self.sort().sbits()
9913 def as_string(self):
9914 """Return a Z3 floating point expression as a Python string."""
9915 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
9917 def __le__(self, other):
9918 return fpLEQ(self, other, self.ctx)
9920 def __lt__(self, other):
9921 return fpLT(self, other, self.ctx)
9923 def __ge__(self, other):
9924 return fpGEQ(self, other, self.ctx)
9926 def __gt__(self, other):
9927 return fpGT(self, other, self.ctx)
9929 def __add__(self, other):
9930 """Create the Z3 expression `self + other`.
9932 >>> x = FP('x', FPSort(8, 24))
9933 >>> y = FP('y', FPSort(8, 24))
9939 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9940 return fpAdd(_dflt_rm(), a, b, self.ctx)
9942 def __radd__(self, other):
9943 """Create the Z3 expression `other + self`.
9945 >>> x = FP('x', FPSort(8, 24))
9949 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9950 return fpAdd(_dflt_rm(), a, b, self.ctx)
9952 def __sub__(self, other):
9953 """Create the Z3 expression `self - other`.
9955 >>> x = FP('x', FPSort(8, 24))
9956 >>> y = FP('y', FPSort(8, 24))
9962 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9963 return fpSub(_dflt_rm(), a, b, self.ctx)
9965 def __rsub__(self, other):
9966 """Create the Z3 expression `other - self`.
9968 >>> x = FP('x', FPSort(8, 24))
9972 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9973 return fpSub(_dflt_rm(), a, b, self.ctx)
9975 def __mul__(self, other):
9976 """Create the Z3 expression `self * other`.
9978 >>> x = FP('x', FPSort(8, 24))
9979 >>> y = FP('y', FPSort(8, 24))
9987 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9988 return fpMul(_dflt_rm(), a, b, self.ctx)
9990 def __rmul__(self, other):
9991 """Create the Z3 expression `other * self`.
9993 >>> x = FP('x', FPSort(8, 24))
9994 >>> y = FP('y', FPSort(8, 24))
10000 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
10001 return fpMul(_dflt_rm(), a, b, self.ctx)
10004 """Create the Z3 expression `+self`."""
10008 """Create the Z3 expression `-self`.
10010 >>> x = FP('x', Float32())
10016 def __div__(self, other):
10017 """Create the Z3 expression `self / other`.
10019 >>> x = FP('x', FPSort(8, 24))
10020 >>> y = FP('y', FPSort(8, 24))
10028 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
10029 return fpDiv(_dflt_rm(), a, b, self.ctx)
10031 def __rdiv__(self, other):
10032 """Create the Z3 expression `other / self`.
10034 >>> x = FP('x', FPSort(8, 24))
10035 >>> y = FP('y', FPSort(8, 24))
10041 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
10042 return fpDiv(_dflt_rm(), a, b, self.ctx)
10044 def __truediv__(self, other):
10045 """Create the Z3 expression division `self / other`."""
10046 return self.__div__(other)
10048 def __rtruediv__(self, other):
10049 """Create the Z3 expression division `other / self`."""
10050 return self.__rdiv__(other)
10052 def __mod__(self, other):
10053 """Create the Z3 expression mod `self % other`."""
10054 return fpRem(self, other)
10056 def __rmod__(self, other):
10057 """Create the Z3 expression mod `other % self`."""
10058 return fpRem(other, self)
10061class FPRMRef(ExprRef):
10062 """Floating-point rounding mode expressions"""
10064 def as_string(self):
10065 """Return a Z3 floating point expression as a Python string."""
10066 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
10069def RoundNearestTiesToEven(ctx=None):
10070 ctx = _get_ctx(ctx)
10071 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
10075 ctx = _get_ctx(ctx)
10076 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
10079def RoundNearestTiesToAway(ctx=None):
10080 ctx = _get_ctx(ctx)
10081 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
10085 ctx = _get_ctx(ctx)
10086 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
10089def RoundTowardPositive(ctx=None):
10090 ctx = _get_ctx(ctx)
10091 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
10095 ctx = _get_ctx(ctx)
10096 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
10099def RoundTowardNegative(ctx=None):
10100 ctx = _get_ctx(ctx)
10101 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
10105 ctx = _get_ctx(ctx)
10106 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
10109def RoundTowardZero(ctx=None):
10110 ctx = _get_ctx(ctx)
10111 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
10115 ctx = _get_ctx(ctx)
10116 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
10120 """Return `True` if `a` is a Z3 floating-point rounding mode expression.
10129 return isinstance(a, FPRMRef)
10132def is_fprm_value(a):
10133 """Return `True` if `a` is a Z3 floating-point rounding mode numeral value."""
10134 return is_fprm(a) and _is_numeral(a.ctx, a.ast)
10139class FPNumRef(FPRef):
10140 """The sign of the numeral.
10142 >>> x = FPVal(+1.0, FPSort(8, 24))
10145 >>> x = FPVal(-1.0, FPSort(8, 24))
10151 num = ctypes.c_bool()
10152 nsign = Z3_fpa_get_numeral_sign(self.ctx.ref(), self.as_ast(), byref(num))
10154 raise Z3Exception("error retrieving the sign of a numeral.")
10155 return num.value != 0
10157 """The sign of a floating-point numeral as a bit-vector expression.
10159 Remark: NaN's are invalid arguments.
10162 def sign_as_bv(self):
10163 return BitVecNumRef(Z3_fpa_get_numeral_sign_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10165 """The significand of the numeral.
10167 >>> x = FPVal(2.5, FPSort(8, 24))
10168 >>> x.significand()
10172 def significand(self):
10173 return Z3_fpa_get_numeral_significand_string(self.ctx.ref(), self.as_ast())
10175 """The significand of the numeral as a long.
10177 >>> x = FPVal(2.5, FPSort(8, 24))
10178 >>> x.significand_as_long()
10182 def significand_as_long(self):
10183 ptr = (ctypes.c_ulonglong * 1)()
10184 if not Z3_fpa_get_numeral_significand_uint64(self.ctx.ref(), self.as_ast(), ptr):
10185 raise Z3Exception("error retrieving the significand of a numeral.")
10188 """The significand of the numeral as a bit-vector expression.
10190 Remark: NaN are invalid arguments.
10193 def significand_as_bv(self):
10194 return BitVecNumRef(Z3_fpa_get_numeral_significand_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10196 """The exponent of the numeral.
10198 >>> x = FPVal(2.5, FPSort(8, 24))
10203 def exponent(self, biased=True):
10204 return Z3_fpa_get_numeral_exponent_string(self.ctx.ref(), self.as_ast(), biased)
10206 """The exponent of the numeral as a long.
10208 >>> x = FPVal(2.5, FPSort(8, 24))
10209 >>> x.exponent_as_long()
10213 def exponent_as_long(self, biased=True):
10214 ptr = (ctypes.c_longlong * 1)()
10215 if not Z3_fpa_get_numeral_exponent_int64(self.ctx.ref(), self.as_ast(), ptr, biased):
10216 raise Z3Exception("error retrieving the exponent of a numeral.")
10219 """The exponent of the numeral as a bit-vector expression.
10221 Remark: NaNs are invalid arguments.
10224 def exponent_as_bv(self, biased=True):
10225 return BitVecNumRef(Z3_fpa_get_numeral_exponent_bv(self.ctx.ref(), self.as_ast(), biased), self.ctx)
10227 """Indicates whether the numeral is a NaN."""
10230 return Z3_fpa_is_numeral_nan(self.ctx.ref(), self.as_ast())
10232 """Indicates whether the numeral is +oo or -oo."""
10235 return Z3_fpa_is_numeral_inf(self.ctx.ref(), self.as_ast())
10237 """Indicates whether the numeral is +zero or -zero."""
10240 return Z3_fpa_is_numeral_zero(self.ctx.ref(), self.as_ast())
10242 """Indicates whether the numeral is normal."""
10244 def isNormal(self):
10245 return Z3_fpa_is_numeral_normal(self.ctx.ref(), self.as_ast())
10247 """Indicates whether the numeral is subnormal."""
10249 def isSubnormal(self):
10250 return Z3_fpa_is_numeral_subnormal(self.ctx.ref(), self.as_ast())
10252 """Indicates whether the numeral is positive."""
10254 def isPositive(self):
10255 return Z3_fpa_is_numeral_positive(self.ctx.ref(), self.as_ast())
10257 """Indicates whether the numeral is negative."""
10259 def isNegative(self):
10260 return Z3_fpa_is_numeral_negative(self.ctx.ref(), self.as_ast())
10263 The string representation of the numeral.
10265 >>> x = FPVal(20, FPSort(8, 24))
10270 def as_string(self):
10271 s = Z3_get_numeral_string(self.ctx.ref(), self.as_ast())
10272 return ("FPVal(%s, %s)" % (s, self.sort()))
10274 def py_value(self):
10275 bv = simplify(fpToIEEEBV(self))
10276 binary = bv.py_value()
10277 if not isinstance(binary, int):
10279 # Decode the IEEE 754 binary representation
10281 bytes_rep = binary.to_bytes(8, byteorder='big')
10282 return struct.unpack('>d', bytes_rep)[0]
10286 """Return `True` if `a` is a Z3 floating-point expression.
10288 >>> b = FP('b', FPSort(8, 24))
10293 >>> is_fp(Int('x'))
10296 return isinstance(a, FPRef)
10300 """Return `True` if `a` is a Z3 floating-point numeral value.
10302 >>> b = FP('b', FPSort(8, 24))
10305 >>> b = FPVal(1.0, FPSort(8, 24))
10311 return is_fp(a) and _is_numeral(a.ctx, a.ast)
10314def FPSort(ebits, sbits, ctx=None):
10315 """Return a Z3 floating-point sort of the given sizes. If `ctx=None`, then the global context is used.
10317 >>> Single = FPSort(8, 24)
10318 >>> Double = FPSort(11, 53)
10321 >>> x = Const('x', Single)
10322 >>> eq(x, FP('x', FPSort(8, 24)))
10325 ctx = _get_ctx(ctx)
10326 return FPSortRef(Z3_mk_fpa_sort(ctx.ref(), ebits, sbits), ctx)
10329def _to_float_str(val, exp=0):
10330 if isinstance(val, float):
10331 if math.isnan(val):
10334 sone = math.copysign(1.0, val)
10339 elif val == float("+inf"):
10341 elif val == float("-inf"):
10344 v = val.as_integer_ratio()
10347 rvs = str(num) + "/" + str(den)
10348 res = rvs + "p" + _to_int_str(exp)
10349 elif isinstance(val, bool):
10356 elif isinstance(val, str):
10357 inx = val.find("*(2**")
10360 elif val[-1] == ")":
10362 exp = str(int(val[inx + 5:-1]) + int(exp))
10364 _z3_assert(False, "String does not have floating-point numeral form.")
10366 _z3_assert(False, "Python value cannot be used to create floating-point numerals.")
10370 return res + "p" + exp
10374 """Create a Z3 floating-point NaN term.
10376 >>> s = FPSort(8, 24)
10377 >>> set_fpa_pretty(True)
10380 >>> pb = get_fpa_pretty()
10381 >>> set_fpa_pretty(False)
10383 fpNaN(FPSort(8, 24))
10384 >>> set_fpa_pretty(pb)
10386 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10387 return FPNumRef(Z3_mk_fpa_nan(s.ctx_ref(), s.ast), s.ctx)
10390def fpPlusInfinity(s):
10391 """Create a Z3 floating-point +oo term.
10393 >>> s = FPSort(8, 24)
10394 >>> pb = get_fpa_pretty()
10395 >>> set_fpa_pretty(True)
10396 >>> fpPlusInfinity(s)
10398 >>> set_fpa_pretty(False)
10399 >>> fpPlusInfinity(s)
10400 fpPlusInfinity(FPSort(8, 24))
10401 >>> set_fpa_pretty(pb)
10403 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10404 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, False), s.ctx)
10407def fpMinusInfinity(s):
10408 """Create a Z3 floating-point -oo term."""
10409 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10410 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, True), s.ctx)
10413def fpInfinity(s, negative):
10414 """Create a Z3 floating-point +oo or -oo term."""
10415 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10416 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10417 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, negative), s.ctx)
10421 """Create a Z3 floating-point +0.0 term."""
10422 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10423 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, False), s.ctx)
10427 """Create a Z3 floating-point -0.0 term."""
10428 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10429 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, True), s.ctx)
10432def fpZero(s, negative):
10433 """Create a Z3 floating-point +0.0 or -0.0 term."""
10434 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10435 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10436 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, negative), s.ctx)
10439def FPVal(sig, exp=None, fps=None, ctx=None):
10440 """Return a floating-point value of value `val` and sort `fps`.
10441 If `ctx=None`, then the global context is used.
10443 >>> v = FPVal(20.0, FPSort(8, 24))
10446 >>> print("0x%.8x" % v.exponent_as_long(False))
10448 >>> v = FPVal(2.25, FPSort(8, 24))
10451 >>> v = FPVal(-2.25, FPSort(8, 24))
10454 >>> FPVal(-0.0, FPSort(8, 24))
10456 >>> FPVal(0.0, FPSort(8, 24))
10458 >>> FPVal(+0.0, FPSort(8, 24))
10461 ctx = _get_ctx(ctx)
10462 if is_fp_sort(exp):
10466 fps = _dflt_fps(ctx)
10467 _z3_assert(is_fp_sort(fps), "sort mismatch")
10470 val = _to_float_str(sig)
10471 if val == "NaN" or val == "nan":
10473 elif val == "-0.0":
10474 return fpMinusZero(fps)
10475 elif val == "0.0" or val == "+0.0":
10476 return fpPlusZero(fps)
10477 elif val == "+oo" or val == "+inf" or val == "+Inf":
10478 return fpPlusInfinity(fps)
10479 elif val == "-oo" or val == "-inf" or val == "-Inf":
10480 return fpMinusInfinity(fps)
10482 return FPNumRef(Z3_mk_numeral(ctx.ref(), val, fps.ast), ctx)
10485def FP(name, fpsort, ctx=None):
10486 """Return a floating-point constant named `name`.
10487 `fpsort` is the floating-point sort.
10488 If `ctx=None`, then the global context is used.
10490 >>> x = FP('x', FPSort(8, 24))
10497 >>> word = FPSort(8, 24)
10498 >>> x2 = FP('x', word)
10502 if isinstance(fpsort, FPSortRef) and ctx is None:
10505 ctx = _get_ctx(ctx)
10506 return FPRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), fpsort.ast), ctx)
10509def FPs(names, fpsort, ctx=None):
10510 """Return an array of floating-point constants.
10512 >>> x, y, z = FPs('x y z', FPSort(8, 24))
10519 >>> fpMul(RNE(), fpAdd(RNE(), x, y), z)
10522 ctx = _get_ctx(ctx)
10523 if isinstance(names, str):
10524 names = names.split(" ")
10525 return [FP(name, fpsort, ctx) for name in names]
10528def fpAbs(a, ctx=None):
10529 """Create a Z3 floating-point absolute value expression.
10531 >>> s = FPSort(8, 24)
10533 >>> x = FPVal(1.0, s)
10536 >>> y = FPVal(-20.0, s)
10540 fpAbs(-1.25*(2**4))
10541 >>> fpAbs(-1.25*(2**4))
10542 fpAbs(-1.25*(2**4))
10543 >>> fpAbs(x).sort()
10546 ctx = _get_ctx(ctx)
10547 [a] = _coerce_fp_expr_list([a], ctx)
10548 return FPRef(Z3_mk_fpa_abs(ctx.ref(), a.as_ast()), ctx)
10551def fpNeg(a, ctx=None):
10552 """Create a Z3 floating-point addition expression.
10554 >>> s = FPSort(8, 24)
10559 >>> fpNeg(x).sort()
10562 ctx = _get_ctx(ctx)
10563 [a] = _coerce_fp_expr_list([a], ctx)
10564 return FPRef(Z3_mk_fpa_neg(ctx.ref(), a.as_ast()), ctx)
10567def _mk_fp_unary(f, rm, a, ctx):
10568 ctx = _get_ctx(ctx)
10569 [a] = _coerce_fp_expr_list([a], ctx)
10571 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10572 _z3_assert(is_fp(a), "Second argument must be a Z3 floating-point expression")
10573 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast()), ctx)
10576def _mk_fp_unary_pred(f, a, ctx):
10577 ctx = _get_ctx(ctx)
10578 [a] = _coerce_fp_expr_list([a], ctx)
10580 _z3_assert(is_fp(a), "First argument must be a Z3 floating-point expression")
10581 return BoolRef(f(ctx.ref(), a.as_ast()), ctx)
10584def _mk_fp_bin(f, rm, a, b, ctx):
10585 ctx = _get_ctx(ctx)
10586 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10588 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10589 _z3_assert(is_fp(a) or is_fp(b), "Second or third argument must be a Z3 floating-point expression")
10590 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast()), ctx)
10593def _mk_fp_bin_norm(f, a, b, ctx):
10594 ctx = _get_ctx(ctx)
10595 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10597 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10598 return FPRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10601def _mk_fp_bin_pred(f, a, b, ctx):
10602 ctx = _get_ctx(ctx)
10603 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10605 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10606 return BoolRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10609def _mk_fp_tern(f, rm, a, b, c, ctx):
10610 ctx = _get_ctx(ctx)
10611 [a, b, c] = _coerce_fp_expr_list([a, b, c], ctx)
10613 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10614 _z3_assert(is_fp(a) or is_fp(b) or is_fp(
10615 c), "Second, third or fourth argument must be a Z3 floating-point expression")
10616 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast(), c.as_ast()), ctx)
10619def fpAdd(rm, a, b, ctx=None):
10620 """Create a Z3 floating-point addition expression.
10622 >>> s = FPSort(8, 24)
10626 >>> fpAdd(rm, x, y)
10628 >>> fpAdd(RTZ(), x, y) # default rounding mode is RTZ
10630 >>> fpAdd(rm, x, y).sort()
10633 return _mk_fp_bin(Z3_mk_fpa_add, rm, a, b, ctx)
10636def fpSub(rm, a, b, ctx=None):
10637 """Create a Z3 floating-point subtraction expression.
10639 >>> s = FPSort(8, 24)
10643 >>> fpSub(rm, x, y)
10645 >>> fpSub(rm, x, y).sort()
10648 return _mk_fp_bin(Z3_mk_fpa_sub, rm, a, b, ctx)
10651def fpMul(rm, a, b, ctx=None):
10652 """Create a Z3 floating-point multiplication expression.
10654 >>> s = FPSort(8, 24)
10658 >>> fpMul(rm, x, y)
10660 >>> fpMul(rm, x, y).sort()
10663 return _mk_fp_bin(Z3_mk_fpa_mul, rm, a, b, ctx)
10666def fpDiv(rm, a, b, ctx=None):
10667 """Create a Z3 floating-point division expression.
10669 >>> s = FPSort(8, 24)
10673 >>> fpDiv(rm, x, y)
10675 >>> fpDiv(rm, x, y).sort()
10678 return _mk_fp_bin(Z3_mk_fpa_div, rm, a, b, ctx)
10681def fpRem(a, b, ctx=None):
10682 """Create a Z3 floating-point remainder expression.
10684 >>> s = FPSort(8, 24)
10689 >>> fpRem(x, y).sort()
10692 return _mk_fp_bin_norm(Z3_mk_fpa_rem, a, b, ctx)
10695def fpMin(a, b, ctx=None):
10696 """Create a Z3 floating-point minimum expression.
10698 >>> s = FPSort(8, 24)
10704 >>> fpMin(x, y).sort()
10707 return _mk_fp_bin_norm(Z3_mk_fpa_min, a, b, ctx)
10710def fpMax(a, b, ctx=None):
10711 """Create a Z3 floating-point maximum expression.
10713 >>> s = FPSort(8, 24)
10719 >>> fpMax(x, y).sort()
10722 return _mk_fp_bin_norm(Z3_mk_fpa_max, a, b, ctx)
10725def fpFMA(rm, a, b, c, ctx=None):
10726 """Create a Z3 floating-point fused multiply-add expression.
10728 return _mk_fp_tern(Z3_mk_fpa_fma, rm, a, b, c, ctx)
10731def fpSqrt(rm, a, ctx=None):
10732 """Create a Z3 floating-point square root expression.
10734 return _mk_fp_unary(Z3_mk_fpa_sqrt, rm, a, ctx)
10737def fpRoundToIntegral(rm, a, ctx=None):
10738 """Create a Z3 floating-point roundToIntegral expression.
10740 return _mk_fp_unary(Z3_mk_fpa_round_to_integral, rm, a, ctx)
10743def fpIsNaN(a, ctx=None):
10744 """Create a Z3 floating-point isNaN expression.
10746 >>> s = FPSort(8, 24)
10752 return _mk_fp_unary_pred(Z3_mk_fpa_is_nan, a, ctx)
10755def fpIsInf(a, ctx=None):
10756 """Create a Z3 floating-point isInfinite expression.
10758 >>> s = FPSort(8, 24)
10763 return _mk_fp_unary_pred(Z3_mk_fpa_is_infinite, a, ctx)
10766def fpIsZero(a, ctx=None):
10767 """Create a Z3 floating-point isZero expression.
10769 return _mk_fp_unary_pred(Z3_mk_fpa_is_zero, a, ctx)
10772def fpIsNormal(a, ctx=None):
10773 """Create a Z3 floating-point isNormal expression.
10775 return _mk_fp_unary_pred(Z3_mk_fpa_is_normal, a, ctx)
10778def fpIsSubnormal(a, ctx=None):
10779 """Create a Z3 floating-point isSubnormal expression.
10781 return _mk_fp_unary_pred(Z3_mk_fpa_is_subnormal, a, ctx)
10784def fpIsNegative(a, ctx=None):
10785 """Create a Z3 floating-point isNegative expression.
10787 return _mk_fp_unary_pred(Z3_mk_fpa_is_negative, a, ctx)
10790def fpIsPositive(a, ctx=None):
10791 """Create a Z3 floating-point isPositive expression.
10793 return _mk_fp_unary_pred(Z3_mk_fpa_is_positive, a, ctx)
10796def _check_fp_args(a, b):
10798 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10801def fpLT(a, b, ctx=None):
10802 """Create the Z3 floating-point expression `other < self`.
10804 >>> x, y = FPs('x y', FPSort(8, 24))
10807 >>> (x < y).sexpr()
10810 return _mk_fp_bin_pred(Z3_mk_fpa_lt, a, b, ctx)
10813def fpLEQ(a, b, ctx=None):
10814 """Create the Z3 floating-point expression `other <= self`.
10816 >>> x, y = FPs('x y', FPSort(8, 24))
10819 >>> (x <= y).sexpr()
10822 return _mk_fp_bin_pred(Z3_mk_fpa_leq, a, b, ctx)
10825def fpGT(a, b, ctx=None):
10826 """Create the Z3 floating-point expression `other > self`.
10828 >>> x, y = FPs('x y', FPSort(8, 24))
10831 >>> (x > y).sexpr()
10834 return _mk_fp_bin_pred(Z3_mk_fpa_gt, a, b, ctx)
10837def fpGEQ(a, b, ctx=None):
10838 """Create the Z3 floating-point expression `other >= self`.
10840 >>> x, y = FPs('x y', FPSort(8, 24))
10843 >>> (x >= y).sexpr()
10846 return _mk_fp_bin_pred(Z3_mk_fpa_geq, a, b, ctx)
10849def fpEQ(a, b, ctx=None):
10850 """Create the Z3 floating-point expression `fpEQ(other, self)`.
10852 >>> x, y = FPs('x y', FPSort(8, 24))
10855 >>> fpEQ(x, y).sexpr()
10858 return _mk_fp_bin_pred(Z3_mk_fpa_eq, a, b, ctx)
10861def fpNEQ(a, b, ctx=None):
10862 """Create the Z3 floating-point expression `Not(fpEQ(other, self))`.
10864 >>> x, y = FPs('x y', FPSort(8, 24))
10867 >>> (x != y).sexpr()
10870 return Not(fpEQ(a, b, ctx))
10873def fpFP(sgn, exp, sig, ctx=None):
10874 """Create the Z3 floating-point value `fpFP(sgn, sig, exp)` from the three bit-vectors sgn, sig, and exp.
10876 >>> s = FPSort(8, 24)
10877 >>> x = fpFP(BitVecVal(1, 1), BitVecVal(2**7-1, 8), BitVecVal(2**22, 23))
10879 fpFP(1, 127, 4194304)
10880 >>> xv = FPVal(-1.5, s)
10883 >>> slvr = Solver()
10884 >>> slvr.add(fpEQ(x, xv))
10887 >>> xv = FPVal(+1.5, s)
10890 >>> slvr = Solver()
10891 >>> slvr.add(fpEQ(x, xv))
10895 _z3_assert(is_bv(sgn) and is_bv(exp) and is_bv(sig), "sort mismatch")
10896 _z3_assert(sgn.sort().size() == 1, "sort mismatch")
10897 ctx = _get_ctx(ctx)
10898 _z3_assert(ctx == sgn.ctx == exp.ctx == sig.ctx, "context mismatch")
10899 return FPRef(Z3_mk_fpa_fp(ctx.ref(), sgn.ast, exp.ast, sig.ast), ctx)
10902def fpToFP(a1, a2=None, a3=None, ctx=None):
10903 """Create a Z3 floating-point conversion expression from other term sorts
10906 From a bit-vector term in IEEE 754-2008 format:
10907 >>> x = FPVal(1.0, Float32())
10908 >>> x_bv = fpToIEEEBV(x)
10909 >>> simplify(fpToFP(x_bv, Float32()))
10912 From a floating-point term with different precision:
10913 >>> x = FPVal(1.0, Float32())
10914 >>> x_db = fpToFP(RNE(), x, Float64())
10919 >>> x_r = RealVal(1.5)
10920 >>> simplify(fpToFP(RNE(), x_r, Float32()))
10923 From a signed bit-vector term:
10924 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10925 >>> simplify(fpToFP(RNE(), x_signed, Float32()))
10928 ctx = _get_ctx(ctx)
10929 if is_bv(a1) and is_fp_sort(a2):
10930 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), a1.ast, a2.ast), ctx)
10931 elif is_fprm(a1) and is_fp(a2) and is_fp_sort(a3):
10932 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10933 elif is_fprm(a1) and is_real(a2) and is_fp_sort(a3):
10934 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10935 elif is_fprm(a1) and is_bv(a2) and is_fp_sort(a3):
10936 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10938 raise Z3Exception("Unsupported combination of arguments for conversion to floating-point term.")
10941def fpBVToFP(v, sort, ctx=None):
10942 """Create a Z3 floating-point conversion expression that represents the
10943 conversion from a bit-vector term to a floating-point term.
10945 >>> x_bv = BitVecVal(0x3F800000, 32)
10946 >>> x_fp = fpBVToFP(x_bv, Float32())
10952 _z3_assert(is_bv(v), "First argument must be a Z3 bit-vector expression")
10953 _z3_assert(is_fp_sort(sort), "Second argument must be a Z3 floating-point sort.")
10954 ctx = _get_ctx(ctx)
10955 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), v.ast, sort.ast), ctx)
10958def fpFPToFP(rm, v, sort, ctx=None):
10959 """Create a Z3 floating-point conversion expression that represents the
10960 conversion from a floating-point term to a floating-point term of different precision.
10962 >>> x_sgl = FPVal(1.0, Float32())
10963 >>> x_dbl = fpFPToFP(RNE(), x_sgl, Float64())
10966 >>> simplify(x_dbl)
10971 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10972 _z3_assert(is_fp(v), "Second argument must be a Z3 floating-point expression.")
10973 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10974 ctx = _get_ctx(ctx)
10975 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10978def fpRealToFP(rm, v, sort, ctx=None):
10979 """Create a Z3 floating-point conversion expression that represents the
10980 conversion from a real term to a floating-point term.
10982 >>> x_r = RealVal(1.5)
10983 >>> x_fp = fpRealToFP(RNE(), x_r, Float32())
10989 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10990 _z3_assert(is_real(v), "Second argument must be a Z3 expression or real sort.")
10991 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10992 ctx = _get_ctx(ctx)
10993 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10996def fpSignedToFP(rm, v, sort, ctx=None):
10997 """Create a Z3 floating-point conversion expression that represents the
10998 conversion from a signed bit-vector term (encoding an integer) to a floating-point term.
11000 >>> x_signed = BitVecVal(-5, BitVecSort(32))
11001 >>> x_fp = fpSignedToFP(RNE(), x_signed, Float32())
11003 fpToFP(RNE(), 4294967291)
11007 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
11008 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
11009 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
11010 ctx = _get_ctx(ctx)
11011 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
11014def fpUnsignedToFP(rm, v, sort, ctx=None):
11015 """Create a Z3 floating-point conversion expression that represents the
11016 conversion from an unsigned bit-vector term (encoding an integer) to a floating-point term.
11018 >>> x_signed = BitVecVal(-5, BitVecSort(32))
11019 >>> x_fp = fpUnsignedToFP(RNE(), x_signed, Float32())
11021 fpToFPUnsigned(RNE(), 4294967291)
11025 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
11026 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
11027 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
11028 ctx = _get_ctx(ctx)
11029 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
11032def fpToFPUnsigned(rm, x, s, ctx=None):
11033 """Create a Z3 floating-point conversion expression, from unsigned bit-vector to floating-point expression."""
11035 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
11036 _z3_assert(is_bv(x), "Second argument must be a Z3 bit-vector expression")
11037 _z3_assert(is_fp_sort(s), "Third argument must be Z3 floating-point sort")
11038 ctx = _get_ctx(ctx)
11039 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, x.ast, s.ast), ctx)
11042def fpToSBV(rm, x, s, ctx=None):
11043 """Create a Z3 floating-point conversion expression, from floating-point expression to signed bit-vector.
11045 >>> x = FP('x', FPSort(8, 24))
11046 >>> y = fpToSBV(RTZ(), x, BitVecSort(32))
11047 >>> print(is_fp(x))
11049 >>> print(is_bv(y))
11051 >>> print(is_fp(y))
11053 >>> print(is_bv(x))
11057 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
11058 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
11059 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
11060 ctx = _get_ctx(ctx)
11061 return BitVecRef(Z3_mk_fpa_to_sbv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
11064def fpToUBV(rm, x, s, ctx=None):
11065 """Create a Z3 floating-point conversion expression, from floating-point expression to unsigned bit-vector.
11067 >>> x = FP('x', FPSort(8, 24))
11068 >>> y = fpToUBV(RTZ(), x, BitVecSort(32))
11069 >>> print(is_fp(x))
11071 >>> print(is_bv(y))
11073 >>> print(is_fp(y))
11075 >>> print(is_bv(x))
11079 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
11080 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
11081 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
11082 ctx = _get_ctx(ctx)
11083 return BitVecRef(Z3_mk_fpa_to_ubv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
11086def fpToReal(x, ctx=None):
11087 """Create a Z3 floating-point conversion expression, from floating-point expression to real.
11089 >>> x = FP('x', FPSort(8, 24))
11090 >>> y = fpToReal(x)
11091 >>> print(is_fp(x))
11093 >>> print(is_real(y))
11095 >>> print(is_fp(y))
11097 >>> print(is_real(x))
11101 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
11102 ctx = _get_ctx(ctx)
11103 return ArithRef(Z3_mk_fpa_to_real(ctx.ref(), x.ast), ctx)
11106def fpToIEEEBV(x, ctx=None):
11107 """\brief Conversion of a floating-point term into a bit-vector term in IEEE 754-2008 format.
11109 The size of the resulting bit-vector is automatically determined.
11111 Note that IEEE 754-2008 allows multiple different representations of NaN. This conversion
11112 knows only one NaN and it will always produce the same bit-vector representation of
11115 >>> x = FP('x', FPSort(8, 24))
11116 >>> y = fpToIEEEBV(x)
11117 >>> print(is_fp(x))
11119 >>> print(is_bv(y))
11121 >>> print(is_fp(y))
11123 >>> print(is_bv(x))
11127 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
11128 ctx = _get_ctx(ctx)
11129 return BitVecRef(Z3_mk_fpa_to_ieee_bv(ctx.ref(), x.ast), ctx)
11132#########################################
11134# Strings, Sequences and Regular expressions
11136#########################################
11138class SeqSortRef(SortRef):
11139 """Sequence sort."""
11141 def is_string(self):
11142 """Determine if sort is a string
11143 >>> s = StringSort()
11146 >>> s = SeqSort(IntSort())
11150 return Z3_is_string_sort(self.ctx_ref(), self.ast)
11153 return _to_sort_ref(Z3_get_seq_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11155class CharSortRef(SortRef):
11156 """Character sort."""
11159def StringSort(ctx=None):
11160 """Create a string sort
11161 >>> s = StringSort()
11165 ctx = _get_ctx(ctx)
11166 return SeqSortRef(Z3_mk_string_sort(ctx.ref()), ctx)
11168def CharSort(ctx=None):
11169 """Create a character sort
11170 >>> ch = CharSort()
11174 ctx = _get_ctx(ctx)
11175 return CharSortRef(Z3_mk_char_sort(ctx.ref()), ctx)
11179 """Create a sequence sort over elements provided in the argument
11180 >>> s = SeqSort(IntSort())
11181 >>> s == Unit(IntVal(1)).sort()
11184 return SeqSortRef(Z3_mk_seq_sort(s.ctx_ref(), s.ast), s.ctx)
11187class SeqRef(ExprRef):
11188 """Sequence expression."""
11191 return SeqSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
11193 def __add__(self, other):
11194 return Concat(self, other)
11196 def __radd__(self, other):
11197 return Concat(other, self)
11199 def __getitem__(self, i):
11201 i = IntVal(i, self.ctx)
11202 return _to_expr_ref(Z3_mk_seq_nth(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11206 i = IntVal(i, self.ctx)
11207 return SeqRef(Z3_mk_seq_at(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11209 def is_string(self):
11210 return Z3_is_string_sort(self.ctx_ref(), Z3_get_sort(self.ctx_ref(), self.as_ast()))
11212 def is_string_value(self):
11213 return Z3_is_string(self.ctx_ref(), self.as_ast())
11215 def as_string(self):
11216 """Return a string representation of sequence expression."""
11217 if self.is_string_value():
11218 string_length = ctypes.c_uint()
11219 chars = Z3_get_lstring(self.ctx_ref(), self.as_ast(), byref(string_length))
11220 return string_at(chars, size=string_length.value).decode("latin-1")
11221 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
11223 def py_value(self):
11224 return self.as_string()
11226 def __le__(self, other):
11227 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11229 def __lt__(self, other):
11230 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11232 def __ge__(self, other):
11233 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11235 def __gt__(self, other):
11236 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11239def _coerce_char(ch, ctx=None):
11240 if isinstance(ch, str):
11241 ctx = _get_ctx(ctx)
11242 ch = CharVal(ch, ctx)
11243 if not is_expr(ch):
11244 raise Z3Exception("Character expression expected")
11247class CharRef(ExprRef):
11248 """Character expression."""
11250 def __le__(self, other):
11251 other = _coerce_char(other, self.ctx)
11252 return _to_expr_ref(Z3_mk_char_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11255 return _to_expr_ref(Z3_mk_char_to_int(self.ctx_ref(), self.as_ast()), self.ctx)
11258 return _to_expr_ref(Z3_mk_char_to_bv(self.ctx_ref(), self.as_ast()), self.ctx)
11260 def is_digit(self):
11261 return _to_expr_ref(Z3_mk_char_is_digit(self.ctx_ref(), self.as_ast()), self.ctx)
11264def CharVal(ch, ctx=None):
11265 ctx = _get_ctx(ctx)
11266 if isinstance(ch, str):
11268 if not isinstance(ch, int):
11269 raise Z3Exception("character value should be an ordinal")
11270 return _to_expr_ref(Z3_mk_char(ctx.ref(), ch), ctx)
11273 if not is_expr(bv):
11274 raise Z3Exception("Bit-vector expression needed")
11275 return _to_expr_ref(Z3_mk_char_from_bv(bv.ctx_ref(), bv.as_ast()), bv.ctx)
11277def CharToBv(ch, ctx=None):
11278 ch = _coerce_char(ch, ctx)
11281def CharToInt(ch, ctx=None):
11282 ch = _coerce_char(ch, ctx)
11285def CharIsDigit(ch, ctx=None):
11286 ch = _coerce_char(ch, ctx)
11287 return ch.is_digit()
11289def _coerce_seq(s, ctx=None):
11290 if isinstance(s, str):
11291 ctx = _get_ctx(ctx)
11292 s = StringVal(s, ctx)
11294 raise Z3Exception("Non-expression passed as a sequence")
11296 raise Z3Exception("Non-sequence passed as a sequence")
11300def _get_ctx2(a, b, ctx=None):
11311 """Return `True` if `a` is a Z3 sequence expression.
11312 >>> print (is_seq(Unit(IntVal(0))))
11314 >>> print (is_seq(StringVal("abc")))
11317 return isinstance(a, SeqRef)
11320def is_string(a: Any) -> bool:
11321 """Return `True` if `a` is a Z3 string expression.
11322 >>> print (is_string(StringVal("ab")))
11325 return isinstance(a, SeqRef) and a.is_string()
11328def is_string_value(a: Any) -> bool:
11329 """return 'True' if 'a' is a Z3 string constant expression.
11330 >>> print (is_string_value(StringVal("a")))
11332 >>> print (is_string_value(StringVal("a") + StringVal("b")))
11335 return isinstance(a, SeqRef) and a.is_string_value()
11337def StringVal(s, ctx=None):
11338 """create a string expression"""
11339 s = "".join(str(ch) if 32 <= ord(ch) and ord(ch) < 127 else "\\u{%x}" % (ord(ch)) for ch in s)
11340 ctx = _get_ctx(ctx)
11341 return SeqRef(Z3_mk_string(ctx.ref(), s), ctx)
11344def String(name, ctx=None):
11345 """Return a string constant named `name`. If `ctx=None`, then the global context is used.
11347 >>> x = String('x')
11349 ctx = _get_ctx(ctx)
11350 return SeqRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), StringSort(ctx).ast), ctx)
11353def Strings(names, ctx=None):
11354 """Return a tuple of String constants. """
11355 ctx = _get_ctx(ctx)
11356 if isinstance(names, str):
11357 names = names.split(" ")
11358 return [String(name, ctx) for name in names]
11361def SubString(s, offset, length):
11362 """Extract substring or subsequence starting at offset.
11364 This is a convenience function that redirects to Extract(s, offset, length).
11366 >>> s = StringVal("hello world")
11367 >>> SubString(s, 6, 5) # Extract "world"
11368 str.substr("hello world", 6, 5)
11369 >>> simplify(SubString(StringVal("hello"), 1, 3))
11372 return Extract(s, offset, length)
11375def SubSeq(s, offset, length):
11376 """Extract substring or subsequence starting at offset.
11378 This is a convenience function that redirects to Extract(s, offset, length).
11380 >>> s = StringVal("hello world")
11381 >>> SubSeq(s, 0, 5) # Extract "hello"
11382 str.substr("hello world", 0, 5)
11383 >>> simplify(SubSeq(StringVal("testing"), 2, 4))
11386 return Extract(s, offset, length)
11390 """Create the empty sequence of the given sort
11391 >>> e = Empty(StringSort())
11392 >>> e2 = StringVal("")
11393 >>> print(e.eq(e2))
11395 >>> e3 = Empty(SeqSort(IntSort()))
11398 >>> e4 = Empty(ReSort(SeqSort(IntSort())))
11400 Empty(ReSort(Seq(Int)))
11402 if isinstance(s, SeqSortRef):
11403 return SeqRef(Z3_mk_seq_empty(s.ctx_ref(), s.ast), s.ctx)
11404 if isinstance(s, ReSortRef):
11405 return ReRef(Z3_mk_re_empty(s.ctx_ref(), s.ast), s.ctx)
11406 raise Z3Exception("Non-sequence, non-regular expression sort passed to Empty")
11410 """Create the regular expression that accepts the universal language
11411 >>> e = Full(ReSort(SeqSort(IntSort())))
11413 Full(ReSort(Seq(Int)))
11414 >>> e1 = Full(ReSort(StringSort()))
11416 Full(ReSort(String))
11418 if isinstance(s, ReSortRef):
11419 return ReRef(Z3_mk_re_full(s.ctx_ref(), s.ast), s.ctx)
11420 raise Z3Exception("Non-sequence, non-regular expression sort passed to Full")
11425 """Create a singleton sequence"""
11426 return SeqRef(Z3_mk_seq_unit(a.ctx_ref(), a.as_ast()), a.ctx)
11430 """Check if 'a' is a prefix of 'b'
11431 >>> s1 = PrefixOf("ab", "abc")
11434 >>> s2 = PrefixOf("bc", "abc")
11438 ctx = _get_ctx2(a, b)
11439 a = _coerce_seq(a, ctx)
11440 b = _coerce_seq(b, ctx)
11441 return BoolRef(Z3_mk_seq_prefix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11445 """Check if 'a' is a suffix of 'b'
11446 >>> s1 = SuffixOf("ab", "abc")
11449 >>> s2 = SuffixOf("bc", "abc")
11453 ctx = _get_ctx2(a, b)
11454 a = _coerce_seq(a, ctx)
11455 b = _coerce_seq(b, ctx)
11456 return BoolRef(Z3_mk_seq_suffix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11460 """Check if 'a' contains 'b'
11461 >>> s1 = Contains("abc", "ab")
11464 >>> s2 = Contains("abc", "bc")
11467 >>> x, y, z = Strings('x y z')
11468 >>> s3 = Contains(Concat(x,y,z), y)
11472 ctx = _get_ctx2(a, b)
11473 a = _coerce_seq(a, ctx)
11474 b = _coerce_seq(b, ctx)
11475 return BoolRef(Z3_mk_seq_contains(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11478def Replace(s, src, dst):
11479 """Replace the first occurrence of 'src' by 'dst' in 's'
11480 >>> r = Replace("aaa", "a", "b")
11484 ctx = _get_ctx2(dst, s)
11485 if ctx is None and is_expr(src):
11487 src = _coerce_seq(src, ctx)
11488 dst = _coerce_seq(dst, ctx)
11489 s = _coerce_seq(s, ctx)
11490 return SeqRef(Z3_mk_seq_replace(src.ctx_ref(), s.as_ast(), src.as_ast(), dst.as_ast()), s.ctx)
11493def IndexOf(s, substr, offset=None):
11494 """Retrieve the index of substring within a string starting at a specified offset.
11495 >>> simplify(IndexOf("abcabc", "bc", 0))
11497 >>> simplify(IndexOf("abcabc", "bc", 2))
11503 if is_expr(offset):
11505 ctx = _get_ctx2(s, substr, ctx)
11506 s = _coerce_seq(s, ctx)
11507 substr = _coerce_seq(substr, ctx)
11508 if _is_int(offset):
11509 offset = IntVal(offset, ctx)
11510 return ArithRef(Z3_mk_seq_index(s.ctx_ref(), s.as_ast(), substr.as_ast(), offset.as_ast()), s.ctx)
11513def LastIndexOf(s, substr):
11514 """Retrieve the last index of substring within a string"""
11516 ctx = _get_ctx2(s, substr, ctx)
11517 s = _coerce_seq(s, ctx)
11518 substr = _coerce_seq(substr, ctx)
11519 return ArithRef(Z3_mk_seq_last_index(s.ctx_ref(), s.as_ast(), substr.as_ast()), s.ctx)
11523 """Obtain the length of a sequence 's'
11524 >>> l = Length(StringVal("abc"))
11529 return ArithRef(Z3_mk_seq_length(s.ctx_ref(), s.as_ast()), s.ctx)
11532 """Map function 'f' over sequence 's'"""
11533 ctx = _get_ctx2(f, s)
11534 s = _coerce_seq(s, ctx)
11535 return _to_expr_ref(Z3_mk_seq_map(s.ctx_ref(), f.as_ast(), s.as_ast()), ctx)
11537def SeqMapI(f, i, s):
11538 """Map function 'f' over sequence 's' at index 'i'"""
11539 ctx = _get_ctx2(f, s)
11540 s = _coerce_seq(s, ctx)
11543 return _to_expr_ref(Z3_mk_seq_mapi(s.ctx_ref(), f.as_ast(), i.as_ast(), s.as_ast()), ctx)
11545def SeqFoldLeft(f, a, s):
11546 ctx = _get_ctx2(f, s)
11547 s = _coerce_seq(s, ctx)
11549 return _to_expr_ref(Z3_mk_seq_foldl(s.ctx_ref(), f.as_ast(), a.as_ast(), s.as_ast()), ctx)
11551def SeqFoldLeftI(f, i, a, s):
11552 ctx = _get_ctx2(f, s)
11553 s = _coerce_seq(s, ctx)
11556 return _to_expr_ref(Z3_mk_seq_foldli(s.ctx_ref(), f.as_ast(), i.as_ast(), a.as_ast(), s.as_ast()), ctx)
11559 """Convert string expression to integer
11560 >>> a = StrToInt("1")
11561 >>> simplify(1 == a)
11563 >>> b = StrToInt("2")
11564 >>> simplify(1 == b)
11566 >>> c = StrToInt(IntToStr(2))
11567 >>> simplify(1 == c)
11571 return ArithRef(Z3_mk_str_to_int(s.ctx_ref(), s.as_ast()), s.ctx)
11575 """Convert integer expression to string"""
11578 return SeqRef(Z3_mk_int_to_str(s.ctx_ref(), s.as_ast()), s.ctx)
11582 """Convert a unit length string to integer code"""
11585 return ArithRef(Z3_mk_string_to_code(s.ctx_ref(), s.as_ast()), s.ctx)
11588 """Convert code to a string"""
11591 return SeqRef(Z3_mk_string_from_code(c.ctx_ref(), c.as_ast()), c.ctx)
11593def Re(s, ctx=None):
11594 """The regular expression that accepts sequence 's'
11596 >>> s2 = Re(StringVal("ab"))
11597 >>> s3 = Re(Unit(BoolVal(True)))
11599 s = _coerce_seq(s, ctx)
11600 return ReRef(Z3_mk_seq_to_re(s.ctx_ref(), s.as_ast()), s.ctx)
11603# Regular expressions
11605class ReSortRef(SortRef):
11606 """Regular expression sort."""
11609 return _to_sort_ref(Z3_get_re_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11614 return ReSortRef(Z3_mk_re_sort(s.ctx.ref(), s.ast), s.ctx)
11615 if s is None or isinstance(s, Context):
11617 return ReSortRef(Z3_mk_re_sort(ctx.ref(), Z3_mk_string_sort(ctx.ref())), s.ctx)
11618 raise Z3Exception("Regular expression sort constructor expects either a string or a context or no argument")
11621class ReRef(ExprRef):
11622 """Regular expressions."""
11624 def __add__(self, other):
11625 return Union(self, other)
11629 return isinstance(s, ReRef)
11633 """Create regular expression membership test
11634 >>> re = Union(Re("a"),Re("b"))
11635 >>> print (simplify(InRe("a", re)))
11637 >>> print (simplify(InRe("b", re)))
11639 >>> print (simplify(InRe("c", re)))
11642 s = _coerce_seq(s, re.ctx)
11643 return BoolRef(Z3_mk_seq_in_re(s.ctx_ref(), s.as_ast(), re.as_ast()), s.ctx)
11647 """Create union of regular expressions.
11648 >>> re = Union(Re("a"), Re("b"), Re("c"))
11649 >>> print (simplify(InRe("d", re)))
11652 args = _get_args(args)
11655 _z3_assert(sz > 0, "At least one argument expected.")
11656 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11661 for i in range(sz):
11662 v[i] = args[i].as_ast()
11663 return ReRef(Z3_mk_re_union(ctx.ref(), sz, v), ctx)
11666def Intersect(*args):
11667 """Create intersection of regular expressions.
11668 >>> re = Intersect(Re("a"), Re("b"), Re("c"))
11670 args = _get_args(args)
11673 _z3_assert(sz > 0, "At least one argument expected.")
11674 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11679 for i in range(sz):
11680 v[i] = args[i].as_ast()
11681 return ReRef(Z3_mk_re_intersect(ctx.ref(), sz, v), ctx)
11685 """Create the regular expression accepting one or more repetitions of argument.
11686 >>> re = Plus(Re("a"))
11687 >>> print(simplify(InRe("aa", re)))
11689 >>> print(simplify(InRe("ab", re)))
11691 >>> print(simplify(InRe("", re)))
11695 _z3_assert(is_expr(re), "expression expected")
11696 return ReRef(Z3_mk_re_plus(re.ctx_ref(), re.as_ast()), re.ctx)
11700 """Create the regular expression that optionally accepts the argument.
11701 >>> re = Option(Re("a"))
11702 >>> print(simplify(InRe("a", re)))
11704 >>> print(simplify(InRe("", re)))
11706 >>> print(simplify(InRe("aa", re)))
11710 _z3_assert(is_expr(re), "expression expected")
11711 return ReRef(Z3_mk_re_option(re.ctx_ref(), re.as_ast()), re.ctx)
11715 """Create the complement regular expression."""
11716 return ReRef(Z3_mk_re_complement(re.ctx_ref(), re.as_ast()), re.ctx)
11720 """Create the regular expression accepting zero or more repetitions of argument.
11721 >>> re = Star(Re("a"))
11722 >>> print(simplify(InRe("aa", re)))
11724 >>> print(simplify(InRe("ab", re)))
11726 >>> print(simplify(InRe("", re)))
11730 _z3_assert(is_expr(re), "expression expected")
11731 return ReRef(Z3_mk_re_star(re.ctx_ref(), re.as_ast()), re.ctx)
11734def Loop(re, lo, hi=0):
11735 """Create the regular expression accepting between a lower and upper bound repetitions
11736 >>> re = Loop(Re("a"), 1, 3)
11737 >>> print(simplify(InRe("aa", re)))
11739 >>> print(simplify(InRe("aaaa", re)))
11741 >>> print(simplify(InRe("", re)))
11745 _z3_assert(is_expr(re), "expression expected")
11746 return ReRef(Z3_mk_re_loop(re.ctx_ref(), re.as_ast(), lo, hi), re.ctx)
11749def Range(lo, hi, ctx=None):
11750 """Create the range regular expression over two sequences of length 1
11751 >>> range = Range("a","z")
11752 >>> print(simplify(InRe("b", range)))
11754 >>> print(simplify(InRe("bb", range)))
11757 lo = _coerce_seq(lo, ctx)
11758 hi = _coerce_seq(hi, ctx)
11760 _z3_assert(is_expr(lo), "expression expected")
11761 _z3_assert(is_expr(hi), "expression expected")
11762 return ReRef(Z3_mk_re_range(lo.ctx_ref(), lo.ast, hi.ast), lo.ctx)
11764def Diff(a, b, ctx=None):
11765 """Create the difference regular expression
11768 _z3_assert(is_expr(a), "expression expected")
11769 _z3_assert(is_expr(b), "expression expected")
11770 return ReRef(Z3_mk_re_diff(a.ctx_ref(), a.ast, b.ast), a.ctx)
11772def AllChar(regex_sort, ctx=None):
11773 """Create a regular expression that accepts all single character strings
11775 return ReRef(Z3_mk_re_allchar(regex_sort.ctx_ref(), regex_sort.ast), regex_sort.ctx)
11780def PartialOrder(a, index):
11781 return FuncDeclRef(Z3_mk_partial_order(a.ctx_ref(), a.ast, index), a.ctx)
11784def LinearOrder(a, index):
11785 return FuncDeclRef(Z3_mk_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11788def TreeOrder(a, index):
11789 return FuncDeclRef(Z3_mk_tree_order(a.ctx_ref(), a.ast, index), a.ctx)
11792def PiecewiseLinearOrder(a, index):
11793 return FuncDeclRef(Z3_mk_piecewise_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11796def TransitiveClosure(f):
11797 """Given a binary relation R, such that the two arguments have the same sort
11798 create the transitive closure relation R+.
11799 The transitive closure R+ is a new relation.
11801 return FuncDeclRef(Z3_mk_transitive_closure(f.ctx_ref(), f.ast), f.ctx)
11805 super(ctypes.c_void_p, ast).__init__(ptr)
11808def to_ContextObj(ptr,):
11809 ctx = ContextObj(ptr)
11810 super(ctypes.c_void_p, ctx).__init__(ptr)
11813def to_AstVectorObj(ptr,):
11814 v = AstVectorObj(ptr)
11815 super(ctypes.c_void_p, v).__init__(ptr)
11818# NB. my-hacky-class only works for a single instance of OnClause
11819# it should be replaced with a proper correlation between OnClause
11820# and object references that can be passed over the FFI.
11821# for UserPropagator we use a global dictionary, which isn't great code.
11823_my_hacky_class = None
11824def on_clause_eh(ctx, p, n, dep, clause):
11825 onc = _my_hacky_class
11826 p = _to_expr_ref(to_Ast(p), onc.ctx)
11827 clause = AstVector(to_AstVectorObj(clause), onc.ctx)
11828 deps = [dep[i] for i in range(n)]
11829 onc.on_clause(p, deps, clause)
11831_on_clause_eh = Z3_on_clause_eh(on_clause_eh)
11834 def __init__(self, s, on_clause):
11837 self.on_clause = on_clause
11839 global _my_hacky_class
11840 _my_hacky_class = self
11841 Z3_solver_register_on_clause(self.ctx.ref(), self.s.solver, self.idx, _on_clause_eh)
11845 def __init__(self):
11849 def set_threaded(self):
11850 if self.lock is None:
11852 self.lock = threading.Lock()
11854 def get(self, ctx):
11857 r = self.bases[ctx]
11859 r = self.bases[ctx]
11862 def set(self, ctx, r):
11865 self.bases[ctx] = r
11867 self.bases[ctx] = r
11869 def insert(self, r):
11872 id = len(self.bases) + 3
11875 id = len(self.bases) + 3
11880_prop_closures = None
11883def ensure_prop_closures():
11884 global _prop_closures
11885 if _prop_closures is None:
11886 _prop_closures = PropClosures()
11889def user_prop_push(ctx, cb):
11890 prop = _prop_closures.get(ctx)
11895def user_prop_pop(ctx, cb, num_scopes):
11896 prop = _prop_closures.get(ctx)
11898 prop.pop(num_scopes)
11901def user_prop_fresh(ctx, _new_ctx):
11902 _prop_closures.set_threaded()
11903 prop = _prop_closures.get(ctx)
11905 Z3_del_context(nctx.ctx)
11906 new_ctx = to_ContextObj(_new_ctx)
11908 nctx.eh = Z3_set_error_handler(new_ctx, z3_error_handler)
11910 new_prop = prop.fresh(nctx)
11911 _prop_closures.set(new_prop.id, new_prop)
11915def user_prop_fixed(ctx, cb, id, value):
11916 prop = _prop_closures.get(ctx)
11919 id = _to_expr_ref(to_Ast(id), prop.ctx())
11920 value = _to_expr_ref(to_Ast(value), prop.ctx())
11921 prop.fixed(id, value)
11924def user_prop_created(ctx, cb, id):
11925 prop = _prop_closures.get(ctx)
11928 id = _to_expr_ref(to_Ast(id), prop.ctx())
11933def user_prop_final(ctx, cb):
11934 prop = _prop_closures.get(ctx)
11940def user_prop_eq(ctx, cb, x, y):
11941 prop = _prop_closures.get(ctx)
11944 x = _to_expr_ref(to_Ast(x), prop.ctx())
11945 y = _to_expr_ref(to_Ast(y), prop.ctx())
11949def user_prop_diseq(ctx, cb, x, y):
11950 prop = _prop_closures.get(ctx)
11953 x = _to_expr_ref(to_Ast(x), prop.ctx())
11954 y = _to_expr_ref(to_Ast(y), prop.ctx())
11958def user_prop_decide(ctx, cb, t_ref, idx, phase):
11959 prop = _prop_closures.get(ctx)
11962 t = _to_expr_ref(to_Ast(t_ref), prop.ctx())
11963 prop.decide(t, idx, phase)
11966def user_prop_binding(ctx, cb, q_ref, inst_ref):
11967 prop = _prop_closures.get(ctx)
11970 q = _to_expr_ref(to_Ast(q_ref), prop.ctx())
11971 inst = _to_expr_ref(to_Ast(inst_ref), prop.ctx())
11972 r = prop.binding(q, inst)
11977_user_prop_push = Z3_push_eh(user_prop_push)
11978_user_prop_pop = Z3_pop_eh(user_prop_pop)
11979_user_prop_fresh = Z3_fresh_eh(user_prop_fresh)
11980_user_prop_fixed = Z3_fixed_eh(user_prop_fixed)
11981_user_prop_created = Z3_created_eh(user_prop_created)
11982_user_prop_final = Z3_final_eh(user_prop_final)
11983_user_prop_eq = Z3_eq_eh(user_prop_eq)
11984_user_prop_diseq = Z3_eq_eh(user_prop_diseq)
11985_user_prop_decide = Z3_decide_eh(user_prop_decide)
11986_user_prop_binding = Z3_on_binding_eh(user_prop_binding)
11989def PropagateFunction(name, *sig):
11990 """Create a function that gets tracked by user propagator.
11991 Every term headed by this function symbol is tracked.
11992 If a term is fixed and the fixed callback is registered a
11993 callback is invoked that the term headed by this function is fixed.
11995 sig = _get_args(sig)
11997 _z3_assert(len(sig) > 0, "At least two arguments expected")
11998 arity = len(sig) - 1
12001 _z3_assert(is_sort(rng), "Z3 sort expected")
12002 dom = (Sort * arity)()
12003 for i in range(arity):
12005 _z3_assert(is_sort(sig[i]), "Z3 sort expected")
12006 dom[i] = sig[i].ast
12008 return FuncDeclRef(Z3_solver_propagate_declare(ctx.ref(), to_symbol(name, ctx), arity, dom, rng.ast), ctx)
12012class UserPropagateBase:
12015 # Either solver is set or ctx is set.
12016 # Propagators that are created through callbacks
12017 # to "fresh" inherit the context of that is supplied
12018 # as argument to the callback.
12019 # This context should not be deleted. It is owned by the solver.
12021 def __init__(self, s, ctx=None):
12022 assert s is None or ctx is None
12023 ensure_prop_closures()
12026 self.fresh_ctx = None
12028 self.id = _prop_closures.insert(self)
12034 self.created = None
12035 self.binding = None
12037 self.fresh_ctx = ctx
12039 Z3_solver_propagate_init(self.ctx_ref(),
12041 ctypes.c_void_p(self.id),
12048 self._ctx.ctx = None
12052 return self.fresh_ctx
12054 return self.solver.ctx
12057 return self.ctx().ref()
12059 def add_fixed(self, fixed):
12061 raise Z3Exception("fixed callback already registered")
12063 raise Z3Exception("context already initialized")
12065 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12068 def add_created(self, created):
12070 raise Z3Exception("created callback already registered")
12072 raise Z3Exception("context already initialized")
12074 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12075 self.created = created
12077 def add_final(self, final):
12079 raise Z3Exception("final callback already registered")
12081 raise Z3Exception("context already initialized")
12083 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12086 def add_eq(self, eq):
12088 raise Z3Exception("eq callback already registered")
12090 raise Z3Exception("context already initialized")
12092 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12095 def add_diseq(self, diseq):
12097 raise Z3Exception("diseq callback already registered")
12099 raise Z3Exception("context already initialized")
12101 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12104 def add_decide(self, decide):
12106 raise Z3Exception("decide callback already registered")
12108 raise Z3Exception("context already initialized")
12110 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12111 self.decide = decide
12113 def add_on_binding(self, binding):
12115 raise Z3Exception("binding callback already registered")
12117 raise Z3Exception("context already initialized")
12119 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12120 self.binding = binding
12123 raise Z3Exception("push needs to be overwritten")
12125 def pop(self, num_scopes):
12126 raise Z3Exception("pop needs to be overwritten")
12128 def fresh(self, new_ctx):
12129 raise Z3Exception("fresh needs to be overwritten")
12133 raise Z3Exception("context already initialized")
12135 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12137 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12140 # Tell the solver to perform the next split on a given term
12141 # If the term is a bit-vector the index idx specifies the index of the Boolean variable being
12142 # split on. A phase of true = 1/false = -1/undef = 0 = let solver decide is the last argument.
12144 def next_split(self, t, idx, phase):
12145 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12148 # Propagation can only be invoked as during a fixed or final callback.
12150 def propagate(self, e, ids, eqs=[]):
12151 _ids, num_fixed = _to_ast_array(ids)
12153 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12154 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12155 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12156 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12158 def conflict(self, deps = [], eqs = []):
12159 self.propagate(BoolVal(False, self.ctx()), deps, eqs)
approx(self, precision=10)
__rtruediv__(self, other)
__deepcopy__(self, memo={})
__init__(self, m=None, ctx=None)
__deepcopy__(self, memo={})
__init__(self, ast, ctx=None)
__deepcopy__(self, memo={})
translate(self, other_ctx)
__init__(self, v=None, ctx=None)
__rtruediv__(self, other)
__deepcopy__(self, memo={})
set_ast_print_mode(self, mode)
__init__(self, *args, **kws)
__deepcopy__(self, memo={})
__init__(self, name, ctx=None)
declare(self, name, *args)
declare_core(self, name, rec_name, *args)
update_field(self, field_accessor, new_value)
__deepcopy__(self, memo={})
__init__(self, entry, ctx)
__deepcopy__(self, memo={})
translate(self, other_ctx)
__deepcopy__(self, memo={})
assert_exprs(self, *args)
dimacs(self, include_names=True)
simplify(self, *arguments, **keywords)
convert_model(self, model)
__init__(self, models=True, unsat_cores=False, proofs=False, ctx=None, goal=None)
__deepcopy__(self, memo={})
eval(self, t, model_completion=False)
project_with_witness(self, vars, fml)
update_value(self, x, value)
evaluate(self, t, model_completion=False)
__deepcopy__(self, memo={})
__init__(self, descr, ctx=None)
get_documentation(self, n)
__deepcopy__(self, memo={})
__init__(self, ctx=None, params=None)
denominator_as_long(self)
Strings, Sequences and Regular expressions.
__init__(self, solver=None, ctx=None, logFile=None)
assert_and_track(self, a, p)
import_model_converter(self, other)
assert_exprs(self, *args)
check(self, *assumptions)
__exit__(self, *exc_info)
__deepcopy__(self, memo={})
__init__(self, stats, ctx)
Z3_ast Z3_API Z3_model_get_const_interp(Z3_context c, Z3_model m, Z3_func_decl a)
Return the interpretation (i.e., assignment) of constant a in the model m. Return NULL,...
Z3_sort Z3_API Z3_mk_int_sort(Z3_context c)
Create the integer type.
Z3_sort Z3_API Z3_mk_array_sort_n(Z3_context c, unsigned n, Z3_sort const *domain, Z3_sort range)
Create an array type with N arguments.
bool Z3_API Z3_open_log(Z3_string filename)
Log interaction to a file.
Z3_parameter_kind Z3_API Z3_get_decl_parameter_kind(Z3_context c, Z3_func_decl d, unsigned idx)
Return the parameter type associated with a declaration.
Z3_ast Z3_API Z3_get_denominator(Z3_context c, Z3_ast a)
Return the denominator (as a numeral AST) of a numeral AST of sort Real.
Z3_probe Z3_API Z3_probe_not(Z3_context x, Z3_probe p)
Return a probe that evaluates to "true" when p does not evaluate to true.
Z3_decl_kind Z3_API Z3_get_decl_kind(Z3_context c, Z3_func_decl d)
Return declaration kind corresponding to declaration.
void Z3_API Z3_solver_assert_and_track(Z3_context c, Z3_solver s, Z3_ast a, Z3_ast p)
Assert a constraint a into the solver, and track it (in the unsat) core using the Boolean constant p.
Z3_ast Z3_API Z3_func_interp_get_else(Z3_context c, Z3_func_interp f)
Return the 'else' value of the given function interpretation.
Z3_ast Z3_API Z3_mk_bvsge(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed greater than or equal to.
void Z3_API Z3_ast_map_inc_ref(Z3_context c, Z3_ast_map m)
Increment the reference counter of the given AST map.
Z3_ast Z3_API Z3_mk_const_array(Z3_context c, Z3_sort domain, Z3_ast v)
Create the constant array.
Z3_ast Z3_API Z3_mk_bvsle(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed less than or equal to.
Z3_func_decl Z3_API Z3_get_app_decl(Z3_context c, Z3_app a)
Return the declaration of a constant or function application.
void Z3_API Z3_del_context(Z3_context c)
Delete the given logical context.
Z3_func_decl Z3_API Z3_get_decl_func_decl_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the expression value associated with an expression parameter.
Z3_ast Z3_API Z3_ast_map_find(Z3_context c, Z3_ast_map m, Z3_ast k)
Return the value associated with the key k.
Z3_string Z3_API Z3_ast_map_to_string(Z3_context c, Z3_ast_map m)
Convert the given map into a string.
Z3_string Z3_API Z3_param_descrs_to_string(Z3_context c, Z3_param_descrs p)
Convert a parameter description set into a string. This function is mainly used for printing the cont...
Z3_ast Z3_API Z3_mk_zero_ext(Z3_context c, unsigned i, Z3_ast t1)
Extend the given bit-vector with zeros to the (unsigned) equivalent bit-vector of size m+i,...
void Z3_API Z3_solver_set_params(Z3_context c, Z3_solver s, Z3_params p)
Set the given solver using the given parameters.
Z3_ast Z3_API Z3_mk_set_intersect(Z3_context c, unsigned num_args, Z3_ast const args[])
Take the intersection of a list of sets.
Z3_params Z3_API Z3_mk_params(Z3_context c)
Create a Z3 (empty) parameter set. Starting at Z3 4.0, parameter sets are used to configure many comp...
unsigned Z3_API Z3_get_decl_num_parameters(Z3_context c, Z3_func_decl d)
Return the number of parameters associated with a declaration.
Z3_ast Z3_API Z3_mk_set_subset(Z3_context c, Z3_ast arg1, Z3_ast arg2)
Check for subsetness of sets.
Z3_ast Z3_API Z3_mk_bvule(Z3_context c, Z3_ast t1, Z3_ast t2)
Unsigned less than or equal to.
Z3_ast Z3_API Z3_mk_full_set(Z3_context c, Z3_sort domain)
Create the full set.
Z3_param_kind Z3_API Z3_param_descrs_get_kind(Z3_context c, Z3_param_descrs p, Z3_symbol n)
Return the kind associated with the given parameter name n.
void Z3_API Z3_add_rec_def(Z3_context c, Z3_func_decl f, unsigned n, Z3_ast args[], Z3_ast body)
Define the body of a recursive function.
Z3_ast Z3_API Z3_mk_true(Z3_context c)
Create an AST node representing true.
Z3_ast Z3_API Z3_mk_set_union(Z3_context c, unsigned num_args, Z3_ast const args[])
Take the union of a list of sets.
Z3_func_interp Z3_API Z3_add_func_interp(Z3_context c, Z3_model m, Z3_func_decl f, Z3_ast default_value)
Create a fresh func_interp object, add it to a model for a specified function. It has reference count...
Z3_ast Z3_API Z3_mk_bvsdiv_no_overflow(Z3_context c, Z3_ast t1, Z3_ast t2)
Create a predicate that checks that the bit-wise signed division of t1 and t2 does not overflow.
unsigned Z3_API Z3_get_arity(Z3_context c, Z3_func_decl d)
Alias for Z3_get_domain_size.
void Z3_API Z3_ast_vector_set(Z3_context c, Z3_ast_vector v, unsigned i, Z3_ast a)
Update position i of the AST vector v with the AST a.
Z3_ast Z3_API Z3_mk_bvxor(Z3_context c, Z3_ast t1, Z3_ast t2)
Bitwise exclusive-or.
Z3_string Z3_API Z3_stats_to_string(Z3_context c, Z3_stats s)
Convert a statistics into a string.
Z3_sort Z3_API Z3_mk_real_sort(Z3_context c)
Create the real type.
Z3_ast Z3_API Z3_mk_le(Z3_context c, Z3_ast t1, Z3_ast t2)
Create less than or equal to.
bool Z3_API Z3_global_param_get(Z3_string param_id, Z3_string_ptr param_value)
Get a global (or module) parameter.
bool Z3_API Z3_goal_inconsistent(Z3_context c, Z3_goal g)
Return true if the given goal contains the formula false.
Z3_ast Z3_API Z3_mk_lambda_const(Z3_context c, unsigned num_bound, Z3_app const bound[], Z3_ast body)
Create a lambda expression using a list of constants that form the set of bound variables.
void Z3_API Z3_solver_dec_ref(Z3_context c, Z3_solver s)
Decrement the reference counter of the given solver.
Z3_ast Z3_API Z3_mk_bvslt(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed less than.
Z3_func_decl Z3_API Z3_model_get_func_decl(Z3_context c, Z3_model m, unsigned i)
Return the declaration of the i-th function in the given model.
bool Z3_API Z3_ast_map_contains(Z3_context c, Z3_ast_map m, Z3_ast k)
Return true if the map m contains the AST key k.
Z3_ast Z3_API Z3_mk_numeral(Z3_context c, Z3_string numeral, Z3_sort ty)
Create a numeral of a given sort.
unsigned Z3_API Z3_func_entry_get_num_args(Z3_context c, Z3_func_entry e)
Return the number of arguments in a Z3_func_entry object.
Z3_symbol Z3_API Z3_get_decl_symbol_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the double value associated with an double parameter.
Z3_symbol Z3_API Z3_get_quantifier_skolem_id(Z3_context c, Z3_ast a)
Obtain skolem id of quantifier.
Z3_ast Z3_API Z3_get_numerator(Z3_context c, Z3_ast a)
Return the numerator (as a numeral AST) of a numeral AST of sort Real.
Z3_ast Z3_API Z3_mk_unary_minus(Z3_context c, Z3_ast arg)
Create an AST node representing - arg.
Z3_ast Z3_API Z3_mk_and(Z3_context c, unsigned num_args, Z3_ast const args[])
Create an AST node representing args[0] and ... and args[num_args-1].
void Z3_API Z3_interrupt(Z3_context c)
Interrupt the execution of a Z3 procedure. This procedure can be used to interrupt: solvers,...
void Z3_API Z3_goal_assert(Z3_context c, Z3_goal g, Z3_ast a)
Add a new formula a to the given goal. The formula is split according to the following procedure that...
Z3_symbol Z3_API Z3_param_descrs_get_name(Z3_context c, Z3_param_descrs p, unsigned i)
Return the name of the parameter at given index i.
Z3_ast Z3_API Z3_func_entry_get_value(Z3_context c, Z3_func_entry e)
Return the value of this point.
bool Z3_API Z3_is_quantifier_exists(Z3_context c, Z3_ast a)
Determine if ast is an existential quantifier.
Z3_sort Z3_API Z3_mk_uninterpreted_sort(Z3_context c, Z3_symbol s)
Create a free (uninterpreted) type using the given name (symbol).
Z3_ast Z3_API Z3_mk_false(Z3_context c)
Create an AST node representing false.
Z3_ast_vector Z3_API Z3_ast_map_keys(Z3_context c, Z3_ast_map m)
Return the keys stored in the given map.
Z3_ast Z3_API Z3_mk_bvmul(Z3_context c, Z3_ast t1, Z3_ast t2)
Standard two's complement multiplication.
Z3_model Z3_API Z3_goal_convert_model(Z3_context c, Z3_goal g, Z3_model m)
Convert a model of the formulas of a goal to a model of an original goal. The model may be null,...
void Z3_API Z3_del_constructor(Z3_context c, Z3_constructor constr)
Reclaim memory allocated to constructor.
Z3_ast Z3_API Z3_mk_bvsgt(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed greater than.
Z3_string Z3_API Z3_ast_to_string(Z3_context c, Z3_ast a)
Convert the given AST node into a string.
Z3_context Z3_API Z3_mk_context_rc(Z3_config c)
Create a context using the given configuration. This function is similar to Z3_mk_context....
Z3_string Z3_API Z3_get_full_version(void)
Return a string that fully describes the version of Z3 in use.
void Z3_API Z3_enable_trace(Z3_string tag)
Enable tracing messages tagged as tag when Z3 is compiled in debug mode. It is a NOOP otherwise.
Z3_ast Z3_API Z3_mk_set_complement(Z3_context c, Z3_ast arg)
Take the complement of a set.
unsigned Z3_API Z3_get_quantifier_num_patterns(Z3_context c, Z3_ast a)
Return number of patterns used in quantifier.
Z3_symbol Z3_API Z3_get_quantifier_bound_name(Z3_context c, Z3_ast a, unsigned i)
Return symbol of the i'th bound variable.
bool Z3_API Z3_stats_is_uint(Z3_context c, Z3_stats s, unsigned idx)
Return true if the given statistical data is a unsigned integer.
unsigned Z3_API Z3_model_get_num_consts(Z3_context c, Z3_model m)
Return the number of constants assigned by the given model.
Z3_ast Z3_API Z3_mk_extract(Z3_context c, unsigned high, unsigned low, Z3_ast t1)
Extract the bits high down to low from a bit-vector of size m to yield a new bit-vector of size n,...
Z3_ast Z3_API Z3_mk_mod(Z3_context c, Z3_ast arg1, Z3_ast arg2)
Create an AST node representing arg1 mod arg2.
Z3_ast Z3_API Z3_mk_bvredand(Z3_context c, Z3_ast t1)
Take conjunction of bits in vector, return vector of length 1.
Z3_ast Z3_API Z3_mk_set_add(Z3_context c, Z3_ast set, Z3_ast elem)
Add an element to a set.
Z3_ast Z3_API Z3_mk_ge(Z3_context c, Z3_ast t1, Z3_ast t2)
Create greater than or equal to.
Z3_ast Z3_API Z3_mk_bvadd_no_underflow(Z3_context c, Z3_ast t1, Z3_ast t2)
Create a predicate that checks that the bit-wise signed addition of t1 and t2 does not underflow.
Z3_ast Z3_API Z3_mk_bvadd_no_overflow(Z3_context c, Z3_ast t1, Z3_ast t2, bool is_signed)
Create a predicate that checks that the bit-wise addition of t1 and t2 does not overflow.
void Z3_API Z3_set_ast_print_mode(Z3_context c, Z3_ast_print_mode mode)
Select mode for the format used for pretty-printing AST nodes.
Z3_ast Z3_API Z3_mk_array_default(Z3_context c, Z3_ast array)
Access the array default value. Produces the default range value, for arrays that can be represented ...
Z3_ast Z3_API Z3_datatype_update_field(Z3_context c, Z3_func_decl field_access, Z3_ast t, Z3_ast value)
Update record field with a value.
unsigned Z3_API Z3_model_get_num_sorts(Z3_context c, Z3_model m)
Return the number of uninterpreted sorts that m assigns an interpretation to.
Z3_ast_vector Z3_API Z3_ast_vector_translate(Z3_context s, Z3_ast_vector v, Z3_context t)
Translate the AST vector v from context s into an AST vector in context t.
void Z3_API Z3_func_entry_inc_ref(Z3_context c, Z3_func_entry e)
Increment the reference counter of the given Z3_func_entry object.
Z3_ast Z3_API Z3_mk_fresh_const(Z3_context c, Z3_string prefix, Z3_sort ty)
Declare and create a fresh constant.
Z3_ast Z3_API Z3_mk_bvsub_no_overflow(Z3_context c, Z3_ast t1, Z3_ast t2)
Create a predicate that checks that the bit-wise signed subtraction of t1 and t2 does not overflow.
void Z3_API Z3_solver_push(Z3_context c, Z3_solver s)
Create a backtracking point.
Z3_ast Z3_API Z3_mk_bvsub_no_underflow(Z3_context c, Z3_ast t1, Z3_ast t2, bool is_signed)
Create a predicate that checks that the bit-wise subtraction of t1 and t2 does not underflow.
Z3_goal Z3_API Z3_goal_translate(Z3_context source, Z3_goal g, Z3_context target)
Copy a goal g from the context source to the context target.
Z3_ast Z3_API Z3_mk_bvudiv(Z3_context c, Z3_ast t1, Z3_ast t2)
Unsigned division.
Z3_string Z3_API Z3_ast_vector_to_string(Z3_context c, Z3_ast_vector v)
Convert AST vector into a string.
Z3_ast Z3_API Z3_mk_bvshl(Z3_context c, Z3_ast t1, Z3_ast t2)
Shift left.
bool Z3_API Z3_is_numeral_ast(Z3_context c, Z3_ast a)
Z3_ast Z3_API Z3_mk_bvsrem(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed remainder (sign follows dividend).
bool Z3_API Z3_is_as_array(Z3_context c, Z3_ast a)
The (_ as-array f) AST node is a construct for assigning interpretations for arrays in Z3....
Z3_func_decl Z3_API Z3_mk_func_decl(Z3_context c, Z3_symbol s, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
Declare a constant or function.
Z3_ast Z3_API Z3_mk_is_int(Z3_context c, Z3_ast t1)
Check if a real number is an integer.
void Z3_API Z3_params_set_bool(Z3_context c, Z3_params p, Z3_symbol k, bool v)
Add a Boolean parameter k with value v to the parameter set p.
Z3_ast Z3_API Z3_mk_ite(Z3_context c, Z3_ast t1, Z3_ast t2, Z3_ast t3)
Create an AST node representing an if-then-else: ite(t1, t2, t3).
Z3_ast Z3_API Z3_mk_select(Z3_context c, Z3_ast a, Z3_ast i)
Array read. The argument a is the array and i is the index of the array that gets read.
Z3_ast Z3_API Z3_mk_sign_ext(Z3_context c, unsigned i, Z3_ast t1)
Sign-extend of the given bit-vector to the (signed) equivalent bit-vector of size m+i,...
unsigned Z3_API Z3_goal_size(Z3_context c, Z3_goal g)
Return the number of formulas in the given goal.
void Z3_API Z3_stats_inc_ref(Z3_context c, Z3_stats s)
Increment the reference counter of the given statistics object.
Z3_ast Z3_API Z3_mk_select_n(Z3_context c, Z3_ast a, unsigned n, Z3_ast const *idxs)
n-ary Array read. The argument a is the array and idxs are the indices of the array that gets read.
Z3_ast_vector Z3_API Z3_algebraic_get_poly(Z3_context c, Z3_ast a)
Return the coefficients of the defining polynomial.
Z3_ast Z3_API Z3_mk_div(Z3_context c, Z3_ast arg1, Z3_ast arg2)
Create an AST node representing arg1 div arg2.
void Z3_API Z3_model_dec_ref(Z3_context c, Z3_model m)
Decrement the reference counter of the given model.
Z3_sort Z3_API Z3_mk_datatype_sort(Z3_context c, Z3_symbol name, unsigned num_params, Z3_sort const params[])
create a forward reference to a recursive datatype being declared. The forward reference can be used ...
void Z3_API Z3_func_interp_inc_ref(Z3_context c, Z3_func_interp f)
Increment the reference counter of the given Z3_func_interp object.
void Z3_API Z3_params_set_double(Z3_context c, Z3_params p, Z3_symbol k, double v)
Add a double parameter k with value v to the parameter set p.
Z3_string Z3_API Z3_param_descrs_get_documentation(Z3_context c, Z3_param_descrs p, Z3_symbol s)
Retrieve documentation string corresponding to parameter name s.
Z3_solver Z3_API Z3_mk_solver(Z3_context c)
Create a new solver. This solver is a "combined solver" (see combined_solver module) that internally ...
Z3_model Z3_API Z3_solver_get_model(Z3_context c, Z3_solver s)
Retrieve the model for the last Z3_solver_check or Z3_solver_check_assumptions.
int Z3_API Z3_get_symbol_int(Z3_context c, Z3_symbol s)
Return the symbol int value.
Z3_func_decl Z3_API Z3_get_as_array_func_decl(Z3_context c, Z3_ast a)
Return the function declaration f associated with a (_ as_array f) node.
Z3_ast Z3_API Z3_mk_ext_rotate_left(Z3_context c, Z3_ast t1, Z3_ast t2)
Rotate bits of t1 to the left t2 times.
void Z3_API Z3_goal_inc_ref(Z3_context c, Z3_goal g)
Increment the reference counter of the given goal.
Z3_ast Z3_API Z3_mk_implies(Z3_context c, Z3_ast t1, Z3_ast t2)
Create an AST node representing t1 implies t2.
unsigned Z3_API Z3_get_datatype_sort_num_constructors(Z3_context c, Z3_sort t)
Return number of constructors for datatype.
void Z3_API Z3_params_set_uint(Z3_context c, Z3_params p, Z3_symbol k, unsigned v)
Add a unsigned parameter k with value v to the parameter set p.
Z3_lbool Z3_API Z3_solver_check_assumptions(Z3_context c, Z3_solver s, unsigned num_assumptions, Z3_ast const assumptions[])
Check whether the assertions in the given solver and optional assumptions are consistent or not.
Z3_sort Z3_API Z3_model_get_sort(Z3_context c, Z3_model m, unsigned i)
Return a uninterpreted sort that m assigns an interpretation.
Z3_ast Z3_API Z3_mk_bvashr(Z3_context c, Z3_ast t1, Z3_ast t2)
Arithmetic shift right.
Z3_ast Z3_API Z3_mk_bv2int(Z3_context c, Z3_ast t1, bool is_signed)
Create an integer from the bit-vector argument t1. If is_signed is false, then the bit-vector t1 is t...
Z3_sort Z3_API Z3_get_array_sort_domain_n(Z3_context c, Z3_sort t, unsigned idx)
Return the i'th domain sort of an n-dimensional array.
Z3_ast Z3_API Z3_mk_set_del(Z3_context c, Z3_ast set, Z3_ast elem)
Remove an element to a set.
Z3_ast Z3_API Z3_mk_bvmul_no_overflow(Z3_context c, Z3_ast t1, Z3_ast t2, bool is_signed)
Create a predicate that checks that the bit-wise multiplication of t1 and t2 does not overflow.
Z3_ast Z3_API Z3_mk_bvor(Z3_context c, Z3_ast t1, Z3_ast t2)
Bitwise or.
int Z3_API Z3_get_decl_int_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the integer value associated with an integer parameter.
unsigned Z3_API Z3_get_quantifier_num_no_patterns(Z3_context c, Z3_ast a)
Return number of no_patterns used in quantifier.
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th constructor.
void Z3_API Z3_ast_vector_resize(Z3_context c, Z3_ast_vector v, unsigned n)
Resize the AST vector v.
Z3_ast Z3_API Z3_mk_quantifier_const_ex(Z3_context c, bool is_forall, unsigned weight, Z3_symbol quantifier_id, Z3_symbol skolem_id, unsigned num_bound, Z3_app const bound[], unsigned num_patterns, Z3_pattern const patterns[], unsigned num_no_patterns, Z3_ast const no_patterns[], Z3_ast body)
Create a universal or existential quantifier using a list of constants that will form the set of boun...
Z3_pattern Z3_API Z3_mk_pattern(Z3_context c, unsigned num_patterns, Z3_ast const terms[])
Create a pattern for quantifier instantiation.
Z3_symbol_kind Z3_API Z3_get_symbol_kind(Z3_context c, Z3_symbol s)
Return Z3_INT_SYMBOL if the symbol was constructed using Z3_mk_int_symbol, and Z3_STRING_SYMBOL if th...
bool Z3_API Z3_is_lambda(Z3_context c, Z3_ast a)
Determine if ast is a lambda expression.
unsigned Z3_API Z3_stats_get_uint_value(Z3_context c, Z3_stats s, unsigned idx)
Return the unsigned value of the given statistical data.
Z3_sort Z3_API Z3_get_array_sort_domain(Z3_context c, Z3_sort t)
Return the domain of the given array sort. In the case of a multi-dimensional array,...
Z3_ast Z3_API Z3_mk_bvmul_no_underflow(Z3_context c, Z3_ast t1, Z3_ast t2)
Create a predicate that checks that the bit-wise signed multiplication of t1 and t2 does not underflo...
Z3_ast Z3_API Z3_func_decl_to_ast(Z3_context c, Z3_func_decl f)
Convert a Z3_func_decl into Z3_ast. This is just type casting.
void Z3_API Z3_add_const_interp(Z3_context c, Z3_model m, Z3_func_decl f, Z3_ast a)
Add a constant interpretation.
Z3_ast Z3_API Z3_mk_bvadd(Z3_context c, Z3_ast t1, Z3_ast t2)
Standard two's complement addition.
unsigned Z3_API Z3_algebraic_get_i(Z3_context c, Z3_ast a)
Return which root of the polynomial the algebraic number represents.
void Z3_API Z3_params_dec_ref(Z3_context c, Z3_params p)
Decrement the reference counter of the given parameter set.
Z3_ast Z3_API Z3_get_app_arg(Z3_context c, Z3_app a, unsigned i)
Return the i-th argument of the given application.
Z3_string Z3_API Z3_model_to_string(Z3_context c, Z3_model m)
Convert the given model into a string.
Z3_func_decl Z3_API Z3_mk_fresh_func_decl(Z3_context c, Z3_string prefix, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
Declare a fresh constant or function.
unsigned Z3_API Z3_ast_map_size(Z3_context c, Z3_ast_map m)
Return the size of the given map.
unsigned Z3_API Z3_param_descrs_size(Z3_context c, Z3_param_descrs p)
Return the number of parameters in the given parameter description set.
Z3_string Z3_API Z3_goal_to_dimacs_string(Z3_context c, Z3_goal g, bool include_names)
Convert a goal into a DIMACS formatted string. The goal must be in CNF. You can convert a goal to CNF...
Z3_ast Z3_API Z3_mk_lt(Z3_context c, Z3_ast t1, Z3_ast t2)
Create less than.
Z3_ast Z3_API Z3_get_quantifier_no_pattern_ast(Z3_context c, Z3_ast a, unsigned i)
Return i'th no_pattern.
double Z3_API Z3_stats_get_double_value(Z3_context c, Z3_stats s, unsigned idx)
Return the double value of the given statistical data.
Z3_ast Z3_API Z3_mk_bvugt(Z3_context c, Z3_ast t1, Z3_ast t2)
Unsigned greater than.
unsigned Z3_API Z3_goal_depth(Z3_context c, Z3_goal g)
Return the depth of the given goal. It tracks how many transformations were applied to it.
Z3_ast Z3_API Z3_update_term(Z3_context c, Z3_ast a, unsigned num_args, Z3_ast const args[])
Update the arguments of term a using the arguments args. The number of arguments num_args should coin...
Z3_string Z3_API Z3_get_symbol_string(Z3_context c, Z3_symbol s)
Return the symbol name.
Z3_ast Z3_API Z3_pattern_to_ast(Z3_context c, Z3_pattern p)
Convert a Z3_pattern into Z3_ast. This is just type casting.
Z3_ast Z3_API Z3_mk_bvnot(Z3_context c, Z3_ast t1)
Bitwise negation.
Z3_ast Z3_API Z3_mk_bvurem(Z3_context c, Z3_ast t1, Z3_ast t2)
Unsigned remainder.
void Z3_API Z3_mk_datatypes(Z3_context c, unsigned num_sorts, Z3_symbol const sort_names[], Z3_sort sorts[], Z3_constructor_list constructor_lists[])
Create mutually recursive datatypes.
unsigned Z3_API Z3_func_interp_get_arity(Z3_context c, Z3_func_interp f)
Return the arity (number of arguments) of the given function interpretation.
Z3_ast Z3_API Z3_mk_bvsub(Z3_context c, Z3_ast t1, Z3_ast t2)
Standard two's complement subtraction.
Z3_ast Z3_API Z3_get_algebraic_number_upper(Z3_context c, Z3_ast a, unsigned precision)
Return a upper bound for the given real algebraic number. The interval isolating the number is smalle...
Z3_ast Z3_API Z3_mk_power(Z3_context c, Z3_ast arg1, Z3_ast arg2)
Create an AST node representing arg1 ^ arg2.
Z3_ast Z3_API Z3_mk_seq_concat(Z3_context c, unsigned n, Z3_ast const args[])
Concatenate sequences.
Z3_sort Z3_API Z3_mk_enumeration_sort(Z3_context c, Z3_symbol name, unsigned n, Z3_symbol const enum_names[], Z3_func_decl enum_consts[], Z3_func_decl enum_testers[])
Create a enumeration sort.
unsigned Z3_API Z3_get_bv_sort_size(Z3_context c, Z3_sort t)
Return the size of the given bit-vector sort.
Z3_ast Z3_API Z3_mk_set_member(Z3_context c, Z3_ast elem, Z3_ast set)
Check for set membership.
void Z3_API Z3_ast_vector_dec_ref(Z3_context c, Z3_ast_vector v)
Decrement the reference counter of the given AST vector.
void Z3_API Z3_func_interp_dec_ref(Z3_context c, Z3_func_interp f)
Decrement the reference counter of the given Z3_func_interp object.
void Z3_API Z3_params_inc_ref(Z3_context c, Z3_params p)
Increment the reference counter of the given parameter set.
void Z3_API Z3_set_error_handler(Z3_context c, Z3_error_handler h)
Register a Z3 error handler.
Z3_ast Z3_API Z3_mk_distinct(Z3_context c, unsigned num_args, Z3_ast const args[])
Create an AST node representing distinct(args[0], ..., args[num_args-1]).
Z3_config Z3_API Z3_mk_config(void)
Create a configuration object for the Z3 context object.
void Z3_API Z3_set_param_value(Z3_config c, Z3_string param_id, Z3_string param_value)
Set a configuration parameter.
Z3_sort Z3_API Z3_mk_bv_sort(Z3_context c, unsigned sz)
Create a bit-vector type of the given size.
Z3_ast Z3_API Z3_mk_bvult(Z3_context c, Z3_ast t1, Z3_ast t2)
Unsigned less than.
void Z3_API Z3_ast_map_dec_ref(Z3_context c, Z3_ast_map m)
Decrement the reference counter of the given AST map.
Z3_string Z3_API Z3_params_to_string(Z3_context c, Z3_params p)
Convert a parameter set into a string. This function is mainly used for printing the contents of a pa...
Z3_param_descrs Z3_API Z3_get_global_param_descrs(Z3_context c)
Retrieve description of global parameters.
Z3_func_decl Z3_API Z3_model_get_const_decl(Z3_context c, Z3_model m, unsigned i)
Return the i-th constant in the given model.
Z3_ast Z3_API Z3_translate(Z3_context source, Z3_ast a, Z3_context target)
Translate/Copy the AST a from context source to context target. AST a must have been created using co...
Z3_sort Z3_API Z3_get_range(Z3_context c, Z3_func_decl d)
Return the range of the given declaration.
void Z3_API Z3_global_param_set(Z3_string param_id, Z3_string param_value)
Set a global (or module) parameter. This setting is shared by all Z3 contexts.
Z3_ast_vector Z3_API Z3_model_get_sort_universe(Z3_context c, Z3_model m, Z3_sort s)
Return the finite set of distinct values that represent the interpretation for sort s.
void Z3_API Z3_func_entry_dec_ref(Z3_context c, Z3_func_entry e)
Decrement the reference counter of the given Z3_func_entry object.
unsigned Z3_API Z3_stats_size(Z3_context c, Z3_stats s)
Return the number of statistical data in s.
void Z3_API Z3_append_log(Z3_string string)
Append user-defined string to interaction log.
Z3_ast Z3_API Z3_get_quantifier_body(Z3_context c, Z3_ast a)
Return body of quantifier.
void Z3_API Z3_param_descrs_dec_ref(Z3_context c, Z3_param_descrs p)
Decrement the reference counter of the given parameter description set.
Z3_model Z3_API Z3_mk_model(Z3_context c)
Create a fresh model object. It has reference count 0.
Z3_symbol Z3_API Z3_get_decl_name(Z3_context c, Z3_func_decl d)
Return the constant declaration name as a symbol.
Z3_ast Z3_API Z3_mk_bvneg_no_overflow(Z3_context c, Z3_ast t1)
Check that bit-wise negation does not overflow when t1 is interpreted as a signed bit-vector.
Z3_string Z3_API Z3_stats_get_key(Z3_context c, Z3_stats s, unsigned idx)
Return the key (a string) for a particular statistical data.
Z3_ast Z3_API Z3_mk_bvand(Z3_context c, Z3_ast t1, Z3_ast t2)
Bitwise and.
Z3_ast_kind Z3_API Z3_get_ast_kind(Z3_context c, Z3_ast a)
Return the kind of the given AST.
Z3_ast Z3_API Z3_mk_bvsmod(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed remainder (sign follows divisor).
Z3_model Z3_API Z3_model_translate(Z3_context c, Z3_model m, Z3_context dst)
translate model from context c to context dst.
void Z3_API Z3_get_version(unsigned *major, unsigned *minor, unsigned *build_number, unsigned *revision_number)
Return Z3 version number information.
Z3_ast Z3_API Z3_mk_int2bv(Z3_context c, unsigned n, Z3_ast t1)
Create an n bit bit-vector from the integer argument t1.
void Z3_API Z3_solver_assert(Z3_context c, Z3_solver s, Z3_ast a)
Assert a constraint into the solver.
unsigned Z3_API Z3_ast_vector_size(Z3_context c, Z3_ast_vector v)
Return the size of the given AST vector.
unsigned Z3_API Z3_get_quantifier_weight(Z3_context c, Z3_ast a)
Obtain weight of quantifier.
bool Z3_API Z3_model_eval(Z3_context c, Z3_model m, Z3_ast t, bool model_completion, Z3_ast *v)
Evaluate the AST node t in the given model. Return true if succeeded, and store the result in v.
unsigned Z3_API Z3_solver_get_num_scopes(Z3_context c, Z3_solver s)
Return the number of backtracking points.
Z3_sort Z3_API Z3_get_array_sort_range(Z3_context c, Z3_sort t)
Return the range of the given array sort.
void Z3_API Z3_del_constructor_list(Z3_context c, Z3_constructor_list clist)
Reclaim memory allocated for constructor list.
Z3_ast Z3_API Z3_mk_bound(Z3_context c, unsigned index, Z3_sort ty)
Create a variable.
unsigned Z3_API Z3_get_app_num_args(Z3_context c, Z3_app a)
Return the number of argument of an application. If t is an constant, then the number of arguments is...
Z3_ast Z3_API Z3_func_entry_get_arg(Z3_context c, Z3_func_entry e, unsigned i)
Return an argument of a Z3_func_entry object.
Z3_ast Z3_API Z3_mk_eq(Z3_context c, Z3_ast l, Z3_ast r)
Create an AST node representing l = r.
void Z3_API Z3_ast_vector_inc_ref(Z3_context c, Z3_ast_vector v)
Increment the reference counter of the given AST vector.
unsigned Z3_API Z3_model_get_num_funcs(Z3_context c, Z3_model m)
Return the number of function interpretations in the given model.
void Z3_API Z3_dec_ref(Z3_context c, Z3_ast a)
Decrement the reference counter of the given AST. The context c should have been created using Z3_mk_...
Z3_ast_vector Z3_API Z3_mk_ast_vector(Z3_context c)
Return an empty AST vector.
Z3_ast Z3_API Z3_mk_empty_set(Z3_context c, Z3_sort domain)
Create the empty set.
Z3_ast Z3_API Z3_mk_repeat(Z3_context c, unsigned i, Z3_ast t1)
Repeat the given bit-vector up length i.
Z3_goal_prec Z3_API Z3_goal_precision(Z3_context c, Z3_goal g)
Return the "precision" of the given goal. Goals can be transformed using over and under approximation...
void Z3_API Z3_solver_pop(Z3_context c, Z3_solver s, unsigned n)
Backtrack n backtracking points.
void Z3_API Z3_ast_map_erase(Z3_context c, Z3_ast_map m, Z3_ast k)
Erase a key from the map.
Z3_ast Z3_API Z3_mk_int2real(Z3_context c, Z3_ast t1)
Coerce an integer to a real.
unsigned Z3_API Z3_get_index_value(Z3_context c, Z3_ast a)
Return index of de-Bruijn bound variable.
Z3_goal Z3_API Z3_mk_goal(Z3_context c, bool models, bool unsat_cores, bool proofs)
Create a goal (aka problem). A goal is essentially a set of formulas, that can be solved and/or trans...
double Z3_API Z3_get_decl_double_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the double value associated with an double parameter.
unsigned Z3_API Z3_get_ast_hash(Z3_context c, Z3_ast a)
Return a hash code for the given AST. The hash code is structural but two different AST objects can m...
Z3_symbol Z3_API Z3_get_sort_name(Z3_context c, Z3_sort d)
Return the sort name as a symbol.
void Z3_API Z3_params_validate(Z3_context c, Z3_params p, Z3_param_descrs d)
Validate the parameter set p against the parameter description set d.
Z3_func_decl Z3_API Z3_get_datatype_sort_recognizer(Z3_context c, Z3_sort t, unsigned idx)
Return idx'th recognizer.
void Z3_API Z3_global_param_reset_all(void)
Restore the value of all global (and module) parameters. This command will not affect already created...
Z3_ast Z3_API Z3_mk_gt(Z3_context c, Z3_ast t1, Z3_ast t2)
Create greater than.
Z3_ast Z3_API Z3_mk_store(Z3_context c, Z3_ast a, Z3_ast i, Z3_ast v)
Array update.
Z3_string Z3_API Z3_get_decl_rational_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the rational value, as a string, associated with a rational parameter.
void Z3_API Z3_ast_vector_push(Z3_context c, Z3_ast_vector v, Z3_ast a)
Add the AST a in the end of the AST vector v. The size of v is increased by one.
bool Z3_API Z3_is_eq_ast(Z3_context c, Z3_ast t1, Z3_ast t2)
Compare terms.
bool Z3_API Z3_is_quantifier_forall(Z3_context c, Z3_ast a)
Determine if an ast is a universal quantifier.
Z3_ast_map Z3_API Z3_mk_ast_map(Z3_context c)
Return an empty mapping from AST to AST.
Z3_ast Z3_API Z3_mk_xor(Z3_context c, Z3_ast t1, Z3_ast t2)
Create an AST node representing t1 xor t2.
Z3_ast Z3_API Z3_mk_map(Z3_context c, Z3_func_decl f, unsigned n, Z3_ast const *args)
Map f on the argument arrays.
Z3_ast Z3_API Z3_mk_const(Z3_context c, Z3_symbol s, Z3_sort ty)
Declare and create a constant.
Z3_symbol Z3_API Z3_mk_string_symbol(Z3_context c, Z3_string s)
Create a Z3 symbol using a C string.
void Z3_API Z3_param_descrs_inc_ref(Z3_context c, Z3_param_descrs p)
Increment the reference counter of the given parameter description set.
void Z3_API Z3_stats_dec_ref(Z3_context c, Z3_stats s)
Decrement the reference counter of the given statistics object.
Z3_ast Z3_API Z3_mk_array_ext(Z3_context c, Z3_ast arg1, Z3_ast arg2)
Create array extensionality index given two arrays with the same sort. The meaning is given by the ax...
Z3_ast Z3_API Z3_mk_re_concat(Z3_context c, unsigned n, Z3_ast const args[])
Create the concatenation of the regular languages.
Z3_ast Z3_API Z3_sort_to_ast(Z3_context c, Z3_sort s)
Convert a Z3_sort into Z3_ast. This is just type casting.
Z3_func_entry Z3_API Z3_func_interp_get_entry(Z3_context c, Z3_func_interp f, unsigned i)
Return a "point" of the given function interpretation. It represents the value of f in a particular p...
Z3_func_decl Z3_API Z3_mk_rec_func_decl(Z3_context c, Z3_symbol s, unsigned domain_size, Z3_sort const domain[], Z3_sort range)
Declare a recursive function.
unsigned Z3_API Z3_get_ast_id(Z3_context c, Z3_ast t)
Return a unique identifier for t. The identifier is unique up to structural equality....
Z3_ast Z3_API Z3_mk_concat(Z3_context c, Z3_ast t1, Z3_ast t2)
Concatenate the given bit-vectors.
unsigned Z3_API Z3_get_quantifier_num_bound(Z3_context c, Z3_ast a)
Return number of bound variables of quantifier.
Z3_sort Z3_API Z3_get_decl_sort_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the sort value associated with a sort parameter.
Z3_constructor_list Z3_API Z3_mk_constructor_list(Z3_context c, unsigned num_constructors, Z3_constructor const constructors[])
Create list of constructors.
Z3_ast Z3_API Z3_mk_app(Z3_context c, Z3_func_decl d, unsigned num_args, Z3_ast const args[])
Create a constant or function application.
Z3_sort_kind Z3_API Z3_get_sort_kind(Z3_context c, Z3_sort t)
Return the sort kind (e.g., array, tuple, int, bool, etc).
Z3_ast Z3_API Z3_mk_bvneg(Z3_context c, Z3_ast t1)
Standard two's complement unary minus.
Z3_ast Z3_API Z3_mk_store_n(Z3_context c, Z3_ast a, unsigned n, Z3_ast const *idxs, Z3_ast v)
n-ary Array update.
Z3_sort Z3_API Z3_get_domain(Z3_context c, Z3_func_decl d, unsigned i)
Return the sort of the i-th parameter of the given function declaration.
Z3_sort Z3_API Z3_mk_bool_sort(Z3_context c)
Create the Boolean type.
void Z3_API Z3_params_set_symbol(Z3_context c, Z3_params p, Z3_symbol k, Z3_symbol v)
Add a symbol parameter k with value v to the parameter set p.
Z3_ast Z3_API Z3_ast_vector_get(Z3_context c, Z3_ast_vector v, unsigned i)
Return the AST at position i in the AST vector v.
Z3_func_decl Z3_API Z3_to_func_decl(Z3_context c, Z3_ast a)
Convert an AST into a FUNC_DECL_AST. This is just type casting.
Z3_ast Z3_API Z3_mk_set_difference(Z3_context c, Z3_ast arg1, Z3_ast arg2)
Take the set difference between two sets.
Z3_ast Z3_API Z3_mk_bvsdiv(Z3_context c, Z3_ast t1, Z3_ast t2)
Two's complement signed division.
Z3_ast Z3_API Z3_mk_bvlshr(Z3_context c, Z3_ast t1, Z3_ast t2)
Logical shift right.
Z3_ast Z3_API Z3_get_decl_ast_parameter(Z3_context c, Z3_func_decl d, unsigned idx)
Return the expression value associated with an expression parameter.
Z3_pattern Z3_API Z3_get_quantifier_pattern_ast(Z3_context c, Z3_ast a, unsigned i)
Return i'th pattern.
void Z3_API Z3_goal_dec_ref(Z3_context c, Z3_goal g)
Decrement the reference counter of the given goal.
Z3_ast Z3_API Z3_mk_not(Z3_context c, Z3_ast a)
Create an AST node representing not(a).
Z3_ast Z3_API Z3_mk_or(Z3_context c, unsigned num_args, Z3_ast const args[])
Create an AST node representing args[0] or ... or args[num_args-1].
Z3_sort Z3_API Z3_mk_array_sort(Z3_context c, Z3_sort domain, Z3_sort range)
Create an array type.
void Z3_API Z3_model_inc_ref(Z3_context c, Z3_model m)
Increment the reference counter of the given model.
Z3_ast Z3_API Z3_mk_seq_extract(Z3_context c, Z3_ast s, Z3_ast offset, Z3_ast length)
Extract subsequence starting at offset of length.
Z3_sort Z3_API Z3_mk_type_variable(Z3_context c, Z3_symbol s)
Create a type variable.
Z3_string Z3_API Z3_get_numeral_string(Z3_context c, Z3_ast a)
Return numeral value, as a decimal string of a numeric constant term.
void Z3_API Z3_func_interp_add_entry(Z3_context c, Z3_func_interp fi, Z3_ast_vector args, Z3_ast value)
add a function entry to a function interpretation.
Z3_ast Z3_API Z3_mk_bvuge(Z3_context c, Z3_ast t1, Z3_ast t2)
Unsigned greater than or equal to.
Z3_string Z3_API Z3_get_numeral_binary_string(Z3_context c, Z3_ast a)
Return numeral value, as a binary string of a numeric constant term.
Z3_sort Z3_API Z3_get_quantifier_bound_sort(Z3_context c, Z3_ast a, unsigned i)
Return sort of the i'th bound variable.
void Z3_API Z3_disable_trace(Z3_string tag)
Disable tracing messages tagged as tag when Z3 is compiled in debug mode. It is a NOOP otherwise.
Z3_ast Z3_API Z3_goal_formula(Z3_context c, Z3_goal g, unsigned idx)
Return a formula from the given goal.
Z3_symbol Z3_API Z3_mk_int_symbol(Z3_context c, int i)
Create a Z3 symbol using an integer.
unsigned Z3_API Z3_func_interp_get_num_entries(Z3_context c, Z3_func_interp f)
Return the number of entries in the given function interpretation.
void Z3_API Z3_ast_map_insert(Z3_context c, Z3_ast_map m, Z3_ast k, Z3_ast v)
Store/Replace a new key, value pair in the given map.
Z3_constructor Z3_API Z3_mk_constructor(Z3_context c, Z3_symbol name, Z3_symbol recognizer, unsigned num_fields, Z3_symbol const field_names[], Z3_sort const sorts[], unsigned sort_refs[])
Create a constructor.
Z3_string Z3_API Z3_goal_to_string(Z3_context c, Z3_goal g)
Convert a goal into a string.
bool Z3_API Z3_is_eq_sort(Z3_context c, Z3_sort s1, Z3_sort s2)
compare sorts.
void Z3_API Z3_del_config(Z3_config c)
Delete the given configuration object.
double Z3_API Z3_get_numeral_double(Z3_context c, Z3_ast a)
Return numeral as a double.
void Z3_API Z3_inc_ref(Z3_context c, Z3_ast a)
Increment the reference counter of the given AST. The context c should have been created using Z3_mk_...
Z3_ast Z3_API Z3_mk_real2int(Z3_context c, Z3_ast t1)
Coerce a real to an integer.
Z3_func_interp Z3_API Z3_model_get_func_interp(Z3_context c, Z3_model m, Z3_func_decl f)
Return the interpretation of the function f in the model m. Return NULL, if the model does not assign...
void Z3_API Z3_solver_inc_ref(Z3_context c, Z3_solver s)
Increment the reference counter of the given solver.
Z3_symbol Z3_API Z3_get_quantifier_id(Z3_context c, Z3_ast a)
Obtain id of quantifier.
Z3_ast Z3_API Z3_mk_ext_rotate_right(Z3_context c, Z3_ast t1, Z3_ast t2)
Rotate bits of t1 to the right t2 times.
Z3_string Z3_API Z3_get_numeral_decimal_string(Z3_context c, Z3_ast a, unsigned precision)
Return numeral as a string in decimal notation. The result has at most precision decimal places.
Z3_sort Z3_API Z3_get_sort(Z3_context c, Z3_ast a)
Return the sort of an AST node.
Z3_func_decl Z3_API Z3_get_datatype_sort_constructor_accessor(Z3_context c, Z3_sort t, unsigned idx_c, unsigned idx_a)
Return idx_a'th accessor for the idx_c'th constructor.
Z3_ast Z3_API Z3_mk_bvredor(Z3_context c, Z3_ast t1)
Take disjunction of bits in vector, return vector of length 1.
void Z3_API Z3_ast_map_reset(Z3_context c, Z3_ast_map m)
Remove all keys from the given map.
void Z3_API Z3_solver_reset(Z3_context c, Z3_solver s)
Remove all assertions from the solver.
bool Z3_API Z3_is_algebraic_number(Z3_context c, Z3_ast a)
Return true if the given AST is a real algebraic number.
BitVecVal(val, bv, ctx=None)
_coerce_exprs(a, b, ctx=None)
_ctx_from_ast_args(*args)
_to_func_decl_ref(a, ctx)
_valid_accessor(acc)
Datatypes.
BitVec(name, bv, ctx=None)
RecAddDefinition(f, args, body)
DeclareTypeVar(name, ctx=None)
_z3_check_cint_overflow(n, name)
TupleSort(name, sorts, ctx=None)
_coerce_expr_list(alist, ctx=None)
RealVector(prefix, sz, ctx=None)
SortRef _sort(Context ctx, Any a)
ExprRef RealVar(int idx, ctx=None)
bool is_arith_sort(Any s)
BitVecs(names, bv, ctx=None)
_check_same_sort(a, b, ctx=None)
BoolVector(prefix, sz, ctx=None)
FreshConst(sort, prefix="c")
EnumSort(name, values, ctx=None)
simplify(a, *arguments, **keywords)
Utils.
BV2Int(a, is_signed=False)
FreshInt(prefix="x", ctx=None)
_to_func_decl_array(args)
args2params(arguments, keywords, ctx=None)
Cond(p, t1, t2, ctx=None)
RealVarVector(int n, ctx=None)
bool eq(AstRef a, AstRef b)
FreshReal(prefix="b", ctx=None)
_reduce(func, sequence, initial)
ExprRef Var(int idx, SortRef s)
BVAddNoOverflow(a, b, signed)
FreshBool(prefix="b", ctx=None)
_ctx_from_ast_arg_list(args, default_ctx=None)
IntVector(prefix, sz, ctx=None)
DisjointSum(name, sorts, ctx=None)
Exists(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[])
ForAll(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[])
int _ast_kind(Context ctx, Any a)
DatatypeSort(name, params=None, ctx=None)
BVSubNoUnderflow(a, b, signed)
SortRef DeclareSort(name, ctx=None)
BVMulNoOverflow(a, b, signed)
_mk_quantifier(is_forall, vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[])