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')
2809 """Return `True` if `a` is an arithmetical expression.
2818 >>> is_arith(IntVal(1))
2826 return isinstance(a, ArithRef)
2830 """Return `True` if `a` is an integer expression.
2837 >>> is_int(IntVal(1))
2849 """Return `True` if `a` is a real expression.
2861 >>> is_real(RealVal(1))
2876 """Return `True` if `a` is an integer value of sort Int.
2878 >>> is_int_value(IntVal(1))
2882 >>> is_int_value(Int('x'))
2884 >>> n = Int('x') + 1
2889 >>> is_int_value(n.arg(1))
2891 >>> is_int_value(RealVal("1/3"))
2893 >>> is_int_value(RealVal(1))
2900 """Return `True` if `a` is rational value of sort Real.
2902 >>> is_rational_value(RealVal(1))
2904 >>> is_rational_value(RealVal("3/5"))
2906 >>> is_rational_value(IntVal(1))
2908 >>> is_rational_value(1)
2910 >>> n = Real('x') + 1
2913 >>> is_rational_value(n.arg(1))
2915 >>> is_rational_value(Real('x'))
2922 """Return `True` if `a` is an algebraic value of sort Real.
2924 >>> is_algebraic_value(RealVal("3/5"))
2926 >>> n = simplify(Sqrt(2))
2929 >>> is_algebraic_value(n)
2936 """Return `True` if `a` is an expression of the form b + c.
2938 >>> x, y = Ints('x y')
2948 """Return `True` if `a` is an expression of the form b * c.
2950 >>> x, y = Ints('x y')
2960 """Return `True` if `a` is an expression of the form b - c.
2962 >>> x, y = Ints('x y')
2972 """Return `True` if `a` is an expression of the form b / c.
2974 >>> x, y = Reals('x y')
2979 >>> x, y = Ints('x y')
2989 """Return `True` if `a` is an expression of the form b div c.
2991 >>> x, y = Ints('x y')
3001 """Return `True` if `a` is an expression of the form b % c.
3003 >>> x, y = Ints('x y')
3013 """Return `True` if `a` is an expression of the form b <= c.
3015 >>> x, y = Ints('x y')
3025 """Return `True` if `a` is an expression of the form b < c.
3027 >>> x, y = Ints('x y')
3037 """Return `True` if `a` is an expression of the form b >= c.
3039 >>> x, y = Ints('x y')
3049 """Return `True` if `a` is an expression of the form b > c.
3051 >>> x, y = Ints('x y')
3061 """Return `True` if `a` is an expression of the form IsInt(b).
3064 >>> is_is_int(IsInt(x))
3073 """Return `True` if `a` is an expression of the form ToReal(b).
3088 """Return `True` if `a` is an expression of the form ToInt(b).
3103 """Integer values."""
3106 """Return a Z3 integer numeral as a Python long (bignum) numeral.
3119 """Return a Z3 integer numeral as a Python string.
3127 """Return a Z3 integer numeral as a Python binary string.
3129 >>> v.as_binary_string()
3139 """Rational values."""
3142 """ Return the numerator of a Z3 rational numeral.
3144 >>> is_rational_value(RealVal("3/5"))
3146 >>> n = RealVal("3/5")
3149 >>> is_rational_value(Q(3,5))
3151 >>> Q(3,5).numerator()
3157 """ Return the denominator of a Z3 rational numeral.
3159 >>> is_rational_value(Q(3,5))
3168 """ Return the numerator as a Python long.
3170 >>> v = RealVal(10000000000)
3175 >>> v.numerator_as_long() + 1 == 10000000001
3181 """ Return the denominator as a Python long.
3183 >>> v = RealVal("1/3")
3186 >>> v.denominator_as_long()
3205 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3207 >>> v = RealVal("1/5")
3210 >>> v = RealVal("1/3")
3217 """Return a Z3 rational numeral as a Python string.
3226 """Return a Z3 rational as a Python Fraction object.
3228 >>> v = RealVal("1/5")
3239 """Algebraic irrational values."""
3242 """Return a Z3 rational number that approximates the algebraic number `self`.
3243 The result `r` is such that |r - self| <= 1/10^precision
3245 >>> x = simplify(Sqrt(2))
3247 6838717160008073720548335/4835703278458516698824704
3254 """Return a string representation of the algebraic number `self` in decimal notation
3255 using `prec` decimal places.
3257 >>> x = simplify(Sqrt(2))
3258 >>> x.as_decimal(10)
3260 >>> x.as_decimal(20)
3261 '1.41421356237309504880?'
3273 if isinstance(a, bool):
3277 if isinstance(a, float):
3279 if isinstance(a, str):
3284 _z3_assert(
False,
"Python bool, int, long or float expected")
3288 """Return the integer sort in the given context. If `ctx=None`, then the global context is used.
3292 >>> x = Const('x', IntSort())
3295 >>> x.sort() == IntSort()
3297 >>> x.sort() == BoolSort()
3305 """Return the real sort in the given context. If `ctx=None`, then the global context is used.
3309 >>> x = Const('x', RealSort())
3314 >>> x.sort() == RealSort()
3322 if isinstance(val, float):
3323 return str(int(val))
3324 elif isinstance(val, bool):
3334 """Return a Z3 integer value. If `ctx=None`, then the global context is used.
3346 """Return a Z3 real value.
3348 `val` may be a Python int, long, float or string representing a number in decimal or rational notation.
3349 If `ctx=None`, then the global context is used.
3353 >>> RealVal(1).sort()
3365 """Return a Z3 rational a/b.
3367 If `ctx=None`, then the global context is used.
3371 >>> RatVal(3,5).sort()
3375 _z3_assert(
_is_int(a)
or isinstance(a, str),
"First argument cannot be converted into an integer")
3376 _z3_assert(
_is_int(b)
or isinstance(b, str),
"Second argument cannot be converted into an integer")
3382def Q(a, b, ctx=None):
3383 """Return a Z3 rational a/b.
3385 If `ctx=None`, then the global context is used.
3396 """Return an integer constant named `name`. If `ctx=None`, then the global context is used.
3409 """Return a tuple of Integer constants.
3411 >>> x, y, z = Ints('x y z')
3416 if isinstance(names, str):
3417 names = names.split(
" ")
3418 return [
Int(name, ctx)
for name
in names]
3422 """Return a list of integer constants of size `sz`.
3424 >>> X = IntVector('x', 3)
3431 return [
Int(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3435 """Return a fresh integer constant in the given context using the given prefix.
3449 """Return a real constant named `name`. If `ctx=None`, then the global context is used.
3462 """Return a tuple of real constants.
3464 >>> x, y, z = Reals('x y z')
3467 >>> Sum(x, y, z).sort()
3471 if isinstance(names, str):
3472 names = names.split(
" ")
3473 return [
Real(name, ctx)
for name
in names]
3477 """Return a list of real constants of size `sz`.
3479 >>> X = RealVector('x', 3)
3488 return [
Real(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3492 """Return a fresh real constant in the given context using the given prefix.
3506 """ Return the Z3 expression ToReal(a).
3518 if isinstance(a, BoolRef):
3521 _z3_assert(a.is_int(),
"Z3 integer expression expected.")
3526 """ Return the Z3 expression ToInt(a).
3538 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3544 """ Return the Z3 predicate IsInt(a).
3547 >>> IsInt(x + "1/2")
3549 >>> solve(IsInt(x + "1/2"), x > 0, x < 1)
3551 >>> solve(IsInt(x + "1/2"), x > 0, x < 1, x != "1/2")
3555 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3561 """ Return a Z3 expression which represents the square root of a.
3574 """ Return a Z3 expression which represents the cubic root of a.
3593 """Bit-vector sort."""
3596 """Return the size (number of bits) of the bit-vector sort `self`.
3598 >>> b = BitVecSort(32)
3608 """Try to cast `val` as a Bit-Vector.
3610 >>> b = BitVecSort(32)
3613 >>> b.cast(10).sexpr()
3626 """Return True if `s` is a Z3 bit-vector sort.
3628 >>> is_bv_sort(BitVecSort(32))
3630 >>> is_bv_sort(IntSort())
3633 return isinstance(s, BitVecSortRef)
3637 """Bit-vector expressions."""
3640 """Return the sort of the bit-vector expression `self`.
3642 >>> x = BitVec('x', 32)
3645 >>> x.sort() == BitVecSort(32)
3651 """Return the number of bits of the bit-vector expression `self`.
3653 >>> x = BitVec('x', 32)
3656 >>> Concat(x, x).size()
3662 """Create the Z3 expression `self + other`.
3664 >>> x = BitVec('x', 32)
3665 >>> y = BitVec('y', 32)
3675 """Create the Z3 expression `other + self`.
3677 >>> x = BitVec('x', 32)
3685 """Create the Z3 expression `self * other`.
3687 >>> x = BitVec('x', 32)
3688 >>> y = BitVec('y', 32)
3698 """Create the Z3 expression `other * self`.
3700 >>> x = BitVec('x', 32)
3708 """Create the Z3 expression `self - other`.
3710 >>> x = BitVec('x', 32)
3711 >>> y = BitVec('y', 32)
3721 """Create the Z3 expression `other - self`.
3723 >>> x = BitVec('x', 32)
3731 """Create the Z3 expression bitwise-or `self | other`.
3733 >>> x = BitVec('x', 32)
3734 >>> y = BitVec('y', 32)
3744 """Create the Z3 expression bitwise-or `other | self`.
3746 >>> x = BitVec('x', 32)
3754 """Create the Z3 expression bitwise-and `self & other`.
3756 >>> x = BitVec('x', 32)
3757 >>> y = BitVec('y', 32)
3767 """Create the Z3 expression bitwise-or `other & self`.
3769 >>> x = BitVec('x', 32)
3777 """Create the Z3 expression bitwise-xor `self ^ other`.
3779 >>> x = BitVec('x', 32)
3780 >>> y = BitVec('y', 32)
3790 """Create the Z3 expression bitwise-xor `other ^ self`.
3792 >>> x = BitVec('x', 32)
3802 >>> x = BitVec('x', 32)
3809 """Return an expression representing `-self`.
3811 >>> x = BitVec('x', 32)
3820 """Create the Z3 expression bitwise-not `~self`.
3822 >>> x = BitVec('x', 32)
3831 """Create the Z3 expression (signed) division `self / other`.
3833 Use the function UDiv() for unsigned division.
3835 >>> x = BitVec('x', 32)
3836 >>> y = BitVec('y', 32)
3843 >>> UDiv(x, y).sexpr()
3850 """Create the Z3 expression (signed) division `self / other`."""
3854 """Create the Z3 expression (signed) division `other / self`.
3856 Use the function UDiv() for unsigned division.
3858 >>> x = BitVec('x', 32)
3861 >>> (10 / x).sexpr()
3862 '(bvsdiv #x0000000a x)'
3863 >>> UDiv(10, x).sexpr()
3864 '(bvudiv #x0000000a x)'
3870 """Create the Z3 expression (signed) division `other / self`."""
3874 """Create the Z3 expression (signed) mod `self % other`.
3876 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3878 >>> x = BitVec('x', 32)
3879 >>> y = BitVec('y', 32)
3886 >>> URem(x, y).sexpr()
3888 >>> SRem(x, y).sexpr()
3895 """Create the Z3 expression (signed) mod `other % self`.
3897 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3899 >>> x = BitVec('x', 32)
3902 >>> (10 % x).sexpr()
3903 '(bvsmod #x0000000a x)'
3904 >>> URem(10, x).sexpr()
3905 '(bvurem #x0000000a x)'
3906 >>> SRem(10, x).sexpr()
3907 '(bvsrem #x0000000a x)'
3913 """Create the Z3 expression (signed) `other <= self`.
3915 Use the function ULE() for unsigned less than or equal to.
3917 >>> x, y = BitVecs('x y', 32)
3920 >>> (x <= y).sexpr()
3922 >>> ULE(x, y).sexpr()
3929 """Create the Z3 expression (signed) `other < self`.
3931 Use the function ULT() for unsigned less than.
3933 >>> x, y = BitVecs('x y', 32)
3938 >>> ULT(x, y).sexpr()
3945 """Create the Z3 expression (signed) `other > self`.
3947 Use the function UGT() for unsigned greater than.
3949 >>> x, y = BitVecs('x y', 32)
3954 >>> UGT(x, y).sexpr()
3961 """Create the Z3 expression (signed) `other >= self`.
3963 Use the function UGE() for unsigned greater than or equal to.
3965 >>> x, y = BitVecs('x y', 32)
3968 >>> (x >= y).sexpr()
3970 >>> UGE(x, y).sexpr()
3977 """Create the Z3 expression (arithmetical) right shift `self >> other`
3979 Use the function LShR() for the right logical shift
3981 >>> x, y = BitVecs('x y', 32)
3984 >>> (x >> y).sexpr()
3986 >>> LShR(x, y).sexpr()
3990 >>> BitVecVal(4, 3).as_signed_long()
3992 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
3994 >>> simplify(BitVecVal(4, 3) >> 1)
3996 >>> simplify(LShR(BitVecVal(4, 3), 1))
3998 >>> simplify(BitVecVal(2, 3) >> 1)
4000 >>> simplify(LShR(BitVecVal(2, 3), 1))
4007 """Create the Z3 expression left shift `self << other`
4009 >>> x, y = BitVecs('x y', 32)
4012 >>> (x << y).sexpr()
4014 >>> simplify(BitVecVal(2, 3) << 1)
4021 """Create the Z3 expression (arithmetical) right shift `other` >> `self`.
4023 Use the function LShR() for the right logical shift
4025 >>> x = BitVec('x', 32)
4028 >>> (10 >> x).sexpr()
4029 '(bvashr #x0000000a x)'
4035 """Create the Z3 expression left shift `other << self`.
4037 Use the function LShR() for the right logical shift
4039 >>> x = BitVec('x', 32)
4042 >>> (10 << x).sexpr()
4043 '(bvshl #x0000000a x)'
4050 """Bit-vector values."""
4053 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4055 >>> v = BitVecVal(0xbadc0de, 32)
4058 >>> print("0x%.8x" % v.as_long())
4064 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4065 The most significant bit is assumed to be the sign.
4067 >>> BitVecVal(4, 3).as_signed_long()
4069 >>> BitVecVal(7, 3).as_signed_long()
4071 >>> BitVecVal(3, 3).as_signed_long()
4073 >>> BitVecVal(2**32 - 1, 32).as_signed_long()
4075 >>> BitVecVal(2**64 - 1, 64).as_signed_long()
4080 if val >= 2**(sz - 1):
4082 if val < -2**(sz - 1):
4093 """Return the Python value of a Z3 bit-vector numeral."""
4099 """Return `True` if `a` is a Z3 bit-vector expression.
4101 >>> b = BitVec('b', 32)
4109 return isinstance(a, BitVecRef)
4113 """Return `True` if `a` is a Z3 bit-vector numeral value.
4115 >>> b = BitVec('b', 32)
4118 >>> b = BitVecVal(10, 32)
4128 """Return the Z3 expression BV2Int(a).
4130 >>> b = BitVec('b', 3)
4131 >>> BV2Int(b).sort()
4136 >>> x > BV2Int(b, is_signed=False)
4138 >>> x > BV2Int(b, is_signed=True)
4139 x > If(b < 0, BV2Int(b) - 8, BV2Int(b))
4140 >>> solve(x > BV2Int(b), b == 1, x < 3)
4144 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4151 """Return the z3 expression Int2BV(a, num_bits).
4152 It is a bit-vector of width num_bits and represents the
4153 modulo of a by 2^num_bits
4160 """Return a Z3 bit-vector sort of the given size. If `ctx=None`, then the global context is used.
4162 >>> Byte = BitVecSort(8)
4163 >>> Word = BitVecSort(16)
4166 >>> x = Const('x', Byte)
4167 >>> eq(x, BitVec('x', 8))
4175 """Return a bit-vector value with the given number of bits. If `ctx=None`, then the global context is used.
4177 >>> v = BitVecVal(10, 32)
4180 >>> print("0x%.8x" % v.as_long())
4192 """Return a bit-vector constant named `name`. `bv` may be the number of bits of a bit-vector sort.
4193 If `ctx=None`, then the global context is used.
4195 >>> x = BitVec('x', 16)
4202 >>> word = BitVecSort(16)
4203 >>> x2 = BitVec('x', word)
4207 if isinstance(bv, BitVecSortRef):
4216 """Return a tuple of bit-vector constants of size bv.
4218 >>> x, y, z = BitVecs('x y z', 16)
4225 >>> Product(x, y, z)
4227 >>> simplify(Product(x, y, z))
4231 if isinstance(names, str):
4232 names = names.split(
" ")
4233 return [
BitVec(name, bv, ctx)
for name
in names]
4237 """Create a Z3 bit-vector concatenation expression.
4239 >>> v = BitVecVal(1, 4)
4240 >>> Concat(v, v+1, v)
4241 Concat(Concat(1, 1 + 1), 1)
4242 >>> simplify(Concat(v, v+1, v))
4244 >>> print("%.3x" % simplify(Concat(v, v+1, v)).as_long())
4250 _z3_assert(sz >= 2,
"At least two arguments expected.")
4257 if is_seq(args[0])
or isinstance(args[0], str):
4260 _z3_assert(all([
is_seq(a)
for a
in args]),
"All arguments must be sequence expressions.")
4263 v[i] = args[i].as_ast()
4268 _z3_assert(all([
is_re(a)
for a
in args]),
"All arguments must be regular expressions.")
4271 v[i] = args[i].as_ast()
4275 _z3_assert(all([
is_bv(a)
for a
in args]),
"All arguments must be Z3 bit-vector expressions.")
4277 for i
in range(sz - 1):
4283 """Create a Z3 bit-vector extraction expression or sequence extraction expression.
4285 Extract is overloaded to work with both bit-vectors and sequences:
4287 **Bit-vector extraction**: Extract(high, low, bitvector)
4288 Extracts bits from position `high` down to position `low` (both inclusive).
4289 - high: int - the highest bit position to extract (0-indexed from right)
4290 - low: int - the lowest bit position to extract (0-indexed from right)
4291 - bitvector: BitVecRef - the bit-vector to extract from
4292 Returns a new bit-vector containing bits [high:low]
4294 **Sequence extraction**: Extract(sequence, offset, length)
4295 Extracts a subsequence starting at the given offset with the specified length.
4296 The functions SubString and SubSeq are redirected to this form of Extract.
4297 - sequence: SeqRef or str - the sequence to extract from
4298 - offset: int - the starting position (0-indexed)
4299 - length: int - the number of elements to extract
4300 Returns a new sequence containing the extracted subsequence
4302 >>> # Bit-vector extraction examples
4303 >>> x = BitVec('x', 8)
4304 >>> Extract(6, 2, x) # Extract bits 6 down to 2 (5 bits total)
4306 >>> Extract(6, 2, x).sort() # Result is a 5-bit vector
4308 >>> Extract(7, 0, x) # Extract all 8 bits
4310 >>> Extract(3, 3, x) # Extract single bit at position 3
4313 >>> # Sequence extraction examples
4314 >>> s = StringVal("hello")
4315 >>> Extract(s, 1, 3) # Extract 3 characters starting at position 1
4316 str.substr("hello", 1, 3)
4317 >>> simplify(Extract(StringVal("abcd"), 2, 1)) # Extract 1 character at position 2
4319 >>> simplify(Extract(StringVal("abcd"), 0, 2)) # Extract first 2 characters
4322 if isinstance(high, str):
4329 _z3_assert(low <= high,
"First argument must be greater than or equal to second argument")
4331 "First and second arguments must be non negative integers")
4332 _z3_assert(
is_bv(a),
"Third argument must be a Z3 bit-vector expression")
4338 _z3_assert(
is_bv(a)
or is_bv(b),
"First or second argument must be a Z3 bit-vector expression")
4342 """Create the Z3 expression (unsigned) `other <= self`.
4344 Use the operator <= for signed less than or equal to.
4346 >>> x, y = BitVecs('x y', 32)
4349 >>> (x <= y).sexpr()
4351 >>> ULE(x, y).sexpr()
4360 """Create the Z3 expression (unsigned) `other < self`.
4362 Use the operator < for signed less than.
4364 >>> x, y = BitVecs('x y', 32)
4369 >>> ULT(x, y).sexpr()
4378 """Create the Z3 expression (unsigned) `other >= self`.
4380 Use the operator >= for signed greater than or equal to.
4382 >>> x, y = BitVecs('x y', 32)
4385 >>> (x >= y).sexpr()
4387 >>> UGE(x, y).sexpr()
4396 """Create the Z3 expression (unsigned) `other > self`.
4398 Use the operator > for signed greater than.
4400 >>> x, y = BitVecs('x y', 32)
4405 >>> UGT(x, y).sexpr()
4414 """Create the Z3 expression (unsigned) division `self / other`.
4416 Use the operator / for signed division.
4418 >>> x = BitVec('x', 32)
4419 >>> y = BitVec('y', 32)
4422 >>> UDiv(x, y).sort()
4426 >>> UDiv(x, y).sexpr()
4435 """Create the Z3 expression (unsigned) remainder `self % other`.
4437 Use the operator % for signed modulus, and SRem() for signed remainder.
4439 >>> x = BitVec('x', 32)
4440 >>> y = BitVec('y', 32)
4443 >>> URem(x, y).sort()
4447 >>> URem(x, y).sexpr()
4456 """Create the Z3 expression signed remainder.
4458 Use the operator % for signed modulus, and URem() for unsigned remainder.
4460 >>> x = BitVec('x', 32)
4461 >>> y = BitVec('y', 32)
4464 >>> SRem(x, y).sort()
4468 >>> SRem(x, y).sexpr()
4477 """Create the Z3 expression logical right shift.
4479 Use the operator >> for the arithmetical right shift.
4481 >>> x, y = BitVecs('x y', 32)
4484 >>> (x >> y).sexpr()
4486 >>> LShR(x, y).sexpr()
4490 >>> BitVecVal(4, 3).as_signed_long()
4492 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
4494 >>> simplify(BitVecVal(4, 3) >> 1)
4496 >>> simplify(LShR(BitVecVal(4, 3), 1))
4498 >>> simplify(BitVecVal(2, 3) >> 1)
4500 >>> simplify(LShR(BitVecVal(2, 3), 1))
4509 """Return an expression representing `a` rotated to the left `b` times.
4511 >>> a, b = BitVecs('a b', 16)
4512 >>> RotateLeft(a, b)
4514 >>> simplify(RotateLeft(a, 0))
4516 >>> simplify(RotateLeft(a, 16))
4525 """Return an expression representing `a` rotated to the right `b` times.
4527 >>> a, b = BitVecs('a b', 16)
4528 >>> RotateRight(a, b)
4530 >>> simplify(RotateRight(a, 0))
4532 >>> simplify(RotateRight(a, 16))
4541 """Return a bit-vector expression with `n` extra sign-bits.
4543 >>> x = BitVec('x', 16)
4544 >>> n = SignExt(8, x)
4551 >>> v0 = BitVecVal(2, 2)
4556 >>> v = simplify(SignExt(6, v0))
4561 >>> print("%.x" % v.as_long())
4566 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4571 """Return a bit-vector expression with `n` extra zero-bits.
4573 >>> x = BitVec('x', 16)
4574 >>> n = ZeroExt(8, x)
4581 >>> v0 = BitVecVal(2, 2)
4586 >>> v = simplify(ZeroExt(6, v0))
4594 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4599 """Return an expression representing `n` copies of `a`.
4601 >>> x = BitVec('x', 8)
4602 >>> n = RepeatBitVec(4, x)
4607 >>> v0 = BitVecVal(10, 4)
4608 >>> print("%.x" % v0.as_long())
4610 >>> v = simplify(RepeatBitVec(4, v0))
4613 >>> print("%.x" % v.as_long())
4618 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4623 """Return the reduction-and expression of `a`."""
4625 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4630 """Return the reduction-or expression of `a`."""
4632 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4637 """A predicate the determines that bit-vector addition does not overflow"""
4644 """A predicate the determines that signed bit-vector addition does not underflow"""
4651 """A predicate the determines that bit-vector subtraction does not overflow"""
4658 """A predicate the determines that bit-vector subtraction does not underflow"""
4665 """A predicate the determines that bit-vector signed division does not overflow"""
4672 """A predicate the determines that bit-vector unary negation does not overflow"""
4674 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4679 """A predicate the determines that bit-vector multiplication does not overflow"""
4686 """A predicate the determines that bit-vector signed multiplication does not underflow"""
4702 """Return the domain of the array sort `self`.
4704 >>> A = ArraySort(IntSort(), BoolSort())
4711 """Return the domain of the array sort `self`.
4716 """Return the range of the array sort `self`.
4718 >>> A = ArraySort(IntSort(), BoolSort())
4726 """Array expressions. """
4729 """Return the array sort of the array expression `self`.
4731 >>> a = Array('a', IntSort(), BoolSort())
4738 """Shorthand for `self.sort().domain()`.
4740 >>> a = Array('a', IntSort(), BoolSort())
4747 """Shorthand for self.sort().domain_n(i)`."""
4751 """Shorthand for `self.sort().range()`.
4753 >>> a = Array('a', IntSort(), BoolSort())
4760 """Return the Z3 expression `self[arg]`.
4762 >>> a = Array('a', IntSort(), BoolSort())
4776 if isinstance(arg, tuple):
4777 args = [ar.sort().domain_n(i).cast(arg[i])
for i
in range(len(arg))]
4780 arg = ar.sort().domain().cast(arg)
4789 """Return `True` if `a` is a Z3 array expression.
4791 >>> a = Array('a', IntSort(), IntSort())
4794 >>> is_array(Store(a, 0, 1))
4799 return isinstance(a, ArrayRef)
4803 """Return `True` if `a` is a Z3 constant array.
4805 >>> a = K(IntSort(), 10)
4806 >>> is_const_array(a)
4808 >>> a = Array('a', IntSort(), IntSort())
4809 >>> is_const_array(a)
4816 """Return `True` if `a` is a Z3 constant array.
4818 >>> a = K(IntSort(), 10)
4821 >>> a = Array('a', IntSort(), IntSort())
4829 """Return `True` if `a` is a Z3 map array expression.
4831 >>> f = Function('f', IntSort(), IntSort())
4832 >>> b = Array('b', IntSort(), IntSort())
4845 """Return `True` if `a` is a Z3 default array expression.
4846 >>> d = Default(K(IntSort(), 10))
4850 return is_app_of(a, Z3_OP_ARRAY_DEFAULT)
4854 """Return the function declaration associated with a Z3 map array expression.
4856 >>> f = Function('f', IntSort(), IntSort())
4857 >>> b = Array('b', IntSort(), IntSort())
4859 >>> eq(f, get_map_func(a))
4863 >>> get_map_func(a)(0)
4878 """Return the Z3 array sort with the given domain and range sorts.
4880 >>> A = ArraySort(IntSort(), BoolSort())
4887 >>> AA = ArraySort(IntSort(), A)
4889 Array(Int, Array(Int, Bool))
4893 _z3_assert(len(sig) > 1,
"At least two arguments expected")
4894 arity = len(sig) - 1
4900 _z3_assert(s.ctx == r.ctx,
"Context mismatch")
4904 dom = (Sort * arity)()
4905 for i
in range(arity):
4911 """Return an array constant named `name` with the given domain and range sorts.
4913 >>> a = Array('a', IntSort(), IntSort())
4925 """Return a Z3 store array expression.
4927 >>> a = Array('a', IntSort(), IntSort())
4928 >>> i, v = Ints('i v')
4929 >>> s = Update(a, i, v)
4932 >>> prove(s[i] == v)
4935 >>> prove(Implies(i != j, s[j] == a[j]))
4943 raise Z3Exception(
"array update requires index and value arguments")
4947 i = a.sort().domain().cast(i)
4948 v = a.sort().range().cast(v)
4950 v = a.sort().range().cast(args[-1])
4951 idxs = [a.sort().domain_n(i).cast(args[i])
for i
in range(len(args)-1)]
4957 """ Return a default value for array expression.
4958 >>> b = K(IntSort(), 1)
4959 >>> prove(Default(b) == 1)
4968 """Return a Z3 store array expression.
4970 >>> a = Array('a', IntSort(), IntSort())
4971 >>> i, v = Ints('i v')
4972 >>> s = Store(a, i, v)
4975 >>> prove(s[i] == v)
4978 >>> prove(Implies(i != j, s[j] == a[j]))
4985 """Return a Z3 select array expression.
4987 >>> a = Array('a', IntSort(), IntSort())
4991 >>> eq(Select(a, i), a[i])
5001 """Return a Z3 map array expression.
5003 >>> f = Function('f', IntSort(), IntSort(), IntSort())
5004 >>> a1 = Array('a1', IntSort(), IntSort())
5005 >>> a2 = Array('a2', IntSort(), IntSort())
5006 >>> b = Map(f, a1, a2)
5009 >>> prove(b[0] == f(a1[0], a2[0]))
5014 _z3_assert(len(args) > 0,
"At least one Z3 array expression expected")
5017 _z3_assert(len(args) == f.arity(),
"Number of arguments mismatch")
5024 """Return a Z3 constant array expression.
5026 >>> a = K(IntSort(), 10)
5046 """Return extensionality index for one-dimensional arrays.
5047 >> a, b = Consts('a b', SetSort(IntSort()))
5057 """Return `True` if `a` is a Z3 array select application.
5059 >>> a = Array('a', IntSort(), IntSort())
5070 """Return `True` if `a` is a Z3 array store application.
5072 >>> a = Array('a', IntSort(), IntSort())
5075 >>> is_store(Store(a, 0, 1))
5088 """ Create a set sort over element sort s"""
5093 """Create the empty set
5094 >>> EmptySet(IntSort())
5102 """Create the full set
5103 >>> FullSet(IntSort())
5111 """ Take the union of sets
5112 >>> a = Const('a', SetSort(IntSort()))
5113 >>> b = Const('b', SetSort(IntSort()))
5124 """ Take the union of sets
5125 >>> a = Const('a', SetSort(IntSort()))
5126 >>> b = Const('b', SetSort(IntSort()))
5127 >>> SetIntersect(a, b)
5137 """ Add element e to set s
5138 >>> a = Const('a', SetSort(IntSort()))
5148 """ Remove element e to set s
5149 >>> a = Const('a', SetSort(IntSort()))
5159 """ The complement of set s
5160 >>> a = Const('a', SetSort(IntSort()))
5161 >>> SetComplement(a)
5169 """ The set difference of a and b
5170 >>> a = Const('a', SetSort(IntSort()))
5171 >>> b = Const('b', SetSort(IntSort()))
5172 >>> SetDifference(a, b)
5180 """ Check if e is a member of set s
5181 >>> a = Const('a', SetSort(IntSort()))
5191 """ Check if a is a subset of b
5192 >>> a = Const('a', SetSort(IntSort()))
5193 >>> b = Const('b', SetSort(IntSort()))
5208 """Return `True` if acc is pair of the form (String, Datatype or Sort). """
5209 if not isinstance(acc, tuple):
5213 return isinstance(acc[0], str)
and (isinstance(acc[1], Datatype)
or is_sort(acc[1]))
5217 """Helper class for declaring Z3 datatypes.
5219 >>> List = Datatype('List')
5220 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5221 >>> List.declare('nil')
5222 >>> List = List.create()
5223 >>> # List is now a Z3 declaration
5226 >>> List.cons(10, List.nil)
5228 >>> List.cons(10, List.nil).sort()
5230 >>> cons = List.cons
5234 >>> n = cons(1, cons(0, nil))
5236 cons(1, cons(0, nil))
5237 >>> simplify(cdr(n))
5239 >>> simplify(car(n))
5255 _z3_assert(isinstance(name, str),
"String expected")
5256 _z3_assert(isinstance(rec_name, str),
"String expected")
5259 "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)",
5264 """Declare constructor named `name` with the given accessors `args`.
5265 Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort
5266 or a reference to the datatypes being declared.
5268 In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
5269 declares the constructor named `cons` that builds a new List using an integer and a List.
5270 It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer
5271 of a `cons` cell, and `cdr` the list of a `cons` cell. After all constructors were declared,
5272 we use the method create() to create the actual datatype in Z3.
5274 >>> List = Datatype('List')
5275 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5276 >>> List.declare('nil')
5277 >>> List = List.create()
5280 _z3_assert(isinstance(name, str),
"String expected")
5281 _z3_assert(name !=
"",
"Constructor name cannot be empty")
5288 """Create a Z3 datatype based on the constructors declared using the method `declare()`.
5290 The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
5292 >>> List = Datatype('List')
5293 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5294 >>> List.declare('nil')
5295 >>> List = List.create()
5298 >>> List.cons(10, List.nil)
5305 """Auxiliary object used to create Z3 datatypes."""
5312 if self.
ctx.ref()
is not None and Z3_del_constructor
is not None:
5317 """Auxiliary object used to create Z3 datatypes."""
5324 if self.
ctx.ref()
is not None and Z3_del_constructor_list
is not None:
5329 """Create mutually recursive Z3 datatypes using 1 or more Datatype helper objects.
5331 In the following example we define a Tree-List using two mutually recursive datatypes.
5333 >>> TreeList = Datatype('TreeList')
5334 >>> Tree = Datatype('Tree')
5335 >>> # Tree has two constructors: leaf and node
5336 >>> Tree.declare('leaf', ('val', IntSort()))
5337 >>> # a node contains a list of trees
5338 >>> Tree.declare('node', ('children', TreeList))
5339 >>> TreeList.declare('nil')
5340 >>> TreeList.declare('cons', ('car', Tree), ('cdr', TreeList))
5341 >>> Tree, TreeList = CreateDatatypes(Tree, TreeList)
5342 >>> Tree.val(Tree.leaf(10))
5344 >>> simplify(Tree.val(Tree.leaf(10)))
5346 >>> n1 = Tree.node(TreeList.cons(Tree.leaf(10), TreeList.cons(Tree.leaf(20), TreeList.nil)))
5348 node(cons(leaf(10), cons(leaf(20), nil)))
5349 >>> n2 = Tree.node(TreeList.cons(n1, TreeList.nil))
5350 >>> simplify(n2 == n1)
5352 >>> simplify(TreeList.car(Tree.children(n2)) == n1)
5357 _z3_assert(len(ds) > 0,
"At least one Datatype must be specified")
5358 _z3_assert(all([isinstance(d, Datatype)
for d
in ds]),
"Arguments must be Datatypes")
5359 _z3_assert(all([d.ctx == ds[0].ctx
for d
in ds]),
"Context mismatch")
5360 _z3_assert(all([d.constructors != []
for d
in ds]),
"Non-empty Datatypes expected")
5363 names = (Symbol * num)()
5364 out = (Sort * num)()
5365 clists = (ConstructorList * num)()
5367 for i
in range(num):
5370 num_cs = len(d.constructors)
5371 cs = (Constructor * num_cs)()
5372 for j
in range(num_cs):
5373 c = d.constructors[j]
5378 fnames = (Symbol * num_fs)()
5379 sorts = (Sort * num_fs)()
5380 refs = (ctypes.c_uint * num_fs)()
5381 for k
in range(num_fs):
5385 if isinstance(ftype, Datatype):
5388 ds.count(ftype) == 1,
5389 "One and only one occurrence of each datatype is expected",
5392 refs[k] = ds.index(ftype)
5396 sorts[k] = ftype.ast
5405 for i
in range(num):
5407 num_cs = dref.num_constructors()
5408 for j
in range(num_cs):
5409 cref = dref.constructor(j)
5410 cref_name = cref.name()
5411 cref_arity = cref.arity()
5412 if cref.arity() == 0:
5414 setattr(dref, cref_name, cref)
5415 rref = dref.recognizer(j)
5416 setattr(dref,
"is_" + cref_name, rref)
5417 for k
in range(cref_arity):
5418 aref = dref.accessor(j, k)
5419 setattr(dref, aref.name(), aref)
5421 return tuple(result)
5425 """Datatype sorts."""
5428 """Return the number of constructors in the given Z3 datatype.
5430 >>> List = Datatype('List')
5431 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5432 >>> List.declare('nil')
5433 >>> List = List.create()
5434 >>> # List is now a Z3 declaration
5435 >>> List.num_constructors()
5441 """Return a constructor of the datatype `self`.
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()
5450 >>> List.constructor(0)
5452 >>> List.constructor(1)
5460 """In Z3, each constructor has an associated recognizer predicate.
5462 If the constructor is named `name`, then the recognizer `is_name`.
5464 >>> List = Datatype('List')
5465 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5466 >>> List.declare('nil')
5467 >>> List = List.create()
5468 >>> # List is now a Z3 declaration
5469 >>> List.num_constructors()
5471 >>> List.recognizer(0)
5473 >>> List.recognizer(1)
5475 >>> simplify(List.is_nil(List.cons(10, List.nil)))
5477 >>> simplify(List.is_cons(List.cons(10, List.nil)))
5479 >>> l = Const('l', List)
5480 >>> simplify(List.is_cons(l))
5488 """In Z3, each constructor has 0 or more accessor.
5489 The number of accessors is equal to the arity of the constructor.
5491 >>> List = Datatype('List')
5492 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5493 >>> List.declare('nil')
5494 >>> List = List.create()
5495 >>> List.num_constructors()
5497 >>> List.constructor(0)
5499 >>> num_accs = List.constructor(0).arity()
5502 >>> List.accessor(0, 0)
5504 >>> List.accessor(0, 1)
5506 >>> List.constructor(1)
5508 >>> num_accs = List.constructor(1).arity()
5522 """Datatype expressions."""
5525 """Return the datatype sort of the datatype expression `self`."""
5529 """Return a new datatype expression with the specified field updated.
5532 field_accessor: The accessor function declaration for the field to update
5533 new_value: The new value for the field
5536 A new datatype expression with the field updated, other fields unchanged
5539 >>> Person = Datatype('Person')
5540 >>> Person.declare('person', ('name', StringSort()), ('age', IntSort()))
5541 >>> Person = Person.create()
5542 >>> person_age = Person.accessor(0, 1) # age accessor
5543 >>> p = Const('p', Person)
5544 >>> p2 = p.update_field(person_age, IntVal(30))
5555 """Create a reference to a sort that was declared, or will be declared, as a recursive datatype.
5558 name: name of the datatype sort
5559 params: optional list/tuple of sort parameters for parametric datatypes
5560 ctx: Z3 context (optional)
5563 >>> # Non-parametric datatype
5564 >>> TreeRef = DatatypeSort('Tree')
5565 >>> # Parametric datatype with one parameter
5566 >>> ListIntRef = DatatypeSort('List', [IntSort()])
5567 >>> # Parametric datatype with multiple parameters
5568 >>> PairRef = DatatypeSort('Pair', [IntSort(), BoolSort()])
5571 if params
is None or len(params) == 0:
5574 _params = (Sort * len(params))()
5575 for i
in range(len(params)):
5576 _params[i] = params[i].ast
5580 """Create a named tuple sort base on a set of underlying sorts
5582 >>> pair, mk_pair, (first, second) = TupleSort("pair", [IntSort(), StringSort()])
5585 projects = [(
"project%d" % i, sorts[i])
for i
in range(len(sorts))]
5586 tuple.declare(name, *projects)
5587 tuple = tuple.create()
5588 return tuple, tuple.constructor(0), [tuple.accessor(0, i)
for i
in range(len(sorts))]
5592 """Create a named tagged union sort base on a set of underlying sorts
5594 >>> sum, ((inject0, extract0), (inject1, extract1)) = DisjointSum("+", [IntSort(), StringSort()])
5597 for i
in range(len(sorts)):
5598 sum.declare(
"inject%d" % i, (
"project%d" % i, sorts[i]))
5600 return sum, [(sum.constructor(i), sum.accessor(i, 0))
for i
in range(len(sorts))]
5604 """Return a new enumeration sort named `name` containing the given values.
5606 The result is a pair (sort, list of constants).
5608 >>> Color, (red, green, blue) = EnumSort('Color', ['red', 'green', 'blue'])
5611 _z3_assert(isinstance(name, str),
"Name must be a string")
5612 _z3_assert(all([isinstance(v, str)
for v
in values]),
"Enumeration sort values must be strings")
5613 _z3_assert(len(values) > 0,
"At least one value expected")
5616 _val_names = (Symbol * num)()
5617 for i
in range(num):
5618 _val_names[i] =
to_symbol(values[i], ctx)
5619 _values = (FuncDecl * num)()
5620 _testers = (FuncDecl * num)()
5624 for i
in range(num):
5626 V = [a()
for a
in V]
5637 """Set of parameters used to configure Solvers, Tactics and Simplifiers in Z3.
5639 Consider using the function `args2params` to create instances of this object.
5654 if self.
ctx.ref()
is not None and Z3_params_dec_ref
is not None:
5658 """Set parameter name with value val."""
5660 _z3_assert(isinstance(name, str),
"parameter name must be a string")
5662 if isinstance(val, bool):
5666 elif isinstance(val, float):
5668 elif isinstance(val, str):
5678 _z3_assert(isinstance(ds, ParamDescrsRef),
"parameter description set expected")
5683 """Convert python arguments into a Z3_params object.
5684 A ':' is added to the keywords, and '_' is replaced with '-'
5686 >>> args2params(['model', True, 'relevancy', 2], {'elim_and' : True})
5687 (params model true relevancy 2 elim_and true)
5690 _z3_assert(len(arguments) % 2 == 0,
"Argument list must have an even number of elements.")
5706 """Set of parameter descriptions for Solvers, Tactics and Simplifiers in Z3.
5710 _z3_assert(isinstance(descr, ParamDescrs),
"parameter description object expected")
5716 return ParamsDescrsRef(self.
descr, self.
ctx)
5719 if self.
ctx.ref()
is not None and Z3_param_descrs_dec_ref
is not None:
5723 """Return the size of in the parameter description `self`.
5728 """Return the size of in the parameter description `self`.
5733 """Return the i-th parameter name in the parameter description `self`.
5738 """Return the kind of the parameter named `n`.
5743 """Return the documentation string of the parameter named `n`.
5764 """Goal is a collection of constraints we want to find a solution or show to be unsatisfiable (infeasible).
5766 Goals are processed using Tactics. A Tactic transforms a goal into a set of subgoals.
5767 A goal has a solution if one of its subgoals has a solution.
5768 A goal is unsatisfiable if all subgoals are unsatisfiable.
5771 def __init__(self, models=True, unsat_cores=False, proofs=False, ctx=None, goal=None):
5774 "If goal is different from None, then ctx must be also different from None")
5777 if self.
goal is None:
5782 if self.
goal is not None and self.
ctx.ref()
is not None and Z3_goal_dec_ref
is not None:
5786 """Return the depth of the goal `self`.
5787 The depth corresponds to the number of tactics applied to `self`.
5789 >>> x, y = Ints('x y')
5791 >>> g.add(x == 0, y >= x + 1)
5794 >>> r = Then('simplify', 'solve-eqs')(g)
5795 >>> # r has 1 subgoal
5804 """Return `True` if `self` contains the `False` constraints.
5806 >>> x, y = Ints('x y')
5808 >>> g.inconsistent()
5810 >>> g.add(x == 0, x == 1)
5813 >>> g.inconsistent()
5815 >>> g2 = Tactic('propagate-values')(g)[0]
5816 >>> g2.inconsistent()
5822 """Return the precision (under-approximation, over-approximation, or precise) of the goal `self`.
5825 >>> g.prec() == Z3_GOAL_PRECISE
5827 >>> x, y = Ints('x y')
5828 >>> g.add(x == y + 1)
5829 >>> g.prec() == Z3_GOAL_PRECISE
5831 >>> t = With(Tactic('add-bounds'), add_bound_lower=0, add_bound_upper=10)
5834 [x == y + 1, x <= 10, x >= 0, y <= 10, y >= 0]
5835 >>> g2.prec() == Z3_GOAL_PRECISE
5837 >>> g2.prec() == Z3_GOAL_UNDER
5843 """Alias for `prec()`.
5846 >>> g.precision() == Z3_GOAL_PRECISE
5852 """Return the number of constraints in the goal `self`.
5857 >>> x, y = Ints('x y')
5858 >>> g.add(x == 0, y > x)
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 a constraint in the goal `self`.
5881 >>> x, y = Ints('x y')
5882 >>> 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)
5903 if arg < 0
or arg >= len(self):
5905 return self.
get(arg)
5908 """Assert constraints into the goal.
5912 >>> g.assert_exprs(x > 0, x < 2)
5927 >>> g.append(x > 0, x < 2)
5938 >>> g.insert(x > 0, x < 2)
5949 >>> g.add(x > 0, x < 2)
5956 """Retrieve model from a satisfiable goal
5957 >>> a, b = Ints('a b')
5959 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
5960 >>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
5963 [Or(b == 0, b == 1), Not(0 <= b)]
5965 [Or(b == 0, b == 1), Not(1 <= b)]
5966 >>> # Remark: the subgoal r[0] is unsatisfiable
5967 >>> # Creating a solver for solving the second subgoal
5974 >>> # Model s.model() does not assign a value to `a`
5975 >>> # It is a model for subgoal `r[1]`, but not for goal `g`
5976 >>> # The method convert_model creates a model for `g` from a model for `r[1]`.
5977 >>> r[1].convert_model(s.model())
5981 _z3_assert(isinstance(model, ModelRef),
"Z3 Model expected")
5985 return obj_to_string(self)
5988 """Return a textual representation of the s-expression representing the goal."""
5992 """Return a textual representation of the goal in DIMACS format."""
5996 """Copy goal `self` to context `target`.
6004 >>> g2 = g.translate(c2)
6007 >>> g.ctx == main_ctx()
6011 >>> g2.ctx == main_ctx()
6015 _z3_assert(isinstance(target, Context),
"target must be a context")
6025 """Return a new simplified goal.
6027 This method is essentially invoking the simplify tactic.
6031 >>> g.add(x + 1 >= 2)
6034 >>> g2 = g.simplify()
6037 >>> # g was not modified
6042 return t.apply(self, *arguments, **keywords)[0]
6045 """Return goal `self` as a single Z3 expression.
6064 return And([self.
get(i)
for i
in range(len(self))], self.
ctx)
6074 """A collection (vector) of ASTs."""
6083 assert ctx
is not None
6088 if self.
vector is not None and self.
ctx.ref()
is not None and Z3_ast_vector_dec_ref
is not None:
6092 """Return the size of the vector `self`.
6097 >>> A.push(Int('x'))
6098 >>> A.push(Int('x'))
6105 """Return the AST at position `i`.
6108 >>> A.push(Int('x') + 1)
6109 >>> A.push(Int('y'))
6116 if isinstance(i, int):
6124 elif isinstance(i, slice):
6126 for ii
in range(*i.indices(self.
__len__())):
6134 """Update AST at position `i`.
6137 >>> A.push(Int('x') + 1)
6138 >>> A.push(Int('y'))
6147 if i < 0
or i >= self.
__len__():
6152 """Add `v` in the end of the vector.
6157 >>> A.push(Int('x'))
6164 """Resize the vector to `sz` elements.
6170 >>> for i in range(10): A[i] = Int('x')
6177 """Return `True` if the vector contains `item`.
6200 """Copy vector `self` to context `other_ctx`.
6206 >>> B = A.translate(c2)
6222 return obj_to_string(self)
6225 """Return a textual representation of the s-expression representing the vector."""
6236 """A mapping from ASTs to ASTs."""
6245 assert ctx
is not None
6253 if self.
map is not None and self.
ctx.ref()
is not None and Z3_ast_map_dec_ref
is not None:
6257 """Return the size of the map.
6263 >>> M[x] = IntVal(1)
6270 """Return `True` if the map contains key `key`.
6283 """Retrieve the value associated with key `key`.
6294 """Add/Update key `k` with value `v`.
6303 >>> M[x] = IntVal(1)
6313 """Remove the entry associated with key `k`.
6327 """Remove all entries from the map.
6332 >>> M[x+x] = IntVal(1)
6342 """Return an AstVector containing all keys in the map.
6347 >>> M[x+x] = IntVal(1)
6361 """Store the value of the interpretation of a function in a particular point."""
6372 if self.
ctx.ref()
is not None and Z3_func_entry_dec_ref
is not None:
6376 """Return the number of arguments in the given entry.
6378 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6380 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6385 >>> f_i.num_entries()
6387 >>> e = f_i.entry(0)
6394 """Return the value of argument `idx`.
6396 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6398 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6403 >>> f_i.num_entries()
6405 >>> e = f_i.entry(0)
6416 ... except IndexError:
6417 ... print("index error")
6425 """Return the value of the function at point `self`.
6427 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6429 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6434 >>> f_i.num_entries()
6436 >>> e = f_i.entry(0)
6447 """Return entry `self` as a Python list.
6448 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6450 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6455 >>> f_i.num_entries()
6457 >>> e = f_i.entry(0)
6462 args.append(self.
value())
6470 """Stores the interpretation of a function in a Z3 model."""
6475 if self.
f is not None:
6479 if self.
f is not None and self.
ctx.ref()
is not None and Z3_func_interp_dec_ref
is not None:
6484 Return the `else` value for a function interpretation.
6485 Return None if Z3 did not specify the `else` value for
6488 >>> f = Function('f', IntSort(), IntSort())
6490 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6496 >>> m[f].else_value()
6506 """Return the number of entries/points in the function interpretation `self`.
6508 >>> f = Function('f', IntSort(), IntSort())
6510 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6516 >>> m[f].num_entries()
6522 """Return the number of arguments for each entry in the function interpretation `self`.
6524 >>> f = Function('f', IntSort(), IntSort())
6526 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6536 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6538 >>> f = Function('f', IntSort(), IntSort())
6540 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6546 >>> m[f].num_entries()
6556 """Copy model 'self' to context 'other_ctx'.
6567 """Return the function interpretation as a Python list.
6568 >>> f = Function('f', IntSort(), IntSort())
6570 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6584 return obj_to_string(self)
6588 """Model/Solution of a satisfiability problem (aka system of constraints)."""
6591 assert ctx
is not None
6597 if self.
ctx.ref()
is not None and Z3_model_dec_ref
is not None:
6601 return obj_to_string(self)
6604 """Return a textual representation of the s-expression representing the model."""
6607 def eval(self, t, model_completion=False):
6608 """Evaluate the expression `t` in the model `self`.
6609 If `model_completion` is enabled, then a default interpretation is automatically added
6610 for symbols that do not have an interpretation in the model `self`.
6614 >>> s.add(x > 0, x < 2)
6627 >>> m.eval(y, model_completion=True)
6629 >>> # Now, m contains an interpretation for y
6636 raise Z3Exception(
"failed to evaluate expression in the model")
6639 """Alias for `eval`.
6643 >>> s.add(x > 0, x < 2)
6647 >>> m.evaluate(x + 1)
6649 >>> m.evaluate(x == 1)
6652 >>> m.evaluate(y + x)
6656 >>> m.evaluate(y, model_completion=True)
6658 >>> # Now, m contains an interpretation for y
6659 >>> m.evaluate(y + x)
6662 return self.
eval(t, model_completion)
6665 """Return the number of constant and function declarations in the model `self`.
6667 >>> f = Function('f', IntSort(), IntSort())
6670 >>> s.add(x > 0, f(x) != x)
6679 return num_consts + num_funcs
6682 """Return the interpretation for a given declaration or constant.
6684 >>> f = Function('f', IntSort(), IntSort())
6687 >>> s.add(x > 0, x < 2, f(x) == 0)
6697 _z3_assert(isinstance(decl, FuncDeclRef)
or is_const(decl),
"Z3 declaration expected")
6701 if decl.arity() == 0:
6703 if _r.value
is None:
6719 sz = fi.num_entries()
6723 e =
Store(e, fe.arg_value(0), fe.value())
6734 """Return the number of uninterpreted sorts that contain an interpretation in the model `self`.
6736 >>> A = DeclareSort('A')
6737 >>> a, b = Consts('a b', A)
6749 """Return the uninterpreted sort at position `idx` < self.num_sorts().
6751 >>> A = DeclareSort('A')
6752 >>> B = DeclareSort('B')
6753 >>> a1, a2 = Consts('a1 a2', A)
6754 >>> b1, b2 = Consts('b1 b2', B)
6756 >>> s.add(a1 != a2, b1 != b2)
6772 """Return all uninterpreted sorts that have an interpretation in the model `self`.
6774 >>> A = DeclareSort('A')
6775 >>> B = DeclareSort('B')
6776 >>> a1, a2 = Consts('a1 a2', A)
6777 >>> b1, b2 = Consts('b1 b2', B)
6779 >>> s.add(a1 != a2, b1 != b2)
6789 """Return the interpretation for the uninterpreted sort `s` in the model `self`.
6791 >>> A = DeclareSort('A')
6792 >>> a, b = Consts('a b', A)
6798 >>> m.get_universe(A)
6802 _z3_assert(isinstance(s, SortRef),
"Z3 sort expected")
6809 """If `idx` is an integer, then the declaration at position `idx` in the model `self` is returned.
6810 If `idx` is a declaration, then the actual interpretation is returned.
6812 The elements can be retrieved using position or the actual declaration.
6814 >>> f = Function('f', IntSort(), IntSort())
6817 >>> s.add(x > 0, x < 2, f(x) == 0)
6831 >>> for d in m: print("%s -> %s" % (d, m[d]))
6838 if idx < 0
or idx >= len(self):
6841 if (idx < num_consts):
6845 if isinstance(idx, FuncDeclRef):
6849 if isinstance(idx, SortRef):
6852 _z3_assert(
False,
"Integer, Z3 declaration, or Z3 constant expected")
6856 """Return a list with all symbols that have an interpretation in the model `self`.
6857 >>> f = Function('f', IntSort(), IntSort())
6860 >>> s.add(x > 0, x < 2, f(x) == 0)
6875 """Update the interpretation of a constant"""
6878 if is_func_decl(x)
and x.arity() != 0
and isinstance(value, FuncInterp):
6882 for i
in range(value.num_entries()):
6887 v.push(e.arg_value(j))
6892 raise Z3Exception(
"Expecting 0-ary function or constant expression")
6897 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
6900 _z3_assert(isinstance(target, Context),
"argument must be a Z3 context")
6905 """Perform model-based projection on fml with respect to vars.
6906 Assume that the model satisfies fml. Then compute a projection fml_p, such
6907 that vars do not occur free in fml_p, fml_p is true in the model and
6908 fml_p => exists vars . fml
6910 ctx = self.
ctx.ref()
6911 _vars = (Ast * len(vars))()
6912 for i
in range(len(vars)):
6913 _vars[i] = vars[i].as_ast()
6917 """Perform model-based projection, but also include realizer terms for the projected variables"""
6918 ctx = self.
ctx.ref()
6919 _vars = (Ast * len(vars))()
6920 for i
in range(len(vars)):
6921 _vars[i] = vars[i].as_ast()
6923 result = Z3_qe_model_project_with_witness(ctx, self.
model, len(vars), _vars, fml.ast, defs.map)
6938 for k, v
in eval.items():
6939 mdl.update_value(k, v)
6944 """Return true if n is a Z3 expression of the form (_ as-array f)."""
6945 return isinstance(n, ExprRef)
and Z3_is_as_array(n.ctx.ref(), n.as_ast())
6949 """Return the function declaration f associated with a Z3 expression of the form (_ as-array f)."""
6962 """Statistics for `Solver.check()`."""
6973 if self.
ctx.ref()
is not None and Z3_stats_dec_ref
is not None:
6980 out.write(u(
'<table border="1" cellpadding="2" cellspacing="0">'))
6983 out.write(u(
'<tr style="background-color:#CFCFCF">'))
6986 out.write(u(
"<tr>"))
6988 out.write(u(
"<td>%s</td><td>%s</td></tr>" % (k, v)))
6989 out.write(u(
"</table>"))
6990 return out.getvalue()
6995 """Return the number of statistical counters.
6998 >>> s = Then('simplify', 'nlsat').solver()
7002 >>> st = s.statistics()
7009 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
7012 >>> s = Then('simplify', 'nlsat').solver()
7016 >>> st = s.statistics()
7020 ('nlsat propagations', 2)
7022 ('nlsat restarts', 1)
7024 if idx >= len(self):
7033 """Return the list of statistical counters.
7036 >>> s = Then('simplify', 'nlsat').solver()
7040 >>> st = s.statistics()
7045 """Return the value of a particular statistical counter.
7048 >>> s = Then('simplify', 'nlsat').solver()
7052 >>> st = s.statistics()
7053 >>> st.get_key_value('nlsat propagations')
7056 for idx
in range(len(self)):
7062 raise Z3Exception(
"unknown key")
7065 """Access the value of statistical using attributes.
7067 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
7068 we should use '_' (e.g., 'nlsat_propagations').
7071 >>> s = Then('simplify', 'nlsat').solver()
7075 >>> st = s.statistics()
7076 >>> st.nlsat_propagations
7081 key = name.replace(
"_",
" ")
7085 raise AttributeError
7095 """Represents the result of a satisfiability check: sat, unsat, unknown.
7101 >>> isinstance(r, CheckSatResult)
7112 return isinstance(other, CheckSatResult)
and self.
r == other.r
7115 return not self.
__eq__(other)
7119 if self.
r == Z3_L_TRUE:
7121 elif self.
r == Z3_L_FALSE:
7122 return "<b>unsat</b>"
7124 return "<b>unknown</b>"
7126 if self.
r == Z3_L_TRUE:
7128 elif self.
r == Z3_L_FALSE:
7134 in_html = in_html_mode()
7137 set_html_mode(in_html)
7148 Solver API provides methods for implementing the main SMT 2.0 commands:
7149 push, pop, check, get-model, etc.
7152 def __init__(self, solver=None, ctx=None, logFile=None):
7153 assert solver
is None or ctx
is not None
7162 if logFile
is not None:
7163 self.
set(
"smtlib2_log", logFile)
7166 if self.
solver is not None and self.
ctx.ref()
is not None and Z3_solver_dec_ref
is not None:
7177 """Set a configuration option.
7178 The method `help()` return a string containing all available options.
7181 >>> # The option MBQI can be set using three different approaches.
7182 >>> s.set(mbqi=True)
7183 >>> s.set('MBQI', True)
7184 >>> s.set(':mbqi', True)
7190 """Create a backtracking point.
7212 """Backtrack \\c num backtracking points.
7234 """Return the current number of backtracking points.
7252 """Remove all asserted constraints and backtracking points created using `push()`.
7266 """Assert constraints into the solver.
7270 >>> s.assert_exprs(x > 0, x < 2)
7277 if isinstance(arg, Goal)
or isinstance(arg, AstVector):
7285 """Assert constraints into the solver.
7289 >>> s.add(x > 0, x < 2)
7300 """Assert constraints into the solver.
7304 >>> s.append(x > 0, x < 2)
7311 """Assert constraints into the solver.
7315 >>> s.insert(x > 0, x < 2)
7322 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
7324 If `p` is a string, it will be automatically converted into a Boolean constant.
7329 >>> s.set(unsat_core=True)
7330 >>> s.assert_and_track(x > 0, 'p1')
7331 >>> s.assert_and_track(x != 1, 'p2')
7332 >>> s.assert_and_track(x < 0, p3)
7333 >>> print(s.check())
7335 >>> c = s.unsat_core()
7345 if isinstance(p, str):
7347 _z3_assert(isinstance(a, BoolRef),
"Boolean expression expected")
7352 """Check whether the assertions in the given solver plus the optional assumptions are consistent or not.
7358 >>> s.add(x > 0, x < 2)
7361 >>> s.model().eval(x)
7367 >>> s.add(2**x == 4)
7373 num = len(assumptions)
7374 _assumptions = (Ast * num)()
7375 for i
in range(num):
7376 _assumptions[i] = s.cast(assumptions[i]).as_ast()
7381 """Return a model for the last `check()`.
7383 This function raises an exception if
7384 a model is not available (e.g., last `check()` returned unsat).
7388 >>> s.add(a + 2 == 0)
7397 raise Z3Exception(
"model is not available")
7400 """Import model converter from other into the current solver"""
7401 Z3_solver_import_model_converter(self.ctx.ref(), other.solver, self.solver)
7403 def interrupt(self):
7404 """Interrupt the execution of the solver object.
7405 Remarks: This ensures that the interrupt applies only
7406 to the given solver object and it applies only if it is running.
7408 Z3_solver_interrupt(self.ctx.ref(), self.solver)
7410 def unsat_core(self):
7411 """Return a subset (as an AST vector) of the assumptions provided to the last check().
7413 These are the assumptions Z3 used in the unsatisfiability proof.
7414 Assumptions are available in Z3. They are used to extract unsatisfiable cores.
7415 They may be also used to "retract" assumptions. Note that, assumptions are not really
7416 "soft constraints", but they can be used to implement them.
7418 >>> p1, p2, p3 = Bools('p1 p2 p3')
7419 >>> x, y = Ints('x y')
7421 >>> s.add(Implies(p1, x > 0))
7422 >>> s.add(Implies(p2, y > x))
7423 >>> s.add(Implies(p2, y < 1))
7424 >>> s.add(Implies(p3, y > -3))
7425 >>> s.check(p1, p2, p3)
7427 >>> core = s.unsat_core()
7436 >>> # "Retracting" p2
7440 return AstVector(Z3_solver_get_unsat_core(self.ctx.ref(), self.solver), self.ctx)
7442 def consequences(self, assumptions, variables):
7443 """Determine fixed values for the variables based on the solver state and assumptions.
7445 >>> a, b, c, d = Bools('a b c d')
7446 >>> s.add(Implies(a,b), Implies(b, c))
7447 >>> s.consequences([a],[b,c,d])
7448 (sat, [Implies(a, b), Implies(a, c)])
7449 >>> s.consequences([Not(c),d],[a,b,c,d])
7450 (sat, [Implies(d, d), Implies(Not(c), Not(c)), Implies(Not(c), Not(b)), Implies(Not(c), Not(a))])
7452 if isinstance(assumptions, list):
7453 _asms = AstVector(None, self.ctx)
7454 for a in assumptions:
7457 if isinstance(variables, list):
7458 _vars = AstVector(None, self.ctx)
7462 _z3_assert(isinstance(assumptions, AstVector), "ast vector expected")
7463 _z3_assert(isinstance(variables, AstVector), "ast vector expected")
7464 consequences = AstVector(None, self.ctx)
7465 r = Z3_solver_get_consequences(self.ctx.ref(), self.solver, assumptions.vector,
7466 variables.vector, consequences.vector)
7467 sz = len(consequences)
7468 consequences = [consequences[i] for i in range(sz)]
7469 return CheckSatResult(r), consequences
7471 def from_file(self, filename):
7472 """Parse assertions from a file"""
7473 Z3_solver_from_file(self.ctx.ref(), self.solver, filename)
7475 def from_string(self, s):
7476 """Parse assertions from a string"""
7477 Z3_solver_from_string(self.ctx.ref(), self.solver, s)
7479 def cube(self, vars=None):
7481 The method takes an optional set of variables that restrict which
7482 variables may be used as a starting point for cubing.
7483 If vars is not None, then the first case split is based on a variable in
7486 self.cube_vs = AstVector(None, self.ctx)
7487 if vars is not None:
7489 self.cube_vs.push(v)
7491 lvl = self.backtrack_level
7492 self.backtrack_level = 4000000000
7493 r = AstVector(Z3_solver_cube(self.ctx.ref(), self.solver, self.cube_vs.vector, lvl), self.ctx)
7494 if (len(r) == 1 and is_false(r[0])):
7500 def cube_vars(self):
7501 """Access the set of variables that were touched by the most recently generated cube.
7502 This set of variables can be used as a starting point for additional cubes.
7503 The idea is that variables that appear in clauses that are reduced by the most recent
7504 cube are likely more useful to cube on."""
7508 """Retrieve congruence closure root of the term t relative to the current search state
7509 The function primarily works for SimpleSolver. Terms and variables that are
7510 eliminated during pre-processing are not visible to the congruence closure.
7512 t = _py2expr(t, self.ctx)
7513 return _to_expr_ref(Z3_solver_congruence_root(self.ctx.ref(), self.solver, t.ast), self.ctx)
7516 """Retrieve congruence closure sibling of the term t relative to the current search state
7517 The function primarily works for SimpleSolver. Terms and variables that are
7518 eliminated during pre-processing are not visible to the congruence closure.
7520 t = _py2expr(t, self.ctx)
7521 return _to_expr_ref(Z3_solver_congruence_next(self.ctx.ref(), self.solver, t.ast), self.ctx)
7523 def explain_congruent(self, a, b):
7524 """Explain congruence of a and b relative to the current search state"""
7525 a = _py2expr(a, self.ctx)
7526 b = _py2expr(b, self.ctx)
7527 return _to_expr_ref(Z3_solver_congruence_explain(self.ctx.ref(), self.solver, a.ast, b.ast), self.ctx)
7530 def solve_for(self, ts):
7531 """Retrieve a solution for t relative to linear equations maintained in the current state."""
7532 vars = AstVector(ctx=self.ctx);
7533 terms = AstVector(ctx=self.ctx);
7534 guards = AstVector(ctx=self.ctx);
7536 t = _py2expr(t, self.ctx)
7538 Z3_solver_solve_for(self.ctx.ref(), self.solver, vars.vector, terms.vector, guards.vector)
7539 return [(vars[i], terms[i], guards[i]) for i in range(len(vars))]
7543 """Return a proof for the last `check()`. Proof construction must be enabled."""
7544 return _to_expr_ref(Z3_solver_get_proof(self.ctx.ref(), self.solver), self.ctx)
7546 def assertions(self):
7547 """Return an AST vector containing all added constraints.
7558 return AstVector(Z3_solver_get_assertions(self.ctx.ref(), self.solver), self.ctx)
7561 """Return an AST vector containing all currently inferred units.
7563 return AstVector(Z3_solver_get_units(self.ctx.ref(), self.solver), self.ctx)
7565 def non_units(self):
7566 """Return an AST vector containing all atomic formulas in solver state that are not units.
7568 return AstVector(Z3_solver_get_non_units(self.ctx.ref(), self.solver), self.ctx)
7570 def trail_levels(self):
7571 """Return trail and decision levels of the solver state after a check() call.
7573 trail = self.trail()
7574 levels = (ctypes.c_uint * len(trail))()
7575 Z3_solver_get_levels(self.ctx.ref(), self.solver, trail.vector, len(trail), levels)
7576 return trail, levels
7578 def set_initial_value(self, var, value):
7579 """initialize the solver's state by setting the initial value of var to value
7582 value = s.cast(value)
7583 Z3_solver_set_initial_value(self.ctx.ref(), self.solver, var.ast, value.ast)
7586 """Return trail of the solver state after a check() call.
7588 return AstVector(Z3_solver_get_trail(self.ctx.ref(), self.solver), self.ctx)
7590 def statistics(self):
7591 """Return statistics for the last `check()`.
7593 >>> s = SimpleSolver()
7598 >>> st = s.statistics()
7599 >>> st.get_key_value('final checks')
7606 return Statistics(Z3_solver_get_statistics(self.ctx.ref(), self.solver), self.ctx)
7608 def reason_unknown(self):
7609 """Return a string describing why the last `check()` returned `unknown`.
7612 >>> s = SimpleSolver()
7613 >>> s.add(x == 2**x)
7616 >>> s.reason_unknown()
7617 '(incomplete (theory arithmetic))'
7619 return Z3_solver_get_reason_unknown(self.ctx.ref(), self.solver)
7622 """Display a string describing all available options."""
7623 print(Z3_solver_get_help(self.ctx.ref(), self.solver))
7625 def param_descrs(self):
7626 """Return the parameter description set."""
7627 return ParamDescrsRef(Z3_solver_get_param_descrs(self.ctx.ref(), self.solver), self.ctx)
7630 """Return a formatted string with all added constraints."""
7631 return obj_to_string(self)
7633 def translate(self, target):
7634 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
7638 >>> s1 = Solver(ctx=c1)
7639 >>> s2 = s1.translate(c2)
7642 _z3_assert(isinstance(target, Context), "argument must be a Z3 context")
7643 solver = Z3_solver_translate(self.ctx.ref(), self.solver, target.ref())
7644 return Solver(solver, target)
7647 return self.translate(self.ctx)
7649 def __deepcopy__(self, memo={}):
7650 return self.translate(self.ctx)
7653 """Return a formatted string (in Lisp-like format) with all added constraints.
7654 We say the string is in s-expression format.
7662 return Z3_solver_to_string(self.ctx.ref(), self.solver)
7664 def dimacs(self, include_names=True):
7665 """Return a textual representation of the solver in DIMACS format."""
7666 return Z3_solver_to_dimacs_string(self.ctx.ref(), self.solver, include_names)
7669 """return SMTLIB2 formatted benchmark for solver's assertions"""
7670 es = self.assertions()
7676 for i in range(sz1):
7677 v[i] = es[i].as_ast()
7679 e = es[sz1].as_ast()
7681 e = BoolVal(True, self.ctx).as_ast()
7682 return Z3_benchmark_to_smtlib_string(
7683 self.ctx.ref(), "benchmark generated from python API", "", "unknown", "", sz1, v, e,
7687def SolverFor(logic, ctx=None, logFile=None):
7688 """Create a solver customized for the given logic.
7690 The parameter `logic` is a string. It should be contains
7691 the name of a SMT-LIB logic.
7692 See http://www.smtlib.org/ for the name of all available logics.
7694 >>> s = SolverFor("QF_LIA")
7704 logic = to_symbol(logic)
7705 return Solver(Z3_mk_solver_for_logic(ctx.ref(), logic), ctx, logFile)
7708def SimpleSolver(ctx=None, logFile=None):
7709 """Return a simple general purpose solver with limited amount of preprocessing.
7711 >>> s = SimpleSolver()
7718 return Solver(Z3_mk_simple_solver(ctx.ref()), ctx, logFile)
7720#########################################
7724#########################################
7727class Fixedpoint(Z3PPObject):
7728 """Fixedpoint API provides methods for solving with recursive predicates"""
7730 def __init__(self, fixedpoint=None, ctx=None):
7731 assert fixedpoint is None or ctx is not None
7732 self.ctx = _get_ctx(ctx)
7733 self.fixedpoint = None
7734 if fixedpoint is None:
7735 self.fixedpoint = Z3_mk_fixedpoint(self.ctx.ref())
7737 self.fixedpoint = fixedpoint
7738 Z3_fixedpoint_inc_ref(self.ctx.ref(), self.fixedpoint)
7741 def __deepcopy__(self, memo={}):
7742 return FixedPoint(self.fixedpoint, self.ctx)
7745 if self.fixedpoint is not None and self.ctx.ref() is not None and Z3_fixedpoint_dec_ref is not None:
7746 Z3_fixedpoint_dec_ref(self.ctx.ref(), self.fixedpoint)
7748 def set(self, *args, **keys):
7749 """Set a configuration option. The method `help()` return a string containing all available options.
7751 p = args2params(args, keys, self.ctx)
7752 Z3_fixedpoint_set_params(self.ctx.ref(), self.fixedpoint, p.params)
7755 """Display a string describing all available options."""
7756 print(Z3_fixedpoint_get_help(self.ctx.ref(), self.fixedpoint))
7758 def param_descrs(self):
7759 """Return the parameter description set."""
7760 return ParamDescrsRef(Z3_fixedpoint_get_param_descrs(self.ctx.ref(), self.fixedpoint), self.ctx)
7762 def assert_exprs(self, *args):
7763 """Assert constraints as background axioms for the fixedpoint solver."""
7764 args = _get_args(args)
7765 s = BoolSort(self.ctx)
7767 if isinstance(arg, Goal) or isinstance(arg, AstVector):
7769 f = self.abstract(f)
7770 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, f.as_ast())
7773 arg = self.abstract(arg)
7774 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, arg.as_ast())
7776 def add(self, *args):
7777 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7778 self.assert_exprs(*args)
7780 def __iadd__(self, fml):
7784 def append(self, *args):
7785 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7786 self.assert_exprs(*args)
7788 def insert(self, *args):
7789 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7790 self.assert_exprs(*args)
7792 def add_rule(self, head, body=None, name=None):
7793 """Assert rules defining recursive predicates to the fixedpoint solver.
7796 >>> s = Fixedpoint()
7797 >>> s.register_relation(a.decl())
7798 >>> s.register_relation(b.decl())
7806 name = to_symbol(name, self.ctx)
7808 head = self.abstract(head)
7809 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, head.as_ast(), name)
7811 body = _get_args(body)
7812 f = self.abstract(Implies(And(body, self.ctx), head))
7813 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7815 def rule(self, head, body=None, name=None):
7816 """Assert rules defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7817 self.add_rule(head, body, name)
7819 def fact(self, head, name=None):
7820 """Assert facts defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7821 self.add_rule(head, None, name)
7823 def query(self, *query):
7824 """Query the fixedpoint engine whether formula is derivable.
7825 You can also pass an tuple or list of recursive predicates.
7827 query = _get_args(query)
7829 if sz >= 1 and isinstance(query[0], FuncDeclRef):
7830 _decls = (FuncDecl * sz)()
7835 r = Z3_fixedpoint_query_relations(self.ctx.ref(), self.fixedpoint, sz, _decls)
7840 query = And(query, self.ctx)
7841 query = self.abstract(query, False)
7842 r = Z3_fixedpoint_query(self.ctx.ref(), self.fixedpoint, query.as_ast())
7843 return CheckSatResult(r)
7845 def query_from_lvl(self, lvl, *query):
7846 """Query the fixedpoint engine whether formula is derivable starting at the given query level.
7848 query = _get_args(query)
7850 if sz >= 1 and isinstance(query[0], FuncDecl):
7851 _z3_assert(False, "unsupported")
7857 query = self.abstract(query, False)
7858 r = Z3_fixedpoint_query_from_lvl(self.ctx.ref(), self.fixedpoint, query.as_ast(), lvl)
7859 return CheckSatResult(r)
7861 def update_rule(self, head, body, name):
7865 name = to_symbol(name, self.ctx)
7866 body = _get_args(body)
7867 f = self.abstract(Implies(And(body, self.ctx), head))
7868 Z3_fixedpoint_update_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7870 def get_answer(self):
7871 """Retrieve answer from last query call."""
7872 r = Z3_fixedpoint_get_answer(self.ctx.ref(), self.fixedpoint)
7873 return _to_expr_ref(r, self.ctx)
7875 def get_ground_sat_answer(self):
7876 """Retrieve a ground cex from last query call."""
7877 r = Z3_fixedpoint_get_ground_sat_answer(self.ctx.ref(), self.fixedpoint)
7878 return _to_expr_ref(r, self.ctx)
7880 def get_rules_along_trace(self):
7881 """retrieve rules along the counterexample trace"""
7882 return AstVector(Z3_fixedpoint_get_rules_along_trace(self.ctx.ref(), self.fixedpoint), self.ctx)
7884 def get_rule_names_along_trace(self):
7885 """retrieve rule names along the counterexample trace"""
7886 # this is a hack as I don't know how to return a list of symbols from C++;
7887 # obtain names as a single string separated by semicolons
7888 names = _symbol2py(self.ctx, Z3_fixedpoint_get_rule_names_along_trace(self.ctx.ref(), self.fixedpoint))
7889 # split into individual names
7890 return names.split(";")
7892 def get_num_levels(self, predicate):
7893 """Retrieve number of levels used for predicate in PDR engine"""
7894 return Z3_fixedpoint_get_num_levels(self.ctx.ref(), self.fixedpoint, predicate.ast)
7896 def get_cover_delta(self, level, predicate):
7897 """Retrieve properties known about predicate for the level'th unfolding.
7898 -1 is treated as the limit (infinity)
7900 r = Z3_fixedpoint_get_cover_delta(self.ctx.ref(), self.fixedpoint, level, predicate.ast)
7901 return _to_expr_ref(r, self.ctx)
7903 def add_cover(self, level, predicate, property):
7904 """Add property to predicate for the level'th unfolding.
7905 -1 is treated as infinity (infinity)
7907 Z3_fixedpoint_add_cover(self.ctx.ref(), self.fixedpoint, level, predicate.ast, property.ast)
7909 def register_relation(self, *relations):
7910 """Register relation as recursive"""
7911 relations = _get_args(relations)
7913 Z3_fixedpoint_register_relation(self.ctx.ref(), self.fixedpoint, f.ast)
7915 def set_predicate_representation(self, f, *representations):
7916 """Control how relation is represented"""
7917 representations = _get_args(representations)
7918 representations = [to_symbol(s) for s in representations]
7919 sz = len(representations)
7920 args = (Symbol * sz)()
7922 args[i] = representations[i]
7923 Z3_fixedpoint_set_predicate_representation(self.ctx.ref(), self.fixedpoint, f.ast, sz, args)
7925 def parse_string(self, s):
7926 """Parse rules and queries from a string"""
7927 return AstVector(Z3_fixedpoint_from_string(self.ctx.ref(), self.fixedpoint, s), self.ctx)
7929 def parse_file(self, f):
7930 """Parse rules and queries from a file"""
7931 return AstVector(Z3_fixedpoint_from_file(self.ctx.ref(), self.fixedpoint, f), self.ctx)
7933 def get_rules(self):
7934 """retrieve rules that have been added to fixedpoint context"""
7935 return AstVector(Z3_fixedpoint_get_rules(self.ctx.ref(), self.fixedpoint), self.ctx)
7937 def get_assertions(self):
7938 """retrieve assertions that have been added to fixedpoint context"""
7939 return AstVector(Z3_fixedpoint_get_assertions(self.ctx.ref(), self.fixedpoint), self.ctx)
7942 """Return a formatted string with all added rules and constraints."""
7946 """Return a formatted string (in Lisp-like format) with all added constraints.
7947 We say the string is in s-expression format.
7949 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, 0, (Ast * 0)())
7951 def to_string(self, queries):
7952 """Return a formatted string (in Lisp-like format) with all added constraints.
7953 We say the string is in s-expression format.
7954 Include also queries.
7956 args, len = _to_ast_array(queries)
7957 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, len, args)
7959 def statistics(self):
7960 """Return statistics for the last `query()`.
7962 return Statistics(Z3_fixedpoint_get_statistics(self.ctx.ref(), self.fixedpoint), self.ctx)
7964 def reason_unknown(self):
7965 """Return a string describing why the last `query()` returned `unknown`.
7967 return Z3_fixedpoint_get_reason_unknown(self.ctx.ref(), self.fixedpoint)
7969 def declare_var(self, *vars):
7970 """Add variable or several variables.
7971 The added variable or variables will be bound in the rules
7974 vars = _get_args(vars)
7978 def abstract(self, fml, is_forall=True):
7982 return ForAll(self.vars, fml)
7984 return Exists(self.vars, fml)
7987#########################################
7991#########################################
7993class FiniteDomainSortRef(SortRef):
7994 """Finite domain sort."""
7997 """Return the size of the finite domain sort"""
7998 r = (ctypes.c_ulonglong * 1)()
7999 if Z3_get_finite_domain_sort_size(self.ctx_ref(), self.ast, r):
8002 raise Z3Exception("Failed to retrieve finite domain sort size")
8005def FiniteDomainSort(name, sz, ctx=None):
8006 """Create a named finite domain sort of a given size sz"""
8007 if not isinstance(name, Symbol):
8008 name = to_symbol(name)
8010 return FiniteDomainSortRef(Z3_mk_finite_domain_sort(ctx.ref(), name, sz), ctx)
8013def is_finite_domain_sort(s):
8014 """Return True if `s` is a Z3 finite-domain sort.
8016 >>> is_finite_domain_sort(FiniteDomainSort('S', 100))
8018 >>> is_finite_domain_sort(IntSort())
8021 return isinstance(s, FiniteDomainSortRef)
8024class FiniteDomainRef(ExprRef):
8025 """Finite-domain expressions."""
8028 """Return the sort of the finite-domain expression `self`."""
8029 return FiniteDomainSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
8031 def as_string(self):
8032 """Return a Z3 floating point expression as a Python string."""
8033 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
8036def is_finite_domain(a):
8037 """Return `True` if `a` is a Z3 finite-domain expression.
8039 >>> s = FiniteDomainSort('S', 100)
8040 >>> b = Const('b', s)
8041 >>> is_finite_domain(b)
8043 >>> is_finite_domain(Int('x'))
8046 return isinstance(a, FiniteDomainRef)
8049class FiniteDomainNumRef(FiniteDomainRef):
8050 """Integer values."""
8053 """Return a Z3 finite-domain numeral as a Python long (bignum) numeral.
8055 >>> s = FiniteDomainSort('S', 100)
8056 >>> v = FiniteDomainVal(3, s)
8062 return int(self.as_string())
8064 def as_string(self):
8065 """Return a Z3 finite-domain numeral as a Python string.
8067 >>> s = FiniteDomainSort('S', 100)
8068 >>> v = FiniteDomainVal(42, s)
8072 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
8075def FiniteDomainVal(val, sort, ctx=None):
8076 """Return a Z3 finite-domain value. If `ctx=None`, then the global context is used.
8078 >>> s = FiniteDomainSort('S', 256)
8079 >>> FiniteDomainVal(255, s)
8081 >>> FiniteDomainVal('100', s)
8085 _z3_assert(is_finite_domain_sort(sort), "Expected finite-domain sort")
8087 return FiniteDomainNumRef(Z3_mk_numeral(ctx.ref(), _to_int_str(val), sort.ast), ctx)
8090def is_finite_domain_value(a):
8091 """Return `True` if `a` is a Z3 finite-domain value.
8093 >>> s = FiniteDomainSort('S', 100)
8094 >>> b = Const('b', s)
8095 >>> is_finite_domain_value(b)
8097 >>> b = FiniteDomainVal(10, s)
8100 >>> is_finite_domain_value(b)
8103 return is_finite_domain(a) and _is_numeral(a.ctx, a.as_ast())
8106#########################################
8110#########################################
8112class OptimizeObjective:
8113 def __init__(self, opt, value, is_max):
8116 self._is_max = is_max
8120 return _to_expr_ref(Z3_optimize_get_lower(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8124 return _to_expr_ref(Z3_optimize_get_upper(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8126 def lower_values(self):
8128 return AstVector(Z3_optimize_get_lower_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8130 def upper_values(self):
8132 return AstVector(Z3_optimize_get_upper_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8141 return "%s:%s" % (self._value, self._is_max)
8147def _global_on_model(ctx):
8148 (fn, mdl) = _on_models[ctx]
8152_on_model_eh = on_model_eh_type(_global_on_model)
8155class Optimize(Z3PPObject):
8156 """Optimize API provides methods for solving using objective functions and weighted soft constraints"""
8158 def __init__(self, optimize=None, ctx=None):
8159 self.ctx = _get_ctx(ctx)
8160 if optimize is None:
8161 self.optimize = Z3_mk_optimize(self.ctx.ref())
8163 self.optimize = optimize
8164 self._on_models_id = None
8165 Z3_optimize_inc_ref(self.ctx.ref(), self.optimize)
8167 def __deepcopy__(self, memo={}):
8168 return Optimize(self.optimize, self.ctx)
8171 if self.optimize is not None and self.ctx.ref() is not None and Z3_optimize_dec_ref is not None:
8172 Z3_optimize_dec_ref(self.ctx.ref(), self.optimize)
8173 if self._on_models_id is not None:
8174 del _on_models[self._on_models_id]
8176 def __enter__(self):
8180 def __exit__(self, *exc_info):
8183 def set(self, *args, **keys):
8184 """Set a configuration option.
8185 The method `help()` return a string containing all available options.
8187 p = args2params(args, keys, self.ctx)
8188 Z3_optimize_set_params(self.ctx.ref(), self.optimize, p.params)
8191 """Display a string describing all available options."""
8192 print(Z3_optimize_get_help(self.ctx.ref(), self.optimize))
8194 def param_descrs(self):
8195 """Return the parameter description set."""
8196 return ParamDescrsRef(Z3_optimize_get_param_descrs(self.ctx.ref(), self.optimize), self.ctx)
8198 def assert_exprs(self, *args):
8199 """Assert constraints as background axioms for the optimize solver."""
8200 args = _get_args(args)
8201 s = BoolSort(self.ctx)
8203 if isinstance(arg, Goal) or isinstance(arg, AstVector):
8205 Z3_optimize_assert(self.ctx.ref(), self.optimize, f.as_ast())
8208 Z3_optimize_assert(self.ctx.ref(), self.optimize, arg.as_ast())
8210 def add(self, *args):
8211 """Assert constraints as background axioms for the optimize solver. Alias for assert_expr."""
8212 self.assert_exprs(*args)
8214 def __iadd__(self, fml):
8218 def assert_and_track(self, a, p):
8219 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
8221 If `p` is a string, it will be automatically converted into a Boolean constant.
8226 >>> s.assert_and_track(x > 0, 'p1')
8227 >>> s.assert_and_track(x != 1, 'p2')
8228 >>> s.assert_and_track(x < 0, p3)
8229 >>> print(s.check())
8231 >>> c = s.unsat_core()
8241 if isinstance(p, str):
8242 p = Bool(p, self.ctx)
8243 _z3_assert(isinstance(a, BoolRef), "Boolean expression expected")
8244 _z3_assert(isinstance(p, BoolRef) and is_const(p), "Boolean expression expected")
8245 Z3_optimize_assert_and_track(self.ctx.ref(), self.optimize, a.as_ast(), p.as_ast())
8247 def add_soft(self, arg, weight="1", id=None):
8248 """Add soft constraint with optional weight and optional identifier.
8249 If no weight is supplied, then the penalty for violating the soft constraint
8251 Soft constraints are grouped by identifiers. Soft constraints that are
8252 added without identifiers are grouped by default.
8255 weight = "%d" % weight
8256 elif isinstance(weight, float):
8257 weight = "%f" % weight
8258 if not isinstance(weight, str):
8259 raise Z3Exception("weight should be a string or an integer")
8262 id = to_symbol(id, self.ctx)
8265 v = Z3_optimize_assert_soft(self.ctx.ref(), self.optimize, a.as_ast(), weight, id)
8266 return OptimizeObjective(self, v, False)
8267 if sys.version_info.major >= 3 and isinstance(arg, Iterable):
8268 return [asoft(a) for a in arg]
8271 def set_initial_value(self, var, value):
8272 """initialize the solver's state by setting the initial value of var to value
8275 value = s.cast(value)
8276 Z3_optimize_set_initial_value(self.ctx.ref(), self.optimize, var.ast, value.ast)
8278 def maximize(self, arg):
8279 """Add objective function to maximize."""
8280 return OptimizeObjective(
8282 Z3_optimize_maximize(self.ctx.ref(), self.optimize, arg.as_ast()),
8286 def minimize(self, arg):
8287 """Add objective function to minimize."""
8288 return OptimizeObjective(
8290 Z3_optimize_minimize(self.ctx.ref(), self.optimize, arg.as_ast()),
8295 """create a backtracking point for added rules, facts and assertions"""
8296 Z3_optimize_push(self.ctx.ref(), self.optimize)
8299 """restore to previously created backtracking point"""
8300 Z3_optimize_pop(self.ctx.ref(), self.optimize)
8302 def check(self, *assumptions):
8303 """Check consistency and produce optimal values."""
8304 assumptions = _get_args(assumptions)
8305 num = len(assumptions)
8306 _assumptions = (Ast * num)()
8307 for i in range(num):
8308 _assumptions[i] = assumptions[i].as_ast()
8309 return CheckSatResult(Z3_optimize_check(self.ctx.ref(), self.optimize, num, _assumptions))
8311 def reason_unknown(self):
8312 """Return a string that describes why the last `check()` returned `unknown`."""
8313 return Z3_optimize_get_reason_unknown(self.ctx.ref(), self.optimize)
8316 """Return a model for the last check()."""
8318 return ModelRef(Z3_optimize_get_model(self.ctx.ref(), self.optimize), self.ctx)
8320 raise Z3Exception("model is not available")
8322 def unsat_core(self):
8323 return AstVector(Z3_optimize_get_unsat_core(self.ctx.ref(), self.optimize), self.ctx)
8325 def lower(self, obj):
8326 if not isinstance(obj, OptimizeObjective):
8327 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8330 def upper(self, obj):
8331 if not isinstance(obj, OptimizeObjective):
8332 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8335 def lower_values(self, obj):
8336 if not isinstance(obj, OptimizeObjective):
8337 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8338 return obj.lower_values()
8340 def upper_values(self, obj):
8341 if not isinstance(obj, OptimizeObjective):
8342 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8343 return obj.upper_values()
8345 def from_file(self, filename):
8346 """Parse assertions and objectives from a file"""
8347 Z3_optimize_from_file(self.ctx.ref(), self.optimize, filename)
8349 def from_string(self, s):
8350 """Parse assertions and objectives from a string"""
8351 Z3_optimize_from_string(self.ctx.ref(), self.optimize, s)
8353 def assertions(self):
8354 """Return an AST vector containing all added constraints."""
8355 return AstVector(Z3_optimize_get_assertions(self.ctx.ref(), self.optimize), self.ctx)
8357 def objectives(self):
8358 """returns set of objective functions"""
8359 return AstVector(Z3_optimize_get_objectives(self.ctx.ref(), self.optimize), self.ctx)
8362 """Return a formatted string with all added rules and constraints."""
8366 """Return a formatted string (in Lisp-like format) with all added constraints.
8367 We say the string is in s-expression format.
8369 return Z3_optimize_to_string(self.ctx.ref(), self.optimize)
8371 def statistics(self):
8372 """Return statistics for the last check`.
8374 return Statistics(Z3_optimize_get_statistics(self.ctx.ref(), self.optimize), self.ctx)
8376 def set_on_model(self, on_model):
8377 """Register a callback that is invoked with every incremental improvement to
8378 objective values. The callback takes a model as argument.
8379 The life-time of the model is limited to the callback so the
8380 model has to be (deep) copied if it is to be used after the callback
8382 id = len(_on_models) + 41
8383 mdl = Model(self.ctx)
8384 _on_models[id] = (on_model, mdl)
8385 self._on_models_id = id
8386 Z3_optimize_register_model_eh(
8387 self.ctx.ref(), self.optimize, mdl.model, ctypes.c_void_p(id), _on_model_eh,
8391#########################################
8395#########################################
8396class ApplyResult(Z3PPObject):
8397 """An ApplyResult object contains the subgoals produced by a tactic when applied to a goal.
8398 It also contains model and proof converters.
8401 def __init__(self, result, ctx):
8402 self.result = result
8404 Z3_apply_result_inc_ref(self.ctx.ref(), self.result)
8406 def __deepcopy__(self, memo={}):
8407 return ApplyResult(self.result, self.ctx)
8410 if self.ctx.ref() is not None and Z3_apply_result_dec_ref is not None:
8411 Z3_apply_result_dec_ref(self.ctx.ref(), self.result)
8414 """Return the number of subgoals in `self`.
8416 >>> a, b = Ints('a b')
8418 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8419 >>> t = Tactic('split-clause')
8423 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
8426 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
8430 return int(Z3_apply_result_get_num_subgoals(self.ctx.ref(), self.result))
8432 def __getitem__(self, idx):
8433 """Return one of the subgoals stored in ApplyResult object `self`.
8435 >>> a, b = Ints('a b')
8437 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8438 >>> t = Tactic('split-clause')
8441 [a == 0, Or(b == 0, b == 1), a > b]
8443 [a == 1, Or(b == 0, b == 1), a > b]
8447 if idx < 0 or idx >= len(self):
8449 return Goal(goal=Z3_apply_result_get_subgoal(self.ctx.ref(), self.result, idx), ctx=self.ctx)
8452 return obj_to_string(self)
8455 """Return a textual representation of the s-expression representing the set of subgoals in `self`."""
8456 return Z3_apply_result_to_string(self.ctx.ref(), self.result)
8459 """Return a Z3 expression consisting of all subgoals.
8464 >>> g.add(Or(x == 2, x == 3))
8465 >>> r = Tactic('simplify')(g)
8467 [[Not(x <= 1), Or(x == 2, x == 3)]]
8469 And(Not(x <= 1), Or(x == 2, x == 3))
8470 >>> r = Tactic('split-clause')(g)
8472 [[x > 1, x == 2], [x > 1, x == 3]]
8474 Or(And(x > 1, x == 2), And(x > 1, x == 3))
8478 return BoolVal(False, self.ctx)
8480 return self[0].as_expr()
8482 return Or([self[i].as_expr() for i in range(len(self))])
8484#########################################
8488#########################################
8491 """Simplifiers act as pre-processing utilities for solvers.
8492 Build a custom simplifier and add it to a solve
r"""
8494 def __init__(self, simplifier, ctx=None):
8495 self.ctx = _get_ctx(ctx)
8496 self.simplifier = None
8497 if isinstance(simplifier, SimplifierObj):
8498 self.simplifier = simplifier
8499 elif isinstance(simplifier, list):
8500 simps = [Simplifier(s, ctx) for s in simplifier]
8501 self.simplifier = simps[0].simplifier
8502 for i in range(1, len(simps)):
8503 self.simplifier = Z3_simplifier_and_then(self.ctx.ref(), self.simplifier, simps[i].simplifier)
8504 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8508 _z3_assert(isinstance(simplifier, str), "simplifier name expected")
8510 self.simplifier = Z3_mk_simplifier(self.ctx.ref(), str(simplifier))
8512 raise Z3Exception("unknown simplifier '%s'" % simplifier)
8513 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8515 def __deepcopy__(self, memo={}):
8516 return Simplifier(self.simplifier, self.ctx)
8519 if self.simplifier is not None and self.ctx.ref() is not None and Z3_simplifier_dec_ref is not None:
8520 Z3_simplifier_dec_ref(self.ctx.ref(), self.simplifier)
8522 def using_params(self, *args, **keys):
8523 """Return a simplifier that uses the given configuration options"""
8524 p = args2params(args, keys, self.ctx)
8525 return Simplifier(Z3_simplifier_using_params(self.ctx.ref(), self.simplifier, p.params), self.ctx)
8527 def add(self, solver):
8528 """Return a solver that applies the simplification pre-processing specified by the simplifie
r"""
8529 return Solver(Z3_solver_add_simplifier(self.ctx.ref(), solver.solver, self.simplifier), self.ctx)
8532 """Display a string containing a description of the available options for the `self` simplifier."""
8533 print(Z3_simplifier_get_help(self.ctx.ref(), self.simplifier))
8535 def param_descrs(self):
8536 """Return the parameter description set."""
8537 return ParamDescrsRef(Z3_simplifier_get_param_descrs(self.ctx.ref(), self.simplifier), self.ctx)
8540#########################################
8544#########################################
8548 """Tactics transform, solver and/or simplify sets of constraints (Goal).
8549 A Tactic can be converted into a Solver using the method solver().
8551 Several combinators are available for creating new tactics using the built-in ones:
8552 Then(), OrElse(), FailIf(), Repeat(), When(), Cond().
8555 def __init__(self, tactic, ctx=None):
8556 self.ctx = _get_ctx(ctx)
8558 if isinstance(tactic, TacticObj):
8559 self.tactic = tactic
8562 _z3_assert(isinstance(tactic, str), "tactic name expected")
8564 self.tactic = Z3_mk_tactic(self.ctx.ref(), str(tactic))
8566 raise Z3Exception("unknown tactic '%s'" % tactic)
8567 Z3_tactic_inc_ref(self.ctx.ref(), self.tactic)
8569 def __deepcopy__(self, memo={}):
8570 return Tactic(self.tactic, self.ctx)
8573 if self.tactic is not None and self.ctx.ref() is not None and Z3_tactic_dec_ref is not None:
8574 Z3_tactic_dec_ref(self.ctx.ref(), self.tactic)
8576 def solver(self, logFile=None):
8577 """Create a solver using the tactic `self`.
8579 The solver supports the methods `push()` and `pop()`, but it
8580 will always solve each `check()` from scratch.
8582 >>> t = Then('simplify', 'nlsat')
8585 >>> s.add(x**2 == 2, x > 0)
8591 return Solver(Z3_mk_solver_from_tactic(self.ctx.ref(), self.tactic), self.ctx, logFile)
8593 def apply(self, goal, *arguments, **keywords):
8594 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8596 >>> x, y = Ints('x y')
8597 >>> t = Tactic('solve-eqs')
8598 >>> t.apply(And(x == 0, y >= x + 1))
8602 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expressions expected")
8603 goal = _to_goal(goal)
8604 if len(arguments) > 0 or len(keywords) > 0:
8605 p = args2params(arguments, keywords, self.ctx)
8606 return ApplyResult(Z3_tactic_apply_ex(self.ctx.ref(), self.tactic, goal.goal, p.params), self.ctx)
8608 return ApplyResult(Z3_tactic_apply(self.ctx.ref(), self.tactic, goal.goal), self.ctx)
8610 def __call__(self, goal, *arguments, **keywords):
8611 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8613 >>> x, y = Ints('x y')
8614 >>> t = Tactic('solve-eqs')
8615 >>> t(And(x == 0, y >= x + 1))
8618 return self.apply(goal, *arguments, **keywords)
8621 """Display a string containing a description of the available options for the `self` tactic."""
8622 print(Z3_tactic_get_help(self.ctx.ref(), self.tactic))
8624 def param_descrs(self):
8625 """Return the parameter description set."""
8626 return ParamDescrsRef(Z3_tactic_get_param_descrs(self.ctx.ref(), self.tactic), self.ctx)
8630 if isinstance(a, BoolRef):
8631 goal = Goal(ctx=a.ctx)
8638def _to_tactic(t, ctx=None):
8639 if isinstance(t, Tactic):
8642 return Tactic(t, ctx)
8645def _and_then(t1, t2, ctx=None):
8646 t1 = _to_tactic(t1, ctx)
8647 t2 = _to_tactic(t2, ctx)
8649 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8650 return Tactic(Z3_tactic_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8653def _or_else(t1, t2, ctx=None):
8654 t1 = _to_tactic(t1, ctx)
8655 t2 = _to_tactic(t2, ctx)
8657 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8658 return Tactic(Z3_tactic_or_else(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8661def AndThen(*ts, **ks):
8662 """Return a tactic that applies the tactics in `*ts` in sequence.
8664 >>> x, y = Ints('x y')
8665 >>> t = AndThen(Tactic('simplify'), Tactic('solve-eqs'))
8666 >>> t(And(x == 0, y > x + 1))
8668 >>> t(And(x == 0, y > x + 1)).as_expr()
8672 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8673 ctx = ks.get("ctx", None)
8676 for i in range(num - 1):
8677 r = _and_then(r, ts[i + 1], ctx)
8682 """Return a tactic that applies the tactics in `*ts` in sequence. Shorthand for AndThen(*ts, **ks).
8684 >>> x, y = Ints('x y')
8685 >>> t = Then(Tactic('simplify'), Tactic('solve-eqs'))
8686 >>> t(And(x == 0, y > x + 1))
8688 >>> t(And(x == 0, y > x + 1)).as_expr()
8691 return AndThen(*ts, **ks)
8694def OrElse(*ts, **ks):
8695 """Return a tactic that applies the tactics in `*ts` until one of them succeeds (it doesn't fail).
8698 >>> t = OrElse(Tactic('split-clause'), Tactic('skip'))
8699 >>> # Tactic split-clause fails if there is no clause in the given goal.
8702 >>> t(Or(x == 0, x == 1))
8703 [[x == 0], [x == 1]]
8706 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8707 ctx = ks.get("ctx", None)
8710 for i in range(num - 1):
8711 r = _or_else(r, ts[i + 1], ctx)
8715def ParOr(*ts, **ks):
8716 """Return a tactic that applies the tactics in `*ts` in parallel until one of them succeeds (it doesn't fail).
8719 >>> t = ParOr(Tactic('simplify'), Tactic('fail'))
8724 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8725 ctx = _get_ctx(ks.get("ctx", None))
8726 ts = [_to_tactic(t, ctx) for t in ts]
8728 _args = (TacticObj * sz)()
8730 _args[i] = ts[i].tactic
8731 return Tactic(Z3_tactic_par_or(ctx.ref(), sz, _args), ctx)
8734def ParThen(t1, t2, ctx=None):
8735 """Return a tactic that applies t1 and then t2 to every subgoal produced by t1.
8736 The subgoals are processed in parallel.
8738 >>> x, y = Ints('x y')
8739 >>> t = ParThen(Tactic('split-clause'), Tactic('propagate-values'))
8740 >>> t(And(Or(x == 1, x == 2), y == x + 1))
8741 [[x == 1, y == 2], [x == 2, y == 3]]
8743 t1 = _to_tactic(t1, ctx)
8744 t2 = _to_tactic(t2, ctx)
8746 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8747 return Tactic(Z3_tactic_par_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8750def ParAndThen(t1, t2, ctx=None):
8751 """Alias for ParThen(t1, t2, ctx)."""
8752 return ParThen(t1, t2, ctx)
8755def With(t, *args, **keys):
8756 """Return a tactic that applies tactic `t` using the given configuration options.
8758 >>> x, y = Ints('x y')
8759 >>> t = With(Tactic('simplify'), som=True)
8760 >>> t((x + 1)*(y + 2) == 0)
8761 [[2*x + y + x*y == -2]]
8763 ctx = keys.pop("ctx", None)
8764 t = _to_tactic(t, ctx)
8765 p = args2params(args, keys, t.ctx)
8766 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8769def WithParams(t, p):
8770 """Return a tactic that applies tactic `t` using the given configuration options.
8772 >>> x, y = Ints('x y')
8774 >>> p.set("som", True)
8775 >>> t = WithParams(Tactic('simplify'), p)
8776 >>> t((x + 1)*(y + 2) == 0)
8777 [[2*x + y + x*y == -2]]
8779 t = _to_tactic(t, None)
8780 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8783def Repeat(t, max=4294967295, ctx=None):
8784 """Return a tactic that keeps applying `t` until the goal is not modified anymore
8785 or the maximum number of iterations `max` is reached.
8787 >>> x, y = Ints('x y')
8788 >>> c = And(Or(x == 0, x == 1), Or(y == 0, y == 1), x > y)
8789 >>> t = Repeat(OrElse(Tactic('split-clause'), Tactic('skip')))
8791 >>> for subgoal in r: print(subgoal)
8792 [x == 0, y == 0, x > y]
8793 [x == 0, y == 1, x > y]
8794 [x == 1, y == 0, x > y]
8795 [x == 1, y == 1, x > y]
8796 >>> t = Then(t, Tactic('propagate-values'))
8800 t = _to_tactic(t, ctx)
8801 return Tactic(Z3_tactic_repeat(t.ctx.ref(), t.tactic, max), t.ctx)
8804def TryFor(t, ms, ctx=None):
8805 """Return a tactic that applies `t` to a given goal for `ms` milliseconds.
8807 If `t` does not terminate in `ms` milliseconds, then it fails.
8809 t = _to_tactic(t, ctx)
8810 return Tactic(Z3_tactic_try_for(t.ctx.ref(), t.tactic, ms), t.ctx)
8813def tactics(ctx=None):
8814 """Return a list of all available tactics in Z3.
8817 >>> l.count('simplify') == 1
8821 return [Z3_get_tactic_name(ctx.ref(), i) for i in range(Z3_get_num_tactics(ctx.ref()))]
8824def tactic_description(name, ctx=None):
8825 """Return a short description for the tactic named `name`.
8827 >>> d = tactic_description('simplify')
8830 return Z3_tactic_get_descr(ctx.ref(), name)
8833def describe_tactics():
8834 """Display a (tabular) description of all available tactics in Z3."""
8837 print('<table border="1" cellpadding="2" cellspacing="0">')
8840 print('<tr style="background-color:#CFCFCF">')
8845 print("<td>%s</td><td>%s</td></tr>" % (t, insert_line_breaks(tactic_description(t), 40)))
8849 print("%s : %s" % (t, tactic_description(t)))
8853 """Probes are used to inspect a goal (aka problem) and collect information that may be used
8854 to decide which solver and/or preprocessing step will be used.
8857 def __init__(self, probe, ctx=None):
8858 self.ctx = _get_ctx(ctx)
8860 if isinstance(probe, ProbeObj):
8862 elif isinstance(probe, float):
8863 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8864 elif _is_int(probe):
8865 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8866 elif isinstance(probe, bool):
8868 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8870 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8873 _z3_assert(isinstance(probe, str), "probe name expected")
8875 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8877 raise Z3Exception("unknown probe '%s'" % probe)
8878 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8880 def __deepcopy__(self, memo={}):
8881 return Probe(self.probe, self.ctx)
8884 if self.probe is not None and self.ctx.ref() is not None and Z3_probe_dec_ref is not None:
8885 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8887 def __lt__(self, other):
8888 """Return a probe that evaluates to "true" when the value returned by `self`
8889 is less than the value returned by `other`.
8891 >>> p = Probe('size') < 10
8899 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8901 def __gt__(self, other):
8902 """Return a probe that evaluates to "true" when the value returned by `self`
8903 is greater than the value returned by `other`.
8905 >>> p = Probe('size') > 10
8913 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8915 def __le__(self, other):
8916 """Return a probe that evaluates to "true" when the value returned by `self`
8917 is less than or equal to the value returned by `other`.
8919 >>> p = Probe('size') <= 2
8927 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8929 def __ge__(self, other):
8930 """Return a probe that evaluates to "true" when the value returned by `self`
8931 is greater than or equal to the value returned by `other`.
8933 >>> p = Probe('size') >= 2
8941 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8943 def __eq__(self, other):
8944 """Return a probe that evaluates to "true" when the value returned by `self`
8945 is equal to the value returned by `other`.
8947 >>> p = Probe('size') == 2
8955 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8957 def __ne__(self, other):
8958 """Return a probe that evaluates to "true" when the value returned by `self`
8959 is not equal to the value returned by `other`.
8961 >>> p = Probe('size') != 2
8969 p = self.__eq__(other)
8970 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8972 def __call__(self, goal):
8973 """Evaluate the probe `self` in the given goal.
8975 >>> p = Probe('size')
8985 >>> p = Probe('num-consts')
8988 >>> p = Probe('is-propositional')
8991 >>> p = Probe('is-qflia')
8996 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
8997 goal = _to_goal(goal)
8998 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
9002 """Return `True` if `p` is a Z3 probe.
9004 >>> is_probe(Int('x'))
9006 >>> is_probe(Probe('memory'))
9009 return isinstance(p, Probe)
9012def _to_probe(p, ctx=None):
9016 return Probe(p, ctx)
9019def probes(ctx=None):
9020 """Return a list of all available probes in Z3.
9023 >>> l.count('memory') == 1
9027 return [Z3_get_probe_name(ctx.ref(), i) for i in range(Z3_get_num_probes(ctx.ref()))]
9030def probe_description(name, ctx=None):
9031 """Return a short description for the probe named `name`.
9033 >>> d = probe_description('memory')
9036 return Z3_probe_get_descr(ctx.ref(), name)
9039def describe_probes():
9040 """Display a (tabular) description of all available probes in Z3."""
9043 print('<table border="1" cellpadding="2" cellspacing="0">')
9046 print('<tr style="background-color:#CFCFCF">')
9051 print("<td>%s</td><td>%s</td></tr>" % (p, insert_line_breaks(probe_description(p), 40)))
9055 print("%s : %s" % (p, probe_description(p)))
9058def _probe_nary(f, args, ctx):
9060 _z3_assert(len(args) > 0, "At least one argument expected")
9062 r = _to_probe(args[0], ctx)
9063 for i in range(num - 1):
9064 r = Probe(f(ctx.ref(), r.probe, _to_probe(args[i + 1], ctx).probe), ctx)
9068def _probe_and(args, ctx):
9069 return _probe_nary(Z3_probe_and, args, ctx)
9072def _probe_or(args, ctx):
9073 return _probe_nary(Z3_probe_or, args, ctx)
9076def FailIf(p, ctx=None):
9077 """Return a tactic that fails if the probe `p` evaluates to true.
9078 Otherwise, it returns the input goal unmodified.
9080 In the following example, the tactic applies 'simplify' if and only if there are
9081 more than 2 constraints in the goal.
9083 >>> t = OrElse(FailIf(Probe('size') > 2), Tactic('simplify'))
9084 >>> x, y = Ints('x y')
9090 >>> g.add(x == y + 1)
9092 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9094 p = _to_probe(p, ctx)
9095 return Tactic(Z3_tactic_fail_if(p.ctx.ref(), p.probe), p.ctx)
9098def When(p, t, ctx=None):
9099 """Return a tactic that applies tactic `t` only if probe `p` evaluates to true.
9100 Otherwise, it returns the input goal unmodified.
9102 >>> t = When(Probe('size') > 2, Tactic('simplify'))
9103 >>> x, y = Ints('x y')
9109 >>> g.add(x == y + 1)
9111 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9113 p = _to_probe(p, ctx)
9114 t = _to_tactic(t, ctx)
9115 return Tactic(Z3_tactic_when(t.ctx.ref(), p.probe, t.tactic), t.ctx)
9118def Cond(p, t1, t2, ctx=None):
9119 """Return a tactic that applies tactic `t1` to a goal if probe `p` evaluates to true, and `t2` otherwise.
9121 >>> t = Cond(Probe('is-qfnra'), Tactic('qfnra'), Tactic('smt'))
9123 p = _to_probe(p, ctx)
9124 t1 = _to_tactic(t1, ctx)
9125 t2 = _to_tactic(t2, ctx)
9126 return Tactic(Z3_tactic_cond(t1.ctx.ref(), p.probe, t1.tactic, t2.tactic), t1.ctx)
9128#########################################
9132#########################################
9135def simplify(a, *arguments, **keywords):
9136 """Simplify the expression `a` using the given options.
9138 This function has many options. Use `help_simplify` to obtain the complete list.
9142 >>> simplify(x + 1 + y + x + 1)
9144 >>> simplify((x + 1)*(y + 1), som=True)
9146 >>> simplify(Distinct(x, y, 1), blast_distinct=True)
9147 And(Not(x == y), Not(x == 1), Not(y == 1))
9148 >>> simplify(And(x == 0, y == 1), elim_and=True)
9149 Not(Or(Not(x == 0), Not(y == 1)))
9152 _z3_assert(is_expr(a), "Z3 expression expected")
9153 if len(arguments) > 0 or len(keywords) > 0:
9154 p = args2params(arguments, keywords, a.ctx)
9155 return _to_expr_ref(Z3_simplify_ex(a.ctx_ref(), a.as_ast(), p.params), a.ctx)
9157 return _to_expr_ref(Z3_simplify(a.ctx_ref(), a.as_ast()), a.ctx)
9161 """Return a string describing all options available for Z3 `simplify` procedure."""
9162 print(Z3_simplify_get_help(main_ctx().ref()))
9165def simplify_param_descrs():
9166 """Return the set of parameter descriptions for Z3 `simplify` procedure."""
9167 return ParamDescrsRef(Z3_simplify_get_param_descrs(main_ctx().ref()), main_ctx())
9170def substitute(t, *m):
9171 """Apply substitution m on t, m is a list of pairs of the form (from, to).
9172 Every occurrence in t of from is replaced with to.
9176 >>> substitute(x + 1, (x, y + 1))
9178 >>> f = Function('f', IntSort(), IntSort())
9179 >>> substitute(f(x) + f(y), (f(x), IntVal(1)), (f(y), IntVal(1)))
9182 if isinstance(m, tuple):
9184 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9187 _z3_assert(is_expr(t), "Z3 expression expected")
9189 all([isinstance(p, tuple) and is_expr(p[0]) and is_expr(p[1]) for p in m]),
9190 "Z3 invalid substitution, expression pairs expected.")
9192 all([p[0].sort().eq(p[1].sort()) for p in m]),
9193 'Z3 invalid substitution, mismatching "from" and "to" sorts.')
9195 _from = (Ast * num)()
9197 for i in range(num):
9198 _from[i] = m[i][0].as_ast()
9199 _to[i] = m[i][1].as_ast()
9200 return _to_expr_ref(Z3_substitute(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9203def substitute_vars(t, *m):
9204 """Substitute the free variables in t with the expression in m.
9206 >>> v0 = Var(0, IntSort())
9207 >>> v1 = Var(1, IntSort())
9209 >>> f = Function('f', IntSort(), IntSort(), IntSort())
9210 >>> # replace v0 with x+1 and v1 with x
9211 >>> substitute_vars(f(v0, v1), x + 1, x)
9215 _z3_assert(is_expr(t), "Z3 expression expected")
9216 _z3_assert(all([is_expr(n) for n in m]), "Z3 invalid substitution, list of expressions expected.")
9219 for i in range(num):
9220 _to[i] = m[i].as_ast()
9221 return _to_expr_ref(Z3_substitute_vars(t.ctx.ref(), t.as_ast(), num, _to), t.ctx)
9223def substitute_funs(t, *m):
9224 """Apply substitution m on t, m is a list of pairs of a function and expression (from, to)
9225 Every occurrence in to of the function from is replaced with the expression to.
9226 The expression to can have free variables, that refer to the arguments of from.
9229 if isinstance(m, tuple):
9231 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9234 _z3_assert(is_expr(t), "Z3 expression expected")
9235 _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.")
9237 _from = (FuncDecl * num)()
9239 for i in range(num):
9240 _from[i] = m[i][0].as_func_decl()
9241 _to[i] = m[i][1].as_ast()
9242 return _to_expr_ref(Z3_substitute_funs(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9246 """Create the sum of the Z3 expressions.
9248 >>> a, b, c = Ints('a b c')
9253 >>> A = IntVector('a', 5)
9255 a__0 + a__1 + a__2 + a__3 + a__4
9257 args = _get_args(args)
9260 ctx = _ctx_from_ast_arg_list(args)
9262 return _reduce(lambda a, b: a + b, args, 0)
9263 args = _coerce_expr_list(args, ctx)
9265 return _reduce(lambda a, b: a + b, args, 0)
9267 _args, sz = _to_ast_array(args)
9268 return ArithRef(Z3_mk_add(ctx.ref(), sz, _args), ctx)
9272 """Create the product of the Z3 expressions.
9274 >>> a, b, c = Ints('a b c')
9275 >>> Product(a, b, c)
9277 >>> Product([a, b, c])
9279 >>> A = IntVector('a', 5)
9281 a__0*a__1*a__2*a__3*a__4
9283 args = _get_args(args)
9286 ctx = _ctx_from_ast_arg_list(args)
9288 return _reduce(lambda a, b: a * b, args, 1)
9289 args = _coerce_expr_list(args, ctx)
9291 return _reduce(lambda a, b: a * b, args, 1)
9293 _args, sz = _to_ast_array(args)
9294 return ArithRef(Z3_mk_mul(ctx.ref(), sz, _args), ctx)
9297 """Create the absolute value of an arithmetic expression"""
9298 return If(arg > 0, arg, -arg)
9302 """Create an at-most Pseudo-Boolean k constraint.
9304 >>> a, b, c = Bools('a b c')
9305 >>> f = AtMost(a, b, c, 2)
9307 args = _get_args(args)
9309 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9310 ctx = _ctx_from_ast_arg_list(args)
9312 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9313 args1 = _coerce_expr_list(args[:-1], ctx)
9315 _args, sz = _to_ast_array(args1)
9316 return BoolRef(Z3_mk_atmost(ctx.ref(), sz, _args, k), ctx)
9320 """Create an at-least Pseudo-Boolean k constraint.
9322 >>> a, b, c = Bools('a b c')
9323 >>> f = AtLeast(a, b, c, 2)
9325 args = _get_args(args)
9327 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9328 ctx = _ctx_from_ast_arg_list(args)
9330 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9331 args1 = _coerce_expr_list(args[:-1], ctx)
9333 _args, sz = _to_ast_array(args1)
9334 return BoolRef(Z3_mk_atleast(ctx.ref(), sz, _args, k), ctx)
9337def _reorder_pb_arg(arg):
9339 if not _is_int(b) and _is_int(a):
9344def _pb_args_coeffs(args, default_ctx=None):
9345 args = _get_args_ast_list(args)
9347 return _get_ctx(default_ctx), 0, (Ast * 0)(), (ctypes.c_int * 0)()
9348 args = [_reorder_pb_arg(arg) for arg in args]
9349 args, coeffs = zip(*args)
9351 _z3_assert(len(args) > 0, "Non empty list of arguments expected")
9352 ctx = _ctx_from_ast_arg_list(args)
9354 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9355 args = _coerce_expr_list(args, ctx)
9356 _args, sz = _to_ast_array(args)
9357 _coeffs = (ctypes.c_int * len(coeffs))()
9358 for i in range(len(coeffs)):
9359 _z3_check_cint_overflow(coeffs[i], "coefficient")
9360 _coeffs[i] = coeffs[i]
9361 return ctx, sz, _args, _coeffs, args
9365 """Create a Pseudo-Boolean inequality k constraint.
9367 >>> a, b, c = Bools('a b c')
9368 >>> f = PbLe(((a,1),(b,3),(c,2)), 3)
9370 _z3_check_cint_overflow(k, "k")
9371 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9372 return BoolRef(Z3_mk_pble(ctx.ref(), sz, _args, _coeffs, k), ctx)
9376 """Create a Pseudo-Boolean inequality k constraint.
9378 >>> a, b, c = Bools('a b c')
9379 >>> f = PbGe(((a,1),(b,3),(c,2)), 3)
9381 _z3_check_cint_overflow(k, "k")
9382 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9383 return BoolRef(Z3_mk_pbge(ctx.ref(), sz, _args, _coeffs, k), ctx)
9386def PbEq(args, k, ctx=None):
9387 """Create a Pseudo-Boolean equality k constraint.
9389 >>> a, b, c = Bools('a b c')
9390 >>> f = PbEq(((a,1),(b,3),(c,2)), 3)
9392 _z3_check_cint_overflow(k, "k")
9393 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9394 return BoolRef(Z3_mk_pbeq(ctx.ref(), sz, _args, _coeffs, k), ctx)
9397def solve(*args, **keywords):
9398 """Solve the constraints `*args`.
9400 This is a simple function for creating demonstrations. It creates a solver,
9401 configure it using the options in `keywords`, adds the constraints
9402 in `args`, and invokes check.
9405 >>> solve(a > 0, a < 2)
9408 show = keywords.pop("show", False)
9416 print("no solution")
9418 print("failed to solve")
9427def solve_using(s, *args, **keywords):
9428 """Solve the constraints `*args` using solver `s`.
9430 This is a simple function for creating demonstrations. It is similar to `solve`,
9431 but it uses the given solver `s`.
9432 It configures solver `s` using the options in `keywords`, adds the constraints
9433 in `args`, and invokes check.
9435 show = keywords.pop("show", False)
9437 _z3_assert(isinstance(s, Solver), "Solver object expected")
9445 print("no solution")
9447 print("failed to solve")
9458def prove(claim, show=False, **keywords):
9459 """Try to prove the given claim.
9461 This is a simple function for creating demonstrations. It tries to prove
9462 `claim` by showing the negation is unsatisfiable.
9464 >>> p, q = Bools('p q')
9465 >>> prove(Not(And(p, q)) == Or(Not(p), Not(q)))
9469 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9479 print("failed to prove")
9482 print("counterexample")
9486def _solve_html(*args, **keywords):
9487 """Version of function `solve` that renders HTML output."""
9488 show = keywords.pop("show", False)
9493 print("<b>Problem:</b>")
9497 print("<b>no solution</b>")
9499 print("<b>failed to solve</b>")
9506 print("<b>Solution:</b>")
9510def _solve_using_html(s, *args, **keywords):
9511 """Version of function `solve_using` that renders HTML."""
9512 show = keywords.pop("show", False)
9514 _z3_assert(isinstance(s, Solver), "Solver object expected")
9518 print("<b>Problem:</b>")
9522 print("<b>no solution</b>")
9524 print("<b>failed to solve</b>")
9531 print("<b>Solution:</b>")
9535def _prove_html(claim, show=False, **keywords):
9536 """Version of function `prove` that renders HTML."""
9538 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9546 print("<b>proved</b>")
9548 print("<b>failed to prove</b>")
9551 print("<b>counterexample</b>")
9555def _dict2sarray(sorts, ctx):
9557 _names = (Symbol * sz)()
9558 _sorts = (Sort * sz)()
9563 _z3_assert(isinstance(k, str), "String expected")
9564 _z3_assert(is_sort(v), "Z3 sort expected")
9565 _names[i] = to_symbol(k, ctx)
9568 return sz, _names, _sorts
9571def _dict2darray(decls, ctx):
9573 _names = (Symbol * sz)()
9574 _decls = (FuncDecl * sz)()
9579 _z3_assert(isinstance(k, str), "String expected")
9580 _z3_assert(is_func_decl(v) or is_const(v), "Z3 declaration or constant expected")
9581 _names[i] = to_symbol(k, ctx)
9583 _decls[i] = v.decl().ast
9587 return sz, _names, _decls
9590 def __init__(self, ctx= None):
9591 self.ctx = _get_ctx(ctx)
9592 self.pctx = Z3_mk_parser_context(self.ctx.ref())
9593 Z3_parser_context_inc_ref(self.ctx.ref(), self.pctx)
9596 if self.ctx.ref() is not None and self.pctx is not None and Z3_parser_context_dec_ref is not None:
9597 Z3_parser_context_dec_ref(self.ctx.ref(), self.pctx)
9600 def add_sort(self, sort):
9601 Z3_parser_context_add_sort(self.ctx.ref(), self.pctx, sort.as_ast())
9603 def add_decl(self, decl):
9604 Z3_parser_context_add_decl(self.ctx.ref(), self.pctx, decl.as_ast())
9606 def from_string(self, s):
9607 return AstVector(Z3_parser_context_from_string(self.ctx.ref(), self.pctx, s), self.ctx)
9609def parse_smt2_string(s, sorts={}, decls={}, ctx=None):
9610 """Parse a string in SMT 2.0 format using the given sorts and decls.
9612 The arguments sorts and decls are Python dictionaries used to initialize
9613 the symbol table used for the SMT 2.0 parser.
9615 >>> parse_smt2_string('(declare-const x Int) (assert (> x 0)) (assert (< x 10))')
9617 >>> x, y = Ints('x y')
9618 >>> f = Function('f', IntSort(), IntSort())
9619 >>> parse_smt2_string('(assert (> (+ foo (g bar)) 0))', decls={ 'foo' : x, 'bar' : y, 'g' : f})
9621 >>> parse_smt2_string('(declare-const a U) (assert (> a 0))', sorts={ 'U' : IntSort() })
9625 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9626 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9627 return AstVector(Z3_parse_smtlib2_string(ctx.ref(), s, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9630def parse_smt2_file(f, sorts={}, decls={}, ctx=None):
9631 """Parse a file in SMT 2.0 format using the given sorts and decls.
9633 This function is similar to parse_smt2_string().
9636 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9637 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9638 return AstVector(Z3_parse_smtlib2_file(ctx.ref(), f, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9641#########################################
9643# Floating-Point Arithmetic
9645#########################################
9648# Global default rounding mode
9649_dflt_rounding_mode = Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN
9650_dflt_fpsort_ebits = 11
9651_dflt_fpsort_sbits = 53
9654def get_default_rounding_mode(ctx=None):
9655 """Retrieves the global default rounding mode."""
9656 global _dflt_rounding_mode
9657 if _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_ZERO:
9659 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_NEGATIVE:
9661 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_POSITIVE:
9663 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN:
9665 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY:
9669_ROUNDING_MODES = frozenset({
9670 Z3_OP_FPA_RM_TOWARD_ZERO,
9671 Z3_OP_FPA_RM_TOWARD_NEGATIVE,
9672 Z3_OP_FPA_RM_TOWARD_POSITIVE,
9673 Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN,
9674 Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY
9678def set_default_rounding_mode(rm, ctx=None):
9679 global _dflt_rounding_mode
9680 if is_fprm_value(rm):
9681 _dflt_rounding_mode = rm.kind()
9683 _z3_assert(_dflt_rounding_mode in _ROUNDING_MODES, "illegal rounding mode")
9684 _dflt_rounding_mode = rm
9687def get_default_fp_sort(ctx=None):
9688 return FPSort(_dflt_fpsort_ebits, _dflt_fpsort_sbits, ctx)
9691def set_default_fp_sort(ebits, sbits, ctx=None):
9692 global _dflt_fpsort_ebits
9693 global _dflt_fpsort_sbits
9694 _dflt_fpsort_ebits = ebits
9695 _dflt_fpsort_sbits = sbits
9698def _dflt_rm(ctx=None):
9699 return get_default_rounding_mode(ctx)
9702def _dflt_fps(ctx=None):
9703 return get_default_fp_sort(ctx)
9706def _coerce_fp_expr_list(alist, ctx):
9707 first_fp_sort = None
9710 if first_fp_sort is None:
9711 first_fp_sort = a.sort()
9712 elif first_fp_sort == a.sort():
9713 pass # OK, same as before
9715 # we saw at least 2 different float sorts; something will
9716 # throw a sort mismatch later, for now assume None.
9717 first_fp_sort = None
9721 for i in range(len(alist)):
9723 is_repr = isinstance(a, str) and a.contains("2**(") and a.endswith(")")
9724 if is_repr or _is_int(a) or isinstance(a, (float, bool)):
9725 r.append(FPVal(a, None, first_fp_sort, ctx))
9728 return _coerce_expr_list(r, ctx)
9733class FPSortRef(SortRef):
9734 """Floating-point sort."""
9737 """Retrieves the number of bits reserved for the exponent in the FloatingPoint sort `self`.
9738 >>> b = FPSort(8, 24)
9742 return int(Z3_fpa_get_ebits(self.ctx_ref(), self.ast))
9745 """Retrieves the number of bits reserved for the significand in the FloatingPoint sort `self`.
9746 >>> b = FPSort(8, 24)
9750 return int(Z3_fpa_get_sbits(self.ctx_ref(), self.ast))
9752 def cast(self, val):
9753 """Try to cast `val` as a floating-point expression.
9754 >>> b = FPSort(8, 24)
9757 >>> b.cast(1.0).sexpr()
9758 '(fp #b0 #x7f #b00000000000000000000000)'
9762 _z3_assert(self.ctx == val.ctx, "Context mismatch")
9765 return FPVal(val, None, self, self.ctx)
9768def Float16(ctx=None):
9769 """Floating-point 16-bit (half) sort."""
9771 return FPSortRef(Z3_mk_fpa_sort_16(ctx.ref()), ctx)
9774def FloatHalf(ctx=None):
9775 """Floating-point 16-bit (half) sort."""
9777 return FPSortRef(Z3_mk_fpa_sort_half(ctx.ref()), ctx)
9780def Float32(ctx=None):
9781 """Floating-point 32-bit (single) sort."""
9783 return FPSortRef(Z3_mk_fpa_sort_32(ctx.ref()), ctx)
9786def FloatSingle(ctx=None):
9787 """Floating-point 32-bit (single) sort."""
9789 return FPSortRef(Z3_mk_fpa_sort_single(ctx.ref()), ctx)
9792def Float64(ctx=None):
9793 """Floating-point 64-bit (double) sort."""
9795 return FPSortRef(Z3_mk_fpa_sort_64(ctx.ref()), ctx)
9798def FloatDouble(ctx=None):
9799 """Floating-point 64-bit (double) sort."""
9801 return FPSortRef(Z3_mk_fpa_sort_double(ctx.ref()), ctx)
9804def Float128(ctx=None):
9805 """Floating-point 128-bit (quadruple) sort."""
9807 return FPSortRef(Z3_mk_fpa_sort_128(ctx.ref()), ctx)
9810def FloatQuadruple(ctx=None):
9811 """Floating-point 128-bit (quadruple) sort."""
9813 return FPSortRef(Z3_mk_fpa_sort_quadruple(ctx.ref()), ctx)
9816class FPRMSortRef(SortRef):
9817 """"Floating-point rounding mode sort."""
9821 """Return True if `s` is a Z3 floating-point sort.
9823 >>> is_fp_sort(FPSort(8, 24))
9825 >>> is_fp_sort(IntSort())
9828 return isinstance(s, FPSortRef)
9832 """Return True if `s` is a Z3 floating-point rounding mode sort.
9834 >>> is_fprm_sort(FPSort(8, 24))
9836 >>> is_fprm_sort(RNE().sort())
9839 return isinstance(s, FPRMSortRef)
9844class FPRef(ExprRef):
9845 """Floating-point expressions."""
9848 """Return the sort of the floating-point expression `self`.
9850 >>> x = FP('1.0', FPSort(8, 24))
9853 >>> x.sort() == FPSort(8, 24)
9856 return FPSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
9859 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9860 >>> b = FPSort(8, 24)
9864 return self.sort().ebits()
9867 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9868 >>> b = FPSort(8, 24)
9872 return self.sort().sbits()
9874 def as_string(self):
9875 """Return a Z3 floating point expression as a Python string."""
9876 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
9878 def __le__(self, other):
9879 return fpLEQ(self, other, self.ctx)
9881 def __lt__(self, other):
9882 return fpLT(self, other, self.ctx)
9884 def __ge__(self, other):
9885 return fpGEQ(self, other, self.ctx)
9887 def __gt__(self, other):
9888 return fpGT(self, other, self.ctx)
9890 def __add__(self, other):
9891 """Create the Z3 expression `self + other`.
9893 >>> x = FP('x', FPSort(8, 24))
9894 >>> y = FP('y', FPSort(8, 24))
9900 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9901 return fpAdd(_dflt_rm(), a, b, self.ctx)
9903 def __radd__(self, other):
9904 """Create the Z3 expression `other + self`.
9906 >>> x = FP('x', FPSort(8, 24))
9910 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9911 return fpAdd(_dflt_rm(), a, b, self.ctx)
9913 def __sub__(self, other):
9914 """Create the Z3 expression `self - other`.
9916 >>> x = FP('x', FPSort(8, 24))
9917 >>> y = FP('y', FPSort(8, 24))
9923 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9924 return fpSub(_dflt_rm(), a, b, self.ctx)
9926 def __rsub__(self, other):
9927 """Create the Z3 expression `other - self`.
9929 >>> x = FP('x', FPSort(8, 24))
9933 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9934 return fpSub(_dflt_rm(), a, b, self.ctx)
9936 def __mul__(self, other):
9937 """Create the Z3 expression `self * other`.
9939 >>> x = FP('x', FPSort(8, 24))
9940 >>> y = FP('y', FPSort(8, 24))
9948 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9949 return fpMul(_dflt_rm(), a, b, self.ctx)
9951 def __rmul__(self, other):
9952 """Create the Z3 expression `other * self`.
9954 >>> x = FP('x', FPSort(8, 24))
9955 >>> y = FP('y', FPSort(8, 24))
9961 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9962 return fpMul(_dflt_rm(), a, b, self.ctx)
9965 """Create the Z3 expression `+self`."""
9969 """Create the Z3 expression `-self`.
9971 >>> x = FP('x', Float32())
9977 def __div__(self, other):
9978 """Create the Z3 expression `self / other`.
9980 >>> x = FP('x', FPSort(8, 24))
9981 >>> y = FP('y', FPSort(8, 24))
9989 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9990 return fpDiv(_dflt_rm(), a, b, self.ctx)
9992 def __rdiv__(self, other):
9993 """Create the Z3 expression `other / self`.
9995 >>> x = FP('x', FPSort(8, 24))
9996 >>> y = FP('y', FPSort(8, 24))
10002 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
10003 return fpDiv(_dflt_rm(), a, b, self.ctx)
10005 def __truediv__(self, other):
10006 """Create the Z3 expression division `self / other`."""
10007 return self.__div__(other)
10009 def __rtruediv__(self, other):
10010 """Create the Z3 expression division `other / self`."""
10011 return self.__rdiv__(other)
10013 def __mod__(self, other):
10014 """Create the Z3 expression mod `self % other`."""
10015 return fpRem(self, other)
10017 def __rmod__(self, other):
10018 """Create the Z3 expression mod `other % self`."""
10019 return fpRem(other, self)
10022class FPRMRef(ExprRef):
10023 """Floating-point rounding mode expressions"""
10025 def as_string(self):
10026 """Return a Z3 floating point expression as a Python string."""
10027 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
10030def RoundNearestTiesToEven(ctx=None):
10031 ctx = _get_ctx(ctx)
10032 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
10036 ctx = _get_ctx(ctx)
10037 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
10040def RoundNearestTiesToAway(ctx=None):
10041 ctx = _get_ctx(ctx)
10042 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
10046 ctx = _get_ctx(ctx)
10047 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
10050def RoundTowardPositive(ctx=None):
10051 ctx = _get_ctx(ctx)
10052 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
10056 ctx = _get_ctx(ctx)
10057 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
10060def RoundTowardNegative(ctx=None):
10061 ctx = _get_ctx(ctx)
10062 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
10066 ctx = _get_ctx(ctx)
10067 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
10070def RoundTowardZero(ctx=None):
10071 ctx = _get_ctx(ctx)
10072 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
10076 ctx = _get_ctx(ctx)
10077 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
10081 """Return `True` if `a` is a Z3 floating-point rounding mode expression.
10090 return isinstance(a, FPRMRef)
10093def is_fprm_value(a):
10094 """Return `True` if `a` is a Z3 floating-point rounding mode numeral value."""
10095 return is_fprm(a) and _is_numeral(a.ctx, a.ast)
10100class FPNumRef(FPRef):
10101 """The sign of the numeral.
10103 >>> x = FPVal(+1.0, FPSort(8, 24))
10106 >>> x = FPVal(-1.0, FPSort(8, 24))
10112 num = ctypes.c_bool()
10113 nsign = Z3_fpa_get_numeral_sign(self.ctx.ref(), self.as_ast(), byref(num))
10115 raise Z3Exception("error retrieving the sign of a numeral.")
10116 return num.value != 0
10118 """The sign of a floating-point numeral as a bit-vector expression.
10120 Remark: NaN's are invalid arguments.
10123 def sign_as_bv(self):
10124 return BitVecNumRef(Z3_fpa_get_numeral_sign_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10126 """The significand of the numeral.
10128 >>> x = FPVal(2.5, FPSort(8, 24))
10129 >>> x.significand()
10133 def significand(self):
10134 return Z3_fpa_get_numeral_significand_string(self.ctx.ref(), self.as_ast())
10136 """The significand of the numeral as a long.
10138 >>> x = FPVal(2.5, FPSort(8, 24))
10139 >>> x.significand_as_long()
10143 def significand_as_long(self):
10144 ptr = (ctypes.c_ulonglong * 1)()
10145 if not Z3_fpa_get_numeral_significand_uint64(self.ctx.ref(), self.as_ast(), ptr):
10146 raise Z3Exception("error retrieving the significand of a numeral.")
10149 """The significand of the numeral as a bit-vector expression.
10151 Remark: NaN are invalid arguments.
10154 def significand_as_bv(self):
10155 return BitVecNumRef(Z3_fpa_get_numeral_significand_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10157 """The exponent of the numeral.
10159 >>> x = FPVal(2.5, FPSort(8, 24))
10164 def exponent(self, biased=True):
10165 return Z3_fpa_get_numeral_exponent_string(self.ctx.ref(), self.as_ast(), biased)
10167 """The exponent of the numeral as a long.
10169 >>> x = FPVal(2.5, FPSort(8, 24))
10170 >>> x.exponent_as_long()
10174 def exponent_as_long(self, biased=True):
10175 ptr = (ctypes.c_longlong * 1)()
10176 if not Z3_fpa_get_numeral_exponent_int64(self.ctx.ref(), self.as_ast(), ptr, biased):
10177 raise Z3Exception("error retrieving the exponent of a numeral.")
10180 """The exponent of the numeral as a bit-vector expression.
10182 Remark: NaNs are invalid arguments.
10185 def exponent_as_bv(self, biased=True):
10186 return BitVecNumRef(Z3_fpa_get_numeral_exponent_bv(self.ctx.ref(), self.as_ast(), biased), self.ctx)
10188 """Indicates whether the numeral is a NaN."""
10191 return Z3_fpa_is_numeral_nan(self.ctx.ref(), self.as_ast())
10193 """Indicates whether the numeral is +oo or -oo."""
10196 return Z3_fpa_is_numeral_inf(self.ctx.ref(), self.as_ast())
10198 """Indicates whether the numeral is +zero or -zero."""
10201 return Z3_fpa_is_numeral_zero(self.ctx.ref(), self.as_ast())
10203 """Indicates whether the numeral is normal."""
10205 def isNormal(self):
10206 return Z3_fpa_is_numeral_normal(self.ctx.ref(), self.as_ast())
10208 """Indicates whether the numeral is subnormal."""
10210 def isSubnormal(self):
10211 return Z3_fpa_is_numeral_subnormal(self.ctx.ref(), self.as_ast())
10213 """Indicates whether the numeral is positive."""
10215 def isPositive(self):
10216 return Z3_fpa_is_numeral_positive(self.ctx.ref(), self.as_ast())
10218 """Indicates whether the numeral is negative."""
10220 def isNegative(self):
10221 return Z3_fpa_is_numeral_negative(self.ctx.ref(), self.as_ast())
10224 The string representation of the numeral.
10226 >>> x = FPVal(20, FPSort(8, 24))
10231 def as_string(self):
10232 s = Z3_get_numeral_string(self.ctx.ref(), self.as_ast())
10233 return ("FPVal(%s, %s)" % (s, self.sort()))
10235 def py_value(self):
10236 bv = simplify(fpToIEEEBV(self))
10237 binary = bv.py_value()
10238 if not isinstance(binary, int):
10240 # Decode the IEEE 754 binary representation
10242 bytes_rep = binary.to_bytes(8, byteorder='big')
10243 return struct.unpack('>d', bytes_rep)[0]
10247 """Return `True` if `a` is a Z3 floating-point expression.
10249 >>> b = FP('b', FPSort(8, 24))
10254 >>> is_fp(Int('x'))
10257 return isinstance(a, FPRef)
10261 """Return `True` if `a` is a Z3 floating-point numeral value.
10263 >>> b = FP('b', FPSort(8, 24))
10266 >>> b = FPVal(1.0, FPSort(8, 24))
10272 return is_fp(a) and _is_numeral(a.ctx, a.ast)
10275def FPSort(ebits, sbits, ctx=None):
10276 """Return a Z3 floating-point sort of the given sizes. If `ctx=None`, then the global context is used.
10278 >>> Single = FPSort(8, 24)
10279 >>> Double = FPSort(11, 53)
10282 >>> x = Const('x', Single)
10283 >>> eq(x, FP('x', FPSort(8, 24)))
10286 ctx = _get_ctx(ctx)
10287 return FPSortRef(Z3_mk_fpa_sort(ctx.ref(), ebits, sbits), ctx)
10290def _to_float_str(val, exp=0):
10291 if isinstance(val, float):
10292 if math.isnan(val):
10295 sone = math.copysign(1.0, val)
10300 elif val == float("+inf"):
10302 elif val == float("-inf"):
10305 v = val.as_integer_ratio()
10308 rvs = str(num) + "/" + str(den)
10309 res = rvs + "p" + _to_int_str(exp)
10310 elif isinstance(val, bool):
10317 elif isinstance(val, str):
10318 inx = val.find("*(2**")
10321 elif val[-1] == ")":
10323 exp = str(int(val[inx + 5:-1]) + int(exp))
10325 _z3_assert(False, "String does not have floating-point numeral form.")
10327 _z3_assert(False, "Python value cannot be used to create floating-point numerals.")
10331 return res + "p" + exp
10335 """Create a Z3 floating-point NaN term.
10337 >>> s = FPSort(8, 24)
10338 >>> set_fpa_pretty(True)
10341 >>> pb = get_fpa_pretty()
10342 >>> set_fpa_pretty(False)
10344 fpNaN(FPSort(8, 24))
10345 >>> set_fpa_pretty(pb)
10347 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10348 return FPNumRef(Z3_mk_fpa_nan(s.ctx_ref(), s.ast), s.ctx)
10351def fpPlusInfinity(s):
10352 """Create a Z3 floating-point +oo term.
10354 >>> s = FPSort(8, 24)
10355 >>> pb = get_fpa_pretty()
10356 >>> set_fpa_pretty(True)
10357 >>> fpPlusInfinity(s)
10359 >>> set_fpa_pretty(False)
10360 >>> fpPlusInfinity(s)
10361 fpPlusInfinity(FPSort(8, 24))
10362 >>> set_fpa_pretty(pb)
10364 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10365 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, False), s.ctx)
10368def fpMinusInfinity(s):
10369 """Create a Z3 floating-point -oo term."""
10370 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10371 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, True), s.ctx)
10374def fpInfinity(s, negative):
10375 """Create a Z3 floating-point +oo or -oo term."""
10376 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10377 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10378 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, negative), s.ctx)
10382 """Create a Z3 floating-point +0.0 term."""
10383 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10384 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, False), s.ctx)
10388 """Create a Z3 floating-point -0.0 term."""
10389 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10390 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, True), s.ctx)
10393def fpZero(s, negative):
10394 """Create a Z3 floating-point +0.0 or -0.0 term."""
10395 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10396 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10397 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, negative), s.ctx)
10400def FPVal(sig, exp=None, fps=None, ctx=None):
10401 """Return a floating-point value of value `val` and sort `fps`.
10402 If `ctx=None`, then the global context is used.
10404 >>> v = FPVal(20.0, FPSort(8, 24))
10407 >>> print("0x%.8x" % v.exponent_as_long(False))
10409 >>> v = FPVal(2.25, FPSort(8, 24))
10412 >>> v = FPVal(-2.25, FPSort(8, 24))
10415 >>> FPVal(-0.0, FPSort(8, 24))
10417 >>> FPVal(0.0, FPSort(8, 24))
10419 >>> FPVal(+0.0, FPSort(8, 24))
10422 ctx = _get_ctx(ctx)
10423 if is_fp_sort(exp):
10427 fps = _dflt_fps(ctx)
10428 _z3_assert(is_fp_sort(fps), "sort mismatch")
10431 val = _to_float_str(sig)
10432 if val == "NaN" or val == "nan":
10434 elif val == "-0.0":
10435 return fpMinusZero(fps)
10436 elif val == "0.0" or val == "+0.0":
10437 return fpPlusZero(fps)
10438 elif val == "+oo" or val == "+inf" or val == "+Inf":
10439 return fpPlusInfinity(fps)
10440 elif val == "-oo" or val == "-inf" or val == "-Inf":
10441 return fpMinusInfinity(fps)
10443 return FPNumRef(Z3_mk_numeral(ctx.ref(), val, fps.ast), ctx)
10446def FP(name, fpsort, ctx=None):
10447 """Return a floating-point constant named `name`.
10448 `fpsort` is the floating-point sort.
10449 If `ctx=None`, then the global context is used.
10451 >>> x = FP('x', FPSort(8, 24))
10458 >>> word = FPSort(8, 24)
10459 >>> x2 = FP('x', word)
10463 if isinstance(fpsort, FPSortRef) and ctx is None:
10466 ctx = _get_ctx(ctx)
10467 return FPRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), fpsort.ast), ctx)
10470def FPs(names, fpsort, ctx=None):
10471 """Return an array of floating-point constants.
10473 >>> x, y, z = FPs('x y z', FPSort(8, 24))
10480 >>> fpMul(RNE(), fpAdd(RNE(), x, y), z)
10483 ctx = _get_ctx(ctx)
10484 if isinstance(names, str):
10485 names = names.split(" ")
10486 return [FP(name, fpsort, ctx) for name in names]
10489def fpAbs(a, ctx=None):
10490 """Create a Z3 floating-point absolute value expression.
10492 >>> s = FPSort(8, 24)
10494 >>> x = FPVal(1.0, s)
10497 >>> y = FPVal(-20.0, s)
10501 fpAbs(-1.25*(2**4))
10502 >>> fpAbs(-1.25*(2**4))
10503 fpAbs(-1.25*(2**4))
10504 >>> fpAbs(x).sort()
10507 ctx = _get_ctx(ctx)
10508 [a] = _coerce_fp_expr_list([a], ctx)
10509 return FPRef(Z3_mk_fpa_abs(ctx.ref(), a.as_ast()), ctx)
10512def fpNeg(a, ctx=None):
10513 """Create a Z3 floating-point addition expression.
10515 >>> s = FPSort(8, 24)
10520 >>> fpNeg(x).sort()
10523 ctx = _get_ctx(ctx)
10524 [a] = _coerce_fp_expr_list([a], ctx)
10525 return FPRef(Z3_mk_fpa_neg(ctx.ref(), a.as_ast()), ctx)
10528def _mk_fp_unary(f, rm, a, ctx):
10529 ctx = _get_ctx(ctx)
10530 [a] = _coerce_fp_expr_list([a], ctx)
10532 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10533 _z3_assert(is_fp(a), "Second argument must be a Z3 floating-point expression")
10534 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast()), ctx)
10537def _mk_fp_unary_pred(f, a, ctx):
10538 ctx = _get_ctx(ctx)
10539 [a] = _coerce_fp_expr_list([a], ctx)
10541 _z3_assert(is_fp(a), "First argument must be a Z3 floating-point expression")
10542 return BoolRef(f(ctx.ref(), a.as_ast()), ctx)
10545def _mk_fp_bin(f, rm, a, b, ctx):
10546 ctx = _get_ctx(ctx)
10547 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10549 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10550 _z3_assert(is_fp(a) or is_fp(b), "Second or third argument must be a Z3 floating-point expression")
10551 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast()), ctx)
10554def _mk_fp_bin_norm(f, a, b, ctx):
10555 ctx = _get_ctx(ctx)
10556 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10558 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10559 return FPRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10562def _mk_fp_bin_pred(f, a, b, ctx):
10563 ctx = _get_ctx(ctx)
10564 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10566 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10567 return BoolRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10570def _mk_fp_tern(f, rm, a, b, c, ctx):
10571 ctx = _get_ctx(ctx)
10572 [a, b, c] = _coerce_fp_expr_list([a, b, c], ctx)
10574 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10575 _z3_assert(is_fp(a) or is_fp(b) or is_fp(
10576 c), "Second, third or fourth argument must be a Z3 floating-point expression")
10577 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast(), c.as_ast()), ctx)
10580def fpAdd(rm, a, b, ctx=None):
10581 """Create a Z3 floating-point addition expression.
10583 >>> s = FPSort(8, 24)
10587 >>> fpAdd(rm, x, y)
10589 >>> fpAdd(RTZ(), x, y) # default rounding mode is RTZ
10591 >>> fpAdd(rm, x, y).sort()
10594 return _mk_fp_bin(Z3_mk_fpa_add, rm, a, b, ctx)
10597def fpSub(rm, a, b, ctx=None):
10598 """Create a Z3 floating-point subtraction expression.
10600 >>> s = FPSort(8, 24)
10604 >>> fpSub(rm, x, y)
10606 >>> fpSub(rm, x, y).sort()
10609 return _mk_fp_bin(Z3_mk_fpa_sub, rm, a, b, ctx)
10612def fpMul(rm, a, b, ctx=None):
10613 """Create a Z3 floating-point multiplication expression.
10615 >>> s = FPSort(8, 24)
10619 >>> fpMul(rm, x, y)
10621 >>> fpMul(rm, x, y).sort()
10624 return _mk_fp_bin(Z3_mk_fpa_mul, rm, a, b, ctx)
10627def fpDiv(rm, a, b, ctx=None):
10628 """Create a Z3 floating-point division expression.
10630 >>> s = FPSort(8, 24)
10634 >>> fpDiv(rm, x, y)
10636 >>> fpDiv(rm, x, y).sort()
10639 return _mk_fp_bin(Z3_mk_fpa_div, rm, a, b, ctx)
10642def fpRem(a, b, ctx=None):
10643 """Create a Z3 floating-point remainder expression.
10645 >>> s = FPSort(8, 24)
10650 >>> fpRem(x, y).sort()
10653 return _mk_fp_bin_norm(Z3_mk_fpa_rem, a, b, ctx)
10656def fpMin(a, b, ctx=None):
10657 """Create a Z3 floating-point minimum expression.
10659 >>> s = FPSort(8, 24)
10665 >>> fpMin(x, y).sort()
10668 return _mk_fp_bin_norm(Z3_mk_fpa_min, a, b, ctx)
10671def fpMax(a, b, ctx=None):
10672 """Create a Z3 floating-point maximum expression.
10674 >>> s = FPSort(8, 24)
10680 >>> fpMax(x, y).sort()
10683 return _mk_fp_bin_norm(Z3_mk_fpa_max, a, b, ctx)
10686def fpFMA(rm, a, b, c, ctx=None):
10687 """Create a Z3 floating-point fused multiply-add expression.
10689 return _mk_fp_tern(Z3_mk_fpa_fma, rm, a, b, c, ctx)
10692def fpSqrt(rm, a, ctx=None):
10693 """Create a Z3 floating-point square root expression.
10695 return _mk_fp_unary(Z3_mk_fpa_sqrt, rm, a, ctx)
10698def fpRoundToIntegral(rm, a, ctx=None):
10699 """Create a Z3 floating-point roundToIntegral expression.
10701 return _mk_fp_unary(Z3_mk_fpa_round_to_integral, rm, a, ctx)
10704def fpIsNaN(a, ctx=None):
10705 """Create a Z3 floating-point isNaN expression.
10707 >>> s = FPSort(8, 24)
10713 return _mk_fp_unary_pred(Z3_mk_fpa_is_nan, a, ctx)
10716def fpIsInf(a, ctx=None):
10717 """Create a Z3 floating-point isInfinite expression.
10719 >>> s = FPSort(8, 24)
10724 return _mk_fp_unary_pred(Z3_mk_fpa_is_infinite, a, ctx)
10727def fpIsZero(a, ctx=None):
10728 """Create a Z3 floating-point isZero expression.
10730 return _mk_fp_unary_pred(Z3_mk_fpa_is_zero, a, ctx)
10733def fpIsNormal(a, ctx=None):
10734 """Create a Z3 floating-point isNormal expression.
10736 return _mk_fp_unary_pred(Z3_mk_fpa_is_normal, a, ctx)
10739def fpIsSubnormal(a, ctx=None):
10740 """Create a Z3 floating-point isSubnormal expression.
10742 return _mk_fp_unary_pred(Z3_mk_fpa_is_subnormal, a, ctx)
10745def fpIsNegative(a, ctx=None):
10746 """Create a Z3 floating-point isNegative expression.
10748 return _mk_fp_unary_pred(Z3_mk_fpa_is_negative, a, ctx)
10751def fpIsPositive(a, ctx=None):
10752 """Create a Z3 floating-point isPositive expression.
10754 return _mk_fp_unary_pred(Z3_mk_fpa_is_positive, a, ctx)
10757def _check_fp_args(a, b):
10759 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10762def fpLT(a, b, ctx=None):
10763 """Create the Z3 floating-point expression `other < self`.
10765 >>> x, y = FPs('x y', FPSort(8, 24))
10768 >>> (x < y).sexpr()
10771 return _mk_fp_bin_pred(Z3_mk_fpa_lt, a, b, ctx)
10774def fpLEQ(a, b, ctx=None):
10775 """Create the Z3 floating-point expression `other <= self`.
10777 >>> x, y = FPs('x y', FPSort(8, 24))
10780 >>> (x <= y).sexpr()
10783 return _mk_fp_bin_pred(Z3_mk_fpa_leq, a, b, ctx)
10786def fpGT(a, b, ctx=None):
10787 """Create the Z3 floating-point expression `other > self`.
10789 >>> x, y = FPs('x y', FPSort(8, 24))
10792 >>> (x > y).sexpr()
10795 return _mk_fp_bin_pred(Z3_mk_fpa_gt, a, b, ctx)
10798def fpGEQ(a, b, ctx=None):
10799 """Create the Z3 floating-point expression `other >= self`.
10801 >>> x, y = FPs('x y', FPSort(8, 24))
10804 >>> (x >= y).sexpr()
10807 return _mk_fp_bin_pred(Z3_mk_fpa_geq, a, b, ctx)
10810def fpEQ(a, b, ctx=None):
10811 """Create the Z3 floating-point expression `fpEQ(other, self)`.
10813 >>> x, y = FPs('x y', FPSort(8, 24))
10816 >>> fpEQ(x, y).sexpr()
10819 return _mk_fp_bin_pred(Z3_mk_fpa_eq, a, b, ctx)
10822def fpNEQ(a, b, ctx=None):
10823 """Create the Z3 floating-point expression `Not(fpEQ(other, self))`.
10825 >>> x, y = FPs('x y', FPSort(8, 24))
10828 >>> (x != y).sexpr()
10831 return Not(fpEQ(a, b, ctx))
10834def fpFP(sgn, exp, sig, ctx=None):
10835 """Create the Z3 floating-point value `fpFP(sgn, sig, exp)` from the three bit-vectors sgn, sig, and exp.
10837 >>> s = FPSort(8, 24)
10838 >>> x = fpFP(BitVecVal(1, 1), BitVecVal(2**7-1, 8), BitVecVal(2**22, 23))
10840 fpFP(1, 127, 4194304)
10841 >>> xv = FPVal(-1.5, s)
10844 >>> slvr = Solver()
10845 >>> slvr.add(fpEQ(x, xv))
10848 >>> xv = FPVal(+1.5, s)
10851 >>> slvr = Solver()
10852 >>> slvr.add(fpEQ(x, xv))
10856 _z3_assert(is_bv(sgn) and is_bv(exp) and is_bv(sig), "sort mismatch")
10857 _z3_assert(sgn.sort().size() == 1, "sort mismatch")
10858 ctx = _get_ctx(ctx)
10859 _z3_assert(ctx == sgn.ctx == exp.ctx == sig.ctx, "context mismatch")
10860 return FPRef(Z3_mk_fpa_fp(ctx.ref(), sgn.ast, exp.ast, sig.ast), ctx)
10863def fpToFP(a1, a2=None, a3=None, ctx=None):
10864 """Create a Z3 floating-point conversion expression from other term sorts
10867 From a bit-vector term in IEEE 754-2008 format:
10868 >>> x = FPVal(1.0, Float32())
10869 >>> x_bv = fpToIEEEBV(x)
10870 >>> simplify(fpToFP(x_bv, Float32()))
10873 From a floating-point term with different precision:
10874 >>> x = FPVal(1.0, Float32())
10875 >>> x_db = fpToFP(RNE(), x, Float64())
10880 >>> x_r = RealVal(1.5)
10881 >>> simplify(fpToFP(RNE(), x_r, Float32()))
10884 From a signed bit-vector term:
10885 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10886 >>> simplify(fpToFP(RNE(), x_signed, Float32()))
10889 ctx = _get_ctx(ctx)
10890 if is_bv(a1) and is_fp_sort(a2):
10891 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), a1.ast, a2.ast), ctx)
10892 elif is_fprm(a1) and is_fp(a2) and is_fp_sort(a3):
10893 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10894 elif is_fprm(a1) and is_real(a2) and is_fp_sort(a3):
10895 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10896 elif is_fprm(a1) and is_bv(a2) and is_fp_sort(a3):
10897 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10899 raise Z3Exception("Unsupported combination of arguments for conversion to floating-point term.")
10902def fpBVToFP(v, sort, ctx=None):
10903 """Create a Z3 floating-point conversion expression that represents the
10904 conversion from a bit-vector term to a floating-point term.
10906 >>> x_bv = BitVecVal(0x3F800000, 32)
10907 >>> x_fp = fpBVToFP(x_bv, Float32())
10913 _z3_assert(is_bv(v), "First argument must be a Z3 bit-vector expression")
10914 _z3_assert(is_fp_sort(sort), "Second argument must be a Z3 floating-point sort.")
10915 ctx = _get_ctx(ctx)
10916 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), v.ast, sort.ast), ctx)
10919def fpFPToFP(rm, v, sort, ctx=None):
10920 """Create a Z3 floating-point conversion expression that represents the
10921 conversion from a floating-point term to a floating-point term of different precision.
10923 >>> x_sgl = FPVal(1.0, Float32())
10924 >>> x_dbl = fpFPToFP(RNE(), x_sgl, Float64())
10927 >>> simplify(x_dbl)
10932 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10933 _z3_assert(is_fp(v), "Second argument must be a Z3 floating-point expression.")
10934 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10935 ctx = _get_ctx(ctx)
10936 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10939def fpRealToFP(rm, v, sort, ctx=None):
10940 """Create a Z3 floating-point conversion expression that represents the
10941 conversion from a real term to a floating-point term.
10943 >>> x_r = RealVal(1.5)
10944 >>> x_fp = fpRealToFP(RNE(), x_r, Float32())
10950 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10951 _z3_assert(is_real(v), "Second argument must be a Z3 expression or real sort.")
10952 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10953 ctx = _get_ctx(ctx)
10954 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10957def fpSignedToFP(rm, v, sort, ctx=None):
10958 """Create a Z3 floating-point conversion expression that represents the
10959 conversion from a signed bit-vector term (encoding an integer) to a floating-point term.
10961 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10962 >>> x_fp = fpSignedToFP(RNE(), x_signed, Float32())
10964 fpToFP(RNE(), 4294967291)
10968 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10969 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
10970 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10971 ctx = _get_ctx(ctx)
10972 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10975def fpUnsignedToFP(rm, v, sort, ctx=None):
10976 """Create a Z3 floating-point conversion expression that represents the
10977 conversion from an unsigned bit-vector term (encoding an integer) to a floating-point term.
10979 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10980 >>> x_fp = fpUnsignedToFP(RNE(), x_signed, Float32())
10982 fpToFPUnsigned(RNE(), 4294967291)
10986 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10987 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
10988 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10989 ctx = _get_ctx(ctx)
10990 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10993def fpToFPUnsigned(rm, x, s, ctx=None):
10994 """Create a Z3 floating-point conversion expression, from unsigned bit-vector to floating-point expression."""
10996 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10997 _z3_assert(is_bv(x), "Second argument must be a Z3 bit-vector expression")
10998 _z3_assert(is_fp_sort(s), "Third argument must be Z3 floating-point sort")
10999 ctx = _get_ctx(ctx)
11000 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, x.ast, s.ast), ctx)
11003def fpToSBV(rm, x, s, ctx=None):
11004 """Create a Z3 floating-point conversion expression, from floating-point expression to signed bit-vector.
11006 >>> x = FP('x', FPSort(8, 24))
11007 >>> y = fpToSBV(RTZ(), x, BitVecSort(32))
11008 >>> print(is_fp(x))
11010 >>> print(is_bv(y))
11012 >>> print(is_fp(y))
11014 >>> print(is_bv(x))
11018 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
11019 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
11020 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
11021 ctx = _get_ctx(ctx)
11022 return BitVecRef(Z3_mk_fpa_to_sbv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
11025def fpToUBV(rm, x, s, ctx=None):
11026 """Create a Z3 floating-point conversion expression, from floating-point expression to unsigned bit-vector.
11028 >>> x = FP('x', FPSort(8, 24))
11029 >>> y = fpToUBV(RTZ(), x, BitVecSort(32))
11030 >>> print(is_fp(x))
11032 >>> print(is_bv(y))
11034 >>> print(is_fp(y))
11036 >>> print(is_bv(x))
11040 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
11041 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
11042 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
11043 ctx = _get_ctx(ctx)
11044 return BitVecRef(Z3_mk_fpa_to_ubv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
11047def fpToReal(x, ctx=None):
11048 """Create a Z3 floating-point conversion expression, from floating-point expression to real.
11050 >>> x = FP('x', FPSort(8, 24))
11051 >>> y = fpToReal(x)
11052 >>> print(is_fp(x))
11054 >>> print(is_real(y))
11056 >>> print(is_fp(y))
11058 >>> print(is_real(x))
11062 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
11063 ctx = _get_ctx(ctx)
11064 return ArithRef(Z3_mk_fpa_to_real(ctx.ref(), x.ast), ctx)
11067def fpToIEEEBV(x, ctx=None):
11068 """\brief Conversion of a floating-point term into a bit-vector term in IEEE 754-2008 format.
11070 The size of the resulting bit-vector is automatically determined.
11072 Note that IEEE 754-2008 allows multiple different representations of NaN. This conversion
11073 knows only one NaN and it will always produce the same bit-vector representation of
11076 >>> x = FP('x', FPSort(8, 24))
11077 >>> y = fpToIEEEBV(x)
11078 >>> print(is_fp(x))
11080 >>> print(is_bv(y))
11082 >>> print(is_fp(y))
11084 >>> print(is_bv(x))
11088 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
11089 ctx = _get_ctx(ctx)
11090 return BitVecRef(Z3_mk_fpa_to_ieee_bv(ctx.ref(), x.ast), ctx)
11093#########################################
11095# Strings, Sequences and Regular expressions
11097#########################################
11099class SeqSortRef(SortRef):
11100 """Sequence sort."""
11102 def is_string(self):
11103 """Determine if sort is a string
11104 >>> s = StringSort()
11107 >>> s = SeqSort(IntSort())
11111 return Z3_is_string_sort(self.ctx_ref(), self.ast)
11114 return _to_sort_ref(Z3_get_seq_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11116class CharSortRef(SortRef):
11117 """Character sort."""
11120def StringSort(ctx=None):
11121 """Create a string sort
11122 >>> s = StringSort()
11126 ctx = _get_ctx(ctx)
11127 return SeqSortRef(Z3_mk_string_sort(ctx.ref()), ctx)
11129def CharSort(ctx=None):
11130 """Create a character sort
11131 >>> ch = CharSort()
11135 ctx = _get_ctx(ctx)
11136 return CharSortRef(Z3_mk_char_sort(ctx.ref()), ctx)
11140 """Create a sequence sort over elements provided in the argument
11141 >>> s = SeqSort(IntSort())
11142 >>> s == Unit(IntVal(1)).sort()
11145 return SeqSortRef(Z3_mk_seq_sort(s.ctx_ref(), s.ast), s.ctx)
11148class SeqRef(ExprRef):
11149 """Sequence expression."""
11152 return SeqSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
11154 def __add__(self, other):
11155 return Concat(self, other)
11157 def __radd__(self, other):
11158 return Concat(other, self)
11160 def __getitem__(self, i):
11162 i = IntVal(i, self.ctx)
11163 return _to_expr_ref(Z3_mk_seq_nth(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11167 i = IntVal(i, self.ctx)
11168 return SeqRef(Z3_mk_seq_at(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11170 def is_string(self):
11171 return Z3_is_string_sort(self.ctx_ref(), Z3_get_sort(self.ctx_ref(), self.as_ast()))
11173 def is_string_value(self):
11174 return Z3_is_string(self.ctx_ref(), self.as_ast())
11176 def as_string(self):
11177 """Return a string representation of sequence expression."""
11178 if self.is_string_value():
11179 string_length = ctypes.c_uint()
11180 chars = Z3_get_lstring(self.ctx_ref(), self.as_ast(), byref(string_length))
11181 return string_at(chars, size=string_length.value).decode("latin-1")
11182 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
11184 def py_value(self):
11185 return self.as_string()
11187 def __le__(self, other):
11188 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11190 def __lt__(self, other):
11191 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11193 def __ge__(self, other):
11194 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11196 def __gt__(self, other):
11197 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11200def _coerce_char(ch, ctx=None):
11201 if isinstance(ch, str):
11202 ctx = _get_ctx(ctx)
11203 ch = CharVal(ch, ctx)
11204 if not is_expr(ch):
11205 raise Z3Exception("Character expression expected")
11208class CharRef(ExprRef):
11209 """Character expression."""
11211 def __le__(self, other):
11212 other = _coerce_char(other, self.ctx)
11213 return _to_expr_ref(Z3_mk_char_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11216 return _to_expr_ref(Z3_mk_char_to_int(self.ctx_ref(), self.as_ast()), self.ctx)
11219 return _to_expr_ref(Z3_mk_char_to_bv(self.ctx_ref(), self.as_ast()), self.ctx)
11221 def is_digit(self):
11222 return _to_expr_ref(Z3_mk_char_is_digit(self.ctx_ref(), self.as_ast()), self.ctx)
11225def CharVal(ch, ctx=None):
11226 ctx = _get_ctx(ctx)
11227 if isinstance(ch, str):
11229 if not isinstance(ch, int):
11230 raise Z3Exception("character value should be an ordinal")
11231 return _to_expr_ref(Z3_mk_char(ctx.ref(), ch), ctx)
11234 if not is_expr(bv):
11235 raise Z3Exception("Bit-vector expression needed")
11236 return _to_expr_ref(Z3_mk_char_from_bv(bv.ctx_ref(), bv.as_ast()), bv.ctx)
11238def CharToBv(ch, ctx=None):
11239 ch = _coerce_char(ch, ctx)
11242def CharToInt(ch, ctx=None):
11243 ch = _coerce_char(ch, ctx)
11246def CharIsDigit(ch, ctx=None):
11247 ch = _coerce_char(ch, ctx)
11248 return ch.is_digit()
11250def _coerce_seq(s, ctx=None):
11251 if isinstance(s, str):
11252 ctx = _get_ctx(ctx)
11253 s = StringVal(s, ctx)
11255 raise Z3Exception("Non-expression passed as a sequence")
11257 raise Z3Exception("Non-sequence passed as a sequence")
11261def _get_ctx2(a, b, ctx=None):
11272 """Return `True` if `a` is a Z3 sequence expression.
11273 >>> print (is_seq(Unit(IntVal(0))))
11275 >>> print (is_seq(StringVal("abc")))
11278 return isinstance(a, SeqRef)
11281def is_string(a: Any) -> bool:
11282 """Return `True` if `a` is a Z3 string expression.
11283 >>> print (is_string(StringVal("ab")))
11286 return isinstance(a, SeqRef) and a.is_string()
11289def is_string_value(a: Any) -> bool:
11290 """return 'True' if 'a' is a Z3 string constant expression.
11291 >>> print (is_string_value(StringVal("a")))
11293 >>> print (is_string_value(StringVal("a") + StringVal("b")))
11296 return isinstance(a, SeqRef) and a.is_string_value()
11298def StringVal(s, ctx=None):
11299 """create a string expression"""
11300 s = "".join(str(ch) if 32 <= ord(ch) and ord(ch) < 127 else "\\u{%x}" % (ord(ch)) for ch in s)
11301 ctx = _get_ctx(ctx)
11302 return SeqRef(Z3_mk_string(ctx.ref(), s), ctx)
11305def String(name, ctx=None):
11306 """Return a string constant named `name`. If `ctx=None`, then the global context is used.
11308 >>> x = String('x')
11310 ctx = _get_ctx(ctx)
11311 return SeqRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), StringSort(ctx).ast), ctx)
11314def Strings(names, ctx=None):
11315 """Return a tuple of String constants. """
11316 ctx = _get_ctx(ctx)
11317 if isinstance(names, str):
11318 names = names.split(" ")
11319 return [String(name, ctx) for name in names]
11322def SubString(s, offset, length):
11323 """Extract substring or subsequence starting at offset.
11325 This is a convenience function that redirects to Extract(s, offset, length).
11327 >>> s = StringVal("hello world")
11328 >>> SubString(s, 6, 5) # Extract "world"
11329 str.substr("hello world", 6, 5)
11330 >>> simplify(SubString(StringVal("hello"), 1, 3))
11333 return Extract(s, offset, length)
11336def SubSeq(s, offset, length):
11337 """Extract substring or subsequence starting at offset.
11339 This is a convenience function that redirects to Extract(s, offset, length).
11341 >>> s = StringVal("hello world")
11342 >>> SubSeq(s, 0, 5) # Extract "hello"
11343 str.substr("hello world", 0, 5)
11344 >>> simplify(SubSeq(StringVal("testing"), 2, 4))
11347 return Extract(s, offset, length)
11351 """Create the empty sequence of the given sort
11352 >>> e = Empty(StringSort())
11353 >>> e2 = StringVal("")
11354 >>> print(e.eq(e2))
11356 >>> e3 = Empty(SeqSort(IntSort()))
11359 >>> e4 = Empty(ReSort(SeqSort(IntSort())))
11361 Empty(ReSort(Seq(Int)))
11363 if isinstance(s, SeqSortRef):
11364 return SeqRef(Z3_mk_seq_empty(s.ctx_ref(), s.ast), s.ctx)
11365 if isinstance(s, ReSortRef):
11366 return ReRef(Z3_mk_re_empty(s.ctx_ref(), s.ast), s.ctx)
11367 raise Z3Exception("Non-sequence, non-regular expression sort passed to Empty")
11371 """Create the regular expression that accepts the universal language
11372 >>> e = Full(ReSort(SeqSort(IntSort())))
11374 Full(ReSort(Seq(Int)))
11375 >>> e1 = Full(ReSort(StringSort()))
11377 Full(ReSort(String))
11379 if isinstance(s, ReSortRef):
11380 return ReRef(Z3_mk_re_full(s.ctx_ref(), s.ast), s.ctx)
11381 raise Z3Exception("Non-sequence, non-regular expression sort passed to Full")
11386 """Create a singleton sequence"""
11387 return SeqRef(Z3_mk_seq_unit(a.ctx_ref(), a.as_ast()), a.ctx)
11391 """Check if 'a' is a prefix of 'b'
11392 >>> s1 = PrefixOf("ab", "abc")
11395 >>> s2 = PrefixOf("bc", "abc")
11399 ctx = _get_ctx2(a, b)
11400 a = _coerce_seq(a, ctx)
11401 b = _coerce_seq(b, ctx)
11402 return BoolRef(Z3_mk_seq_prefix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11406 """Check if 'a' is a suffix of 'b'
11407 >>> s1 = SuffixOf("ab", "abc")
11410 >>> s2 = SuffixOf("bc", "abc")
11414 ctx = _get_ctx2(a, b)
11415 a = _coerce_seq(a, ctx)
11416 b = _coerce_seq(b, ctx)
11417 return BoolRef(Z3_mk_seq_suffix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11421 """Check if 'a' contains 'b'
11422 >>> s1 = Contains("abc", "ab")
11425 >>> s2 = Contains("abc", "bc")
11428 >>> x, y, z = Strings('x y z')
11429 >>> s3 = Contains(Concat(x,y,z), y)
11433 ctx = _get_ctx2(a, b)
11434 a = _coerce_seq(a, ctx)
11435 b = _coerce_seq(b, ctx)
11436 return BoolRef(Z3_mk_seq_contains(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11439def Replace(s, src, dst):
11440 """Replace the first occurrence of 'src' by 'dst' in 's'
11441 >>> r = Replace("aaa", "a", "b")
11445 ctx = _get_ctx2(dst, s)
11446 if ctx is None and is_expr(src):
11448 src = _coerce_seq(src, ctx)
11449 dst = _coerce_seq(dst, ctx)
11450 s = _coerce_seq(s, ctx)
11451 return SeqRef(Z3_mk_seq_replace(src.ctx_ref(), s.as_ast(), src.as_ast(), dst.as_ast()), s.ctx)
11454def IndexOf(s, substr, offset=None):
11455 """Retrieve the index of substring within a string starting at a specified offset.
11456 >>> simplify(IndexOf("abcabc", "bc", 0))
11458 >>> simplify(IndexOf("abcabc", "bc", 2))
11464 if is_expr(offset):
11466 ctx = _get_ctx2(s, substr, ctx)
11467 s = _coerce_seq(s, ctx)
11468 substr = _coerce_seq(substr, ctx)
11469 if _is_int(offset):
11470 offset = IntVal(offset, ctx)
11471 return ArithRef(Z3_mk_seq_index(s.ctx_ref(), s.as_ast(), substr.as_ast(), offset.as_ast()), s.ctx)
11474def LastIndexOf(s, substr):
11475 """Retrieve the last index of substring within a string"""
11477 ctx = _get_ctx2(s, substr, ctx)
11478 s = _coerce_seq(s, ctx)
11479 substr = _coerce_seq(substr, ctx)
11480 return ArithRef(Z3_mk_seq_last_index(s.ctx_ref(), s.as_ast(), substr.as_ast()), s.ctx)
11484 """Obtain the length of a sequence 's'
11485 >>> l = Length(StringVal("abc"))
11490 return ArithRef(Z3_mk_seq_length(s.ctx_ref(), s.as_ast()), s.ctx)
11493 """Map function 'f' over sequence 's'"""
11494 ctx = _get_ctx2(f, s)
11495 s = _coerce_seq(s, ctx)
11496 return _to_expr_ref(Z3_mk_seq_map(s.ctx_ref(), f.as_ast(), s.as_ast()), ctx)
11498def SeqMapI(f, i, s):
11499 """Map function 'f' over sequence 's' at index 'i'"""
11500 ctx = _get_ctx2(f, s)
11501 s = _coerce_seq(s, ctx)
11504 return _to_expr_ref(Z3_mk_seq_mapi(s.ctx_ref(), f.as_ast(), i.as_ast(), s.as_ast()), ctx)
11506def SeqFoldLeft(f, a, s):
11507 ctx = _get_ctx2(f, s)
11508 s = _coerce_seq(s, ctx)
11510 return _to_expr_ref(Z3_mk_seq_foldl(s.ctx_ref(), f.as_ast(), a.as_ast(), s.as_ast()), ctx)
11512def SeqFoldLeftI(f, i, a, s):
11513 ctx = _get_ctx2(f, s)
11514 s = _coerce_seq(s, ctx)
11517 return _to_expr_ref(Z3_mk_seq_foldli(s.ctx_ref(), f.as_ast(), i.as_ast(), a.as_ast(), s.as_ast()), ctx)
11520 """Convert string expression to integer
11521 >>> a = StrToInt("1")
11522 >>> simplify(1 == a)
11524 >>> b = StrToInt("2")
11525 >>> simplify(1 == b)
11527 >>> c = StrToInt(IntToStr(2))
11528 >>> simplify(1 == c)
11532 return ArithRef(Z3_mk_str_to_int(s.ctx_ref(), s.as_ast()), s.ctx)
11536 """Convert integer expression to string"""
11539 return SeqRef(Z3_mk_int_to_str(s.ctx_ref(), s.as_ast()), s.ctx)
11543 """Convert a unit length string to integer code"""
11546 return ArithRef(Z3_mk_string_to_code(s.ctx_ref(), s.as_ast()), s.ctx)
11549 """Convert code to a string"""
11552 return SeqRef(Z3_mk_string_from_code(c.ctx_ref(), c.as_ast()), c.ctx)
11554def Re(s, ctx=None):
11555 """The regular expression that accepts sequence 's'
11557 >>> s2 = Re(StringVal("ab"))
11558 >>> s3 = Re(Unit(BoolVal(True)))
11560 s = _coerce_seq(s, ctx)
11561 return ReRef(Z3_mk_seq_to_re(s.ctx_ref(), s.as_ast()), s.ctx)
11564# Regular expressions
11566class ReSortRef(SortRef):
11567 """Regular expression sort."""
11570 return _to_sort_ref(Z3_get_re_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11575 return ReSortRef(Z3_mk_re_sort(s.ctx.ref(), s.ast), s.ctx)
11576 if s is None or isinstance(s, Context):
11578 return ReSortRef(Z3_mk_re_sort(ctx.ref(), Z3_mk_string_sort(ctx.ref())), s.ctx)
11579 raise Z3Exception("Regular expression sort constructor expects either a string or a context or no argument")
11582class ReRef(ExprRef):
11583 """Regular expressions."""
11585 def __add__(self, other):
11586 return Union(self, other)
11590 return isinstance(s, ReRef)
11594 """Create regular expression membership test
11595 >>> re = Union(Re("a"),Re("b"))
11596 >>> print (simplify(InRe("a", re)))
11598 >>> print (simplify(InRe("b", re)))
11600 >>> print (simplify(InRe("c", re)))
11603 s = _coerce_seq(s, re.ctx)
11604 return BoolRef(Z3_mk_seq_in_re(s.ctx_ref(), s.as_ast(), re.as_ast()), s.ctx)
11608 """Create union of regular expressions.
11609 >>> re = Union(Re("a"), Re("b"), Re("c"))
11610 >>> print (simplify(InRe("d", re)))
11613 args = _get_args(args)
11616 _z3_assert(sz > 0, "At least one argument expected.")
11617 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11622 for i in range(sz):
11623 v[i] = args[i].as_ast()
11624 return ReRef(Z3_mk_re_union(ctx.ref(), sz, v), ctx)
11627def Intersect(*args):
11628 """Create intersection of regular expressions.
11629 >>> re = Intersect(Re("a"), Re("b"), Re("c"))
11631 args = _get_args(args)
11634 _z3_assert(sz > 0, "At least one argument expected.")
11635 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11640 for i in range(sz):
11641 v[i] = args[i].as_ast()
11642 return ReRef(Z3_mk_re_intersect(ctx.ref(), sz, v), ctx)
11646 """Create the regular expression accepting one or more repetitions of argument.
11647 >>> re = Plus(Re("a"))
11648 >>> print(simplify(InRe("aa", re)))
11650 >>> print(simplify(InRe("ab", re)))
11652 >>> print(simplify(InRe("", re)))
11656 _z3_assert(is_expr(re), "expression expected")
11657 return ReRef(Z3_mk_re_plus(re.ctx_ref(), re.as_ast()), re.ctx)
11661 """Create the regular expression that optionally accepts the argument.
11662 >>> re = Option(Re("a"))
11663 >>> print(simplify(InRe("a", re)))
11665 >>> print(simplify(InRe("", re)))
11667 >>> print(simplify(InRe("aa", re)))
11671 _z3_assert(is_expr(re), "expression expected")
11672 return ReRef(Z3_mk_re_option(re.ctx_ref(), re.as_ast()), re.ctx)
11676 """Create the complement regular expression."""
11677 return ReRef(Z3_mk_re_complement(re.ctx_ref(), re.as_ast()), re.ctx)
11681 """Create the regular expression accepting zero or more repetitions of argument.
11682 >>> re = Star(Re("a"))
11683 >>> print(simplify(InRe("aa", re)))
11685 >>> print(simplify(InRe("ab", re)))
11687 >>> print(simplify(InRe("", re)))
11691 _z3_assert(is_expr(re), "expression expected")
11692 return ReRef(Z3_mk_re_star(re.ctx_ref(), re.as_ast()), re.ctx)
11695def Loop(re, lo, hi=0):
11696 """Create the regular expression accepting between a lower and upper bound repetitions
11697 >>> re = Loop(Re("a"), 1, 3)
11698 >>> print(simplify(InRe("aa", re)))
11700 >>> print(simplify(InRe("aaaa", re)))
11702 >>> print(simplify(InRe("", re)))
11706 _z3_assert(is_expr(re), "expression expected")
11707 return ReRef(Z3_mk_re_loop(re.ctx_ref(), re.as_ast(), lo, hi), re.ctx)
11710def Range(lo, hi, ctx=None):
11711 """Create the range regular expression over two sequences of length 1
11712 >>> range = Range("a","z")
11713 >>> print(simplify(InRe("b", range)))
11715 >>> print(simplify(InRe("bb", range)))
11718 lo = _coerce_seq(lo, ctx)
11719 hi = _coerce_seq(hi, ctx)
11721 _z3_assert(is_expr(lo), "expression expected")
11722 _z3_assert(is_expr(hi), "expression expected")
11723 return ReRef(Z3_mk_re_range(lo.ctx_ref(), lo.ast, hi.ast), lo.ctx)
11725def Diff(a, b, ctx=None):
11726 """Create the difference regular expression
11729 _z3_assert(is_expr(a), "expression expected")
11730 _z3_assert(is_expr(b), "expression expected")
11731 return ReRef(Z3_mk_re_diff(a.ctx_ref(), a.ast, b.ast), a.ctx)
11733def AllChar(regex_sort, ctx=None):
11734 """Create a regular expression that accepts all single character strings
11736 return ReRef(Z3_mk_re_allchar(regex_sort.ctx_ref(), regex_sort.ast), regex_sort.ctx)
11741def PartialOrder(a, index):
11742 return FuncDeclRef(Z3_mk_partial_order(a.ctx_ref(), a.ast, index), a.ctx)
11745def LinearOrder(a, index):
11746 return FuncDeclRef(Z3_mk_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11749def TreeOrder(a, index):
11750 return FuncDeclRef(Z3_mk_tree_order(a.ctx_ref(), a.ast, index), a.ctx)
11753def PiecewiseLinearOrder(a, index):
11754 return FuncDeclRef(Z3_mk_piecewise_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11757def TransitiveClosure(f):
11758 """Given a binary relation R, such that the two arguments have the same sort
11759 create the transitive closure relation R+.
11760 The transitive closure R+ is a new relation.
11762 return FuncDeclRef(Z3_mk_transitive_closure(f.ctx_ref(), f.ast), f.ctx)
11766 super(ctypes.c_void_p, ast).__init__(ptr)
11769def to_ContextObj(ptr,):
11770 ctx = ContextObj(ptr)
11771 super(ctypes.c_void_p, ctx).__init__(ptr)
11774def to_AstVectorObj(ptr,):
11775 v = AstVectorObj(ptr)
11776 super(ctypes.c_void_p, v).__init__(ptr)
11779# NB. my-hacky-class only works for a single instance of OnClause
11780# it should be replaced with a proper correlation between OnClause
11781# and object references that can be passed over the FFI.
11782# for UserPropagator we use a global dictionary, which isn't great code.
11784_my_hacky_class = None
11785def on_clause_eh(ctx, p, n, dep, clause):
11786 onc = _my_hacky_class
11787 p = _to_expr_ref(to_Ast(p), onc.ctx)
11788 clause = AstVector(to_AstVectorObj(clause), onc.ctx)
11789 deps = [dep[i] for i in range(n)]
11790 onc.on_clause(p, deps, clause)
11792_on_clause_eh = Z3_on_clause_eh(on_clause_eh)
11795 def __init__(self, s, on_clause):
11798 self.on_clause = on_clause
11800 global _my_hacky_class
11801 _my_hacky_class = self
11802 Z3_solver_register_on_clause(self.ctx.ref(), self.s.solver, self.idx, _on_clause_eh)
11806 def __init__(self):
11810 def set_threaded(self):
11811 if self.lock is None:
11813 self.lock = threading.Lock()
11815 def get(self, ctx):
11818 r = self.bases[ctx]
11820 r = self.bases[ctx]
11823 def set(self, ctx, r):
11826 self.bases[ctx] = r
11828 self.bases[ctx] = r
11830 def insert(self, r):
11833 id = len(self.bases) + 3
11836 id = len(self.bases) + 3
11841_prop_closures = None
11844def ensure_prop_closures():
11845 global _prop_closures
11846 if _prop_closures is None:
11847 _prop_closures = PropClosures()
11850def user_prop_push(ctx, cb):
11851 prop = _prop_closures.get(ctx)
11856def user_prop_pop(ctx, cb, num_scopes):
11857 prop = _prop_closures.get(ctx)
11859 prop.pop(num_scopes)
11862def user_prop_fresh(ctx, _new_ctx):
11863 _prop_closures.set_threaded()
11864 prop = _prop_closures.get(ctx)
11866 Z3_del_context(nctx.ctx)
11867 new_ctx = to_ContextObj(_new_ctx)
11869 nctx.eh = Z3_set_error_handler(new_ctx, z3_error_handler)
11871 new_prop = prop.fresh(nctx)
11872 _prop_closures.set(new_prop.id, new_prop)
11876def user_prop_fixed(ctx, cb, id, value):
11877 prop = _prop_closures.get(ctx)
11880 id = _to_expr_ref(to_Ast(id), prop.ctx())
11881 value = _to_expr_ref(to_Ast(value), prop.ctx())
11882 prop.fixed(id, value)
11885def user_prop_created(ctx, cb, id):
11886 prop = _prop_closures.get(ctx)
11889 id = _to_expr_ref(to_Ast(id), prop.ctx())
11894def user_prop_final(ctx, cb):
11895 prop = _prop_closures.get(ctx)
11901def user_prop_eq(ctx, cb, x, y):
11902 prop = _prop_closures.get(ctx)
11905 x = _to_expr_ref(to_Ast(x), prop.ctx())
11906 y = _to_expr_ref(to_Ast(y), prop.ctx())
11910def user_prop_diseq(ctx, cb, x, y):
11911 prop = _prop_closures.get(ctx)
11914 x = _to_expr_ref(to_Ast(x), prop.ctx())
11915 y = _to_expr_ref(to_Ast(y), prop.ctx())
11919def user_prop_decide(ctx, cb, t_ref, idx, phase):
11920 prop = _prop_closures.get(ctx)
11923 t = _to_expr_ref(to_Ast(t_ref), prop.ctx())
11924 prop.decide(t, idx, phase)
11927def user_prop_binding(ctx, cb, q_ref, inst_ref):
11928 prop = _prop_closures.get(ctx)
11931 q = _to_expr_ref(to_Ast(q_ref), prop.ctx())
11932 inst = _to_expr_ref(to_Ast(inst_ref), prop.ctx())
11933 r = prop.binding(q, inst)
11938_user_prop_push = Z3_push_eh(user_prop_push)
11939_user_prop_pop = Z3_pop_eh(user_prop_pop)
11940_user_prop_fresh = Z3_fresh_eh(user_prop_fresh)
11941_user_prop_fixed = Z3_fixed_eh(user_prop_fixed)
11942_user_prop_created = Z3_created_eh(user_prop_created)
11943_user_prop_final = Z3_final_eh(user_prop_final)
11944_user_prop_eq = Z3_eq_eh(user_prop_eq)
11945_user_prop_diseq = Z3_eq_eh(user_prop_diseq)
11946_user_prop_decide = Z3_decide_eh(user_prop_decide)
11947_user_prop_binding = Z3_on_binding_eh(user_prop_binding)
11950def PropagateFunction(name, *sig):
11951 """Create a function that gets tracked by user propagator.
11952 Every term headed by this function symbol is tracked.
11953 If a term is fixed and the fixed callback is registered a
11954 callback is invoked that the term headed by this function is fixed.
11956 sig = _get_args(sig)
11958 _z3_assert(len(sig) > 0, "At least two arguments expected")
11959 arity = len(sig) - 1
11962 _z3_assert(is_sort(rng), "Z3 sort expected")
11963 dom = (Sort * arity)()
11964 for i in range(arity):
11966 _z3_assert(is_sort(sig[i]), "Z3 sort expected")
11967 dom[i] = sig[i].ast
11969 return FuncDeclRef(Z3_solver_propagate_declare(ctx.ref(), to_symbol(name, ctx), arity, dom, rng.ast), ctx)
11973class UserPropagateBase:
11976 # Either solver is set or ctx is set.
11977 # Propagators that are created through callbacks
11978 # to "fresh" inherit the context of that is supplied
11979 # as argument to the callback.
11980 # This context should not be deleted. It is owned by the solver.
11982 def __init__(self, s, ctx=None):
11983 assert s is None or ctx is None
11984 ensure_prop_closures()
11987 self.fresh_ctx = None
11989 self.id = _prop_closures.insert(self)
11995 self.created = None
11996 self.binding = None
11998 self.fresh_ctx = ctx
12000 Z3_solver_propagate_init(self.ctx_ref(),
12002 ctypes.c_void_p(self.id),
12009 self._ctx.ctx = None
12013 return self.fresh_ctx
12015 return self.solver.ctx
12018 return self.ctx().ref()
12020 def add_fixed(self, fixed):
12022 raise Z3Exception("fixed callback already registered")
12024 raise Z3Exception("context already initialized")
12026 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
12029 def add_created(self, created):
12031 raise Z3Exception("created callback already registered")
12033 raise Z3Exception("context already initialized")
12035 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
12036 self.created = created
12038 def add_final(self, final):
12040 raise Z3Exception("final callback already registered")
12042 raise Z3Exception("context already initialized")
12044 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
12047 def add_eq(self, eq):
12049 raise Z3Exception("eq callback already registered")
12051 raise Z3Exception("context already initialized")
12053 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
12056 def add_diseq(self, diseq):
12058 raise Z3Exception("diseq callback already registered")
12060 raise Z3Exception("context already initialized")
12062 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
12065 def add_decide(self, decide):
12067 raise Z3Exception("decide callback already registered")
12069 raise Z3Exception("context already initialized")
12071 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
12072 self.decide = decide
12074 def add_on_binding(self, binding):
12076 raise Z3Exception("binding callback already registered")
12078 raise Z3Exception("context already initialized")
12080 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
12081 self.binding = binding
12084 raise Z3Exception("push needs to be overwritten")
12086 def pop(self, num_scopes):
12087 raise Z3Exception("pop needs to be overwritten")
12089 def fresh(self, new_ctx):
12090 raise Z3Exception("fresh needs to be overwritten")
12094 raise Z3Exception("context already initialized")
12096 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12098 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12101 # Tell the solver to perform the next split on a given term
12102 # If the term is a bit-vector the index idx specifies the index of the Boolean variable being
12103 # split on. A phase of true = 1/false = -1/undef = 0 = let solver decide is the last argument.
12105 def next_split(self, t, idx, phase):
12106 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12109 # Propagation can only be invoked as during a fixed or final callback.
12111 def propagate(self, e, ids, eqs=[]):
12112 _ids, num_fixed = _to_ast_array(ids)
12114 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12115 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12116 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12117 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12119 def conflict(self, deps = [], eqs = []):
12120 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=[])