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."""
250 """Return a reference to the global Z3 context.
253 >>> x.ctx == main_ctx()
258 >>> x2 = Real('x', c)
265 if _main_ctx
is None:
282 """Set Z3 global (or module) parameters.
284 >>> set_param(precision=10)
287 _z3_assert(len(args) % 2 == 0,
"Argument list must have an even number of elements.")
291 if not set_pp_option(k, v):
306 """Reset all global (or module) parameters.
312 """Alias for 'set_param' for backward compatibility.
318 """Return the value of a Z3 global (or module) parameter
320 >>> get_param('nlsat.reorder')
323 ptr = (ctypes.c_char_p * 1)()
325 r = z3core._to_pystr(ptr[0])
327 raise Z3Exception(
"failed to retrieve value for '%s'" % name)
339 """Superclass for all Z3 objects that have support for pretty printing."""
345 in_html = in_html_mode()
348 set_html_mode(in_html)
353 """AST are Direct Acyclic Graphs (DAGs) used to represent sorts, declarations and expressions."""
361 if self.
ctx.ref()
is not None and self.
ast is not None and Z3_dec_ref
is not None:
369 return obj_to_string(self)
372 return obj_to_string(self)
375 return self.
eq(other)
388 elif is_eq(self)
and self.num_args() == 2:
389 return self.arg(0).
eq(self.arg(1))
391 raise Z3Exception(
"Symbolic expressions cannot be cast to concrete Boolean values.")
394 """Return a string representing the AST node in s-expression notation.
397 >>> ((x + 1)*x).sexpr()
403 """Return a pointer to the corresponding C Z3_ast object."""
407 """Return unique identifier for object. It can be used for hash-tables and maps."""
411 """Return a reference to the C context where this AST node is stored."""
412 return self.
ctx.ref()
415 """Return `True` if `self` and `other` are structurally identical.
422 >>> n1 = simplify(n1)
423 >>> n2 = simplify(n2)
432 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
438 >>> # Nodes in different contexts can't be mixed.
439 >>> # However, we can translate nodes from one context to another.
440 >>> x.translate(c2) + y
444 _z3_assert(isinstance(target, Context),
"argument must be a Z3 context")
451 """Return a hashcode for the `self`.
453 >>> n1 = simplify(Int('x') + 1)
454 >>> n2 = simplify(2 + Int('x') - 1)
455 >>> n1.hash() == n2.hash()
461 """Return a Python value that is equivalent to `self`."""
466 """Return `True` if `a` is an AST node.
470 >>> is_ast(IntVal(10))
474 >>> is_ast(BoolSort())
476 >>> is_ast(Function('f', IntSort(), IntSort()))
483 return isinstance(a, AstRef)
486def eq(a : AstRef, b : AstRef) -> bool:
487 """Return `True` if `a` and `b` are structurally identical AST nodes.
497 >>> eq(simplify(x + 1), simplify(1 + x))
531 _args = (FuncDecl * sz)()
533 _args[i] = args[i].as_func_decl()
541 _args[i] = args[i].as_ast()
549 _args[i] = args[i].as_ast()
557 elif k == Z3_FUNC_DECL_AST:
574 """A Sort is essentially a type. Every Z3 expression has a sort. A sort is an AST node."""
583 """Return the Z3 internal kind of a sort.
584 This method can be used to test if `self` is one of the Z3 builtin sorts.
587 >>> b.kind() == Z3_BOOL_SORT
589 >>> b.kind() == Z3_INT_SORT
591 >>> A = ArraySort(IntSort(), IntSort())
592 >>> A.kind() == Z3_ARRAY_SORT
594 >>> A.kind() == Z3_INT_SORT
600 """Return `True` if `self` is a subsort of `other`.
602 >>> IntSort().subsort(RealSort())
608 """Try to cast `val` as an element of sort `self`.
610 This method is used in Z3Py to convert Python objects such as integers,
611 floats, longs and strings into Z3 expressions.
614 >>> RealSort().cast(x)
623 """Return the name (string) of sort `self`.
625 >>> BoolSort().name()
627 >>> ArraySort(IntSort(), IntSort()).name()
633 """Return `True` if `self` and `other` are the same Z3 sort.
636 >>> p.sort() == BoolSort()
638 >>> p.sort() == IntSort()
646 """Return `True` if `self` and `other` are not the same Z3 sort.
649 >>> p.sort() != BoolSort()
651 >>> p.sort() != IntSort()
657 """Create the function space Array(self, other)"""
662 return AstRef.__hash__(self)
666 """Return `True` if `s` is a Z3 sort.
668 >>> is_sort(IntSort())
670 >>> is_sort(Int('x'))
672 >>> is_expr(Int('x'))
675 return isinstance(s, SortRef)
680 _z3_assert(isinstance(s, Sort),
"Z3 Sort expected")
682 if k == Z3_BOOL_SORT:
684 elif k == Z3_INT_SORT
or k == Z3_REAL_SORT:
686 elif k == Z3_BV_SORT:
688 elif k == Z3_ARRAY_SORT:
690 elif k == Z3_DATATYPE_SORT:
692 elif k == Z3_FINITE_DOMAIN_SORT:
694 elif k == Z3_FLOATING_POINT_SORT:
696 elif k == Z3_ROUNDING_MODE_SORT:
698 elif k == Z3_RE_SORT:
700 elif k == Z3_SEQ_SORT:
702 elif k == Z3_CHAR_SORT:
704 elif k == Z3_TYPE_VAR:
709def _sort(ctx : Context, a : Any) -> SortRef:
714 """Create a new uninterpreted sort named `name`.
716 If `ctx=None`, then the new sort is declared in the global Z3Py context.
718 >>> A = DeclareSort('A')
719 >>> a = Const('a', A)
720 >>> b = Const('b', A)
732 """Type variable reference"""
742 """Create a new type variable named `name`.
744 If `ctx=None`, then the new sort is declared in the global Z3Py context.
759 """Function declaration. Every constant and function have an associated declaration.
761 The declaration assigns a name, a sort (i.e., type), and for function
762 the sort (i.e., type) of each of its arguments. Note that, in Z3,
763 a constant is a function with 0 arguments.
776 """Return the name of the function declaration `self`.
778 >>> f = Function('f', IntSort(), IntSort())
781 >>> isinstance(f.name(), str)
787 """Return the number of arguments of a function declaration.
788 If `self` is a constant, then `self.arity()` is 0.
790 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
797 """Return the sort of the argument `i` of a function declaration.
798 This method assumes that `0 <= i < self.arity()`.
800 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
809 """Return the sort of the range of a function declaration.
810 For constants, this is the sort of the constant.
812 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
819 """Return the internal kind of a function declaration.
820 It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
823 >>> d = (x + 1).decl()
824 >>> d.kind() == Z3_OP_ADD
826 >>> d.kind() == Z3_OP_MUL
834 result = [
None for i
in range(n)]
837 if k == Z3_PARAMETER_INT:
839 elif k == Z3_PARAMETER_DOUBLE:
841 elif k == Z3_PARAMETER_RATIONAL:
843 elif k == Z3_PARAMETER_SYMBOL:
845 elif k == Z3_PARAMETER_SORT:
847 elif k == Z3_PARAMETER_AST:
849 elif k == Z3_PARAMETER_FUNC_DECL:
851 elif k == Z3_PARAMETER_INTERNAL:
852 result[i] =
"internal parameter"
853 elif k == Z3_PARAMETER_ZSTRING:
854 result[i] =
"internal string"
860 """Create a Z3 application expression using the function `self`, and the given arguments.
862 The arguments must be Z3 expressions. This method assumes that
863 the sorts of the elements in `args` match the sorts of the
864 domain. Limited coercion is supported. For example, if
865 args[0] is a Python integer, and the function expects a Z3
866 integer, then the argument is automatically converted into a
869 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
879 _args = (Ast * num)()
884 tmp = self.
domain(i).cast(args[i])
886 _args[i] = tmp.as_ast()
891 """Return `True` if `a` is a Z3 function declaration.
893 >>> f = Function('f', IntSort(), IntSort())
900 return isinstance(a, FuncDeclRef)
904 """Create a new Z3 uninterpreted function with the given sorts.
906 >>> f = Function('f', IntSort(), IntSort())
912 _z3_assert(len(sig) > 0,
"At least two arguments expected")
917 dom = (Sort * arity)()
918 for i
in range(arity):
927 """Create a new fresh Z3 uninterpreted function with the given sorts.
931 _z3_assert(len(sig) > 0,
"At least two arguments expected")
936 dom = (z3.Sort * arity)()
937 for i
in range(arity):
950 """Create a new Z3 recursive with the given sorts."""
953 _z3_assert(len(sig) > 0,
"At least two arguments expected")
958 dom = (Sort * arity)()
959 for i
in range(arity):
968 """Set the body of a recursive function.
969 Recursive definitions can be simplified if they are applied to ground
972 >>> fac = RecFunction('fac', IntSort(ctx), IntSort(ctx))
973 >>> n = Int('n', ctx)
974 >>> RecAddDefinition(fac, n, If(n == 0, 1, n*fac(n-1)))
977 >>> s = Solver(ctx=ctx)
978 >>> s.add(fac(n) < 3)
981 >>> s.model().eval(fac(5))
991 _args[i] = args[i].ast
1002 """Constraints, formulas and terms are expressions in Z3.
1004 Expressions are ASTs. Every expression has a sort.
1005 There are three main kinds of expressions:
1006 function applications, quantifiers and bounded variables.
1007 A constant is a function application with 0 arguments.
1008 For quantifier free problems, all expressions are
1009 function applications.
1019 """Return the sort of expression `self`.
1031 """Shorthand for `self.sort().kind()`.
1033 >>> a = Array('a', IntSort(), IntSort())
1034 >>> a.sort_kind() == Z3_ARRAY_SORT
1036 >>> a.sort_kind() == Z3_INT_SORT
1042 """Return a Z3 expression that represents the constraint `self == other`.
1044 If `other` is `None`, then this method simply returns `False`.
1060 return AstRef.__hash__(self)
1063 """Return a Z3 expression that represents the constraint `self != other`.
1065 If `other` is `None`, then this method simply returns `True`.
1084 """Return the Z3 function declaration associated with a Z3 application.
1086 >>> f = Function('f', IntSort(), IntSort())
1099 """Return the Z3 internal kind of a function application."""
1106 """Return the number of arguments of a Z3 application.
1110 >>> (a + b).num_args()
1112 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1122 """Return argument `idx` of the application `self`.
1124 This method assumes that `self` is a function application with at least `idx+1` arguments.
1128 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1143 """Return a list containing the children of the given expression
1147 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1153 return [self.
arg(i)
for i
in range(self.
num_args())]
1167 """inverse function to the serialize method on ExprRef.
1168 It is made available to make it easier for users to serialize expressions back and forth between
1169 strings. Solvers can be serialized using the 'sexpr()' method.
1173 if len(s.assertions()) != 1:
1174 raise Z3Exception(
"single assertion expected")
1175 fml = s.assertions()[0]
1176 if fml.num_args() != 1:
1177 raise Z3Exception(
"dummy function 'F' expected")
1181 if isinstance(a, Pattern):
1185 if k == Z3_QUANTIFIER_AST:
1188 if sk == Z3_BOOL_SORT:
1190 if sk == Z3_INT_SORT:
1191 if k == Z3_NUMERAL_AST:
1194 if sk == Z3_REAL_SORT:
1195 if k == Z3_NUMERAL_AST:
1200 if sk == Z3_BV_SORT:
1201 if k == Z3_NUMERAL_AST:
1205 if sk == Z3_ARRAY_SORT:
1207 if sk == Z3_DATATYPE_SORT:
1209 if sk == Z3_FLOATING_POINT_SORT:
1213 return FPRef(a, ctx)
1214 if sk == Z3_FINITE_DOMAIN_SORT:
1215 if k == Z3_NUMERAL_AST:
1219 if sk == Z3_ROUNDING_MODE_SORT:
1221 if sk == Z3_SEQ_SORT:
1223 if sk == Z3_CHAR_SORT:
1225 if sk == Z3_RE_SORT:
1226 return ReRef(a, ctx)
1243 _z3_assert(s1.ctx == s.ctx,
"context mismatch")
1249 if not isinstance(a, ExprRef):
1251 if not isinstance(b, ExprRef):
1265 if isinstance(a, str)
and isinstance(b, SeqRef):
1267 if isinstance(b, str)
and isinstance(a, SeqRef):
1269 if isinstance(a, float)
and isinstance(b, ArithRef):
1271 if isinstance(b, float)
and isinstance(a, ArithRef):
1287 for element
in sequence:
1288 result = func(result, element)
1299 alist = [
_py2expr(a, ctx)
for a
in alist]
1300 s =
_reduce(_coerce_expr_merge, alist,
None)
1301 return [s.cast(a)
for a
in alist]
1305 """Return `True` if `a` is a Z3 expression.
1312 >>> is_expr(IntSort())
1316 >>> is_expr(IntVal(1))
1319 >>> is_expr(ForAll(x, x >= 0))
1321 >>> is_expr(FPVal(1.0))
1324 return isinstance(a, ExprRef)
1328 """Return `True` if `a` is a Z3 function application.
1330 Note that, constants are function applications with 0 arguments.
1337 >>> is_app(IntSort())
1341 >>> is_app(IntVal(1))
1344 >>> is_app(ForAll(x, x >= 0))
1347 if not isinstance(a, ExprRef):
1350 return k == Z3_NUMERAL_AST
or k == Z3_APP_AST
1354 """Return `True` if `a` is Z3 constant/variable expression.
1363 >>> is_const(IntVal(1))
1366 >>> is_const(ForAll(x, x >= 0))
1369 return is_app(a)
and a.num_args() == 0
1373 """Return `True` if `a` is variable.
1375 Z3 uses de-Bruijn indices for representing bound variables in
1383 >>> f = Function('f', IntSort(), IntSort())
1384 >>> # Z3 replaces x with bound variables when ForAll is executed.
1385 >>> q = ForAll(x, f(x) == x)
1391 >>> is_var(b.arg(1))
1398 """Return the de-Bruijn index of the Z3 bounded variable `a`.
1406 >>> f = Function('f', IntSort(), IntSort(), IntSort())
1407 >>> # Z3 replaces x and y with bound variables when ForAll is executed.
1408 >>> q = ForAll([x, y], f(x, y) == x + y)
1410 f(Var(1), Var(0)) == Var(1) + Var(0)
1414 >>> v1 = b.arg(0).arg(0)
1415 >>> v2 = b.arg(0).arg(1)
1420 >>> get_var_index(v1)
1422 >>> get_var_index(v2)
1431 """Return `True` if `a` is an application of the given kind `k`.
1435 >>> is_app_of(n, Z3_OP_ADD)
1437 >>> is_app_of(n, Z3_OP_MUL)
1440 return is_app(a)
and a.kind() == k
1443def If(a, b, c, ctx=None):
1444 """Create a Z3 if-then-else expression.
1448 >>> max = If(x > y, x, y)
1454 if isinstance(a, Probe)
or isinstance(b, Tactic)
or isinstance(c, Tactic):
1455 return Cond(a, b, c, ctx)
1462 _z3_assert(a.ctx == b.ctx,
"Context mismatch")
1467 """Create a Z3 distinct expression.
1474 >>> Distinct(x, y, z)
1476 >>> simplify(Distinct(x, y, z))
1478 >>> simplify(Distinct(x, y, z), blast_distinct=True)
1479 And(Not(x == y), Not(x == z), Not(y == z))
1484 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression")
1493 _z3_assert(a.ctx == b.ctx,
"Context mismatch")
1494 args[0] = a.as_ast()
1495 args[1] = b.as_ast()
1496 return f(a.ctx.ref(), 2, args)
1500 """Create a constant of the given sort.
1502 >>> Const('x', IntSort())
1506 _z3_assert(isinstance(sort, SortRef),
"Z3 sort expected")
1512 """Create several constants of the given sort.
1514 `names` is a string containing the names of all constants to be created.
1515 Blank spaces separate the names of different constants.
1517 >>> x, y, z = Consts('x y z', IntSort())
1521 if isinstance(names, str):
1522 names = names.split(
" ")
1523 return [
Const(name, sort)
for name
in names]
1527 """Create a fresh constant of a specified sort"""
1534def Var(idx : int, s : SortRef) -> ExprRef:
1535 """Create a Z3 free variable. Free variables are used to create quantified formulas.
1536 A free variable with index n is bound when it occurs within the scope of n+1 quantified
1539 >>> Var(0, IntSort())
1541 >>> eq(Var(0, IntSort()), Var(0, BoolSort()))
1551 Create a real free variable. Free variables are used to create quantified formulas.
1552 They are also used to create polynomials.
1561 Create a list of Real free variables.
1562 The variables have ids: 0, 1, ..., n-1
1564 >>> x0, x1, x2, x3 = RealVarVector(4)
1568 return [
RealVar(i, ctx)
for i
in range(n)]
1581 """Try to cast `val` as a Boolean.
1583 >>> x = BoolSort().cast(True)
1593 if isinstance(val, bool):
1597 msg =
"True, False or Z3 Boolean expression expected. Received %s of type %s"
1599 if not self.
eq(val.sort()):
1600 _z3_assert(self.
eq(val.sort()),
"Value cannot be converted into a Z3 Boolean value")
1604 return isinstance(other, ArithSortRef)
1614 """All Boolean expressions are instances of this class."""
1620 if isinstance(other, BoolRef):
1621 other =
If(other, 1, 0)
1622 return If(self, 1, 0) + other
1631 """Create the Z3 expression `self * other`.
1633 if isinstance(other, int)
and other == 1:
1634 return If(self, 1, 0)
1635 if isinstance(other, int)
and other == 0:
1637 if isinstance(other, BoolRef):
1638 other =
If(other, 1, 0)
1639 return If(self, other, 0)
1642 return And(self, other)
1645 return Or(self, other)
1648 return Xor(self, other)
1664 """Return `True` if `a` is a Z3 Boolean expression.
1670 >>> is_bool(And(p, q))
1678 return isinstance(a, BoolRef)
1682 """Return `True` if `a` is the Z3 true expression.
1687 >>> is_true(simplify(p == p))
1692 >>> # True is a Python Boolean expression
1700 """Return `True` if `a` is the Z3 false expression.
1707 >>> is_false(BoolVal(False))
1714 """Return `True` if `a` is a Z3 and expression.
1716 >>> p, q = Bools('p q')
1717 >>> is_and(And(p, q))
1719 >>> is_and(Or(p, q))
1726 """Return `True` if `a` is a Z3 or expression.
1728 >>> p, q = Bools('p q')
1731 >>> is_or(And(p, q))
1738 """Return `True` if `a` is a Z3 implication expression.
1740 >>> p, q = Bools('p q')
1741 >>> is_implies(Implies(p, q))
1743 >>> is_implies(And(p, q))
1750 """Return `True` if `a` is a Z3 not expression.
1762 """Return `True` if `a` is a Z3 equality expression.
1764 >>> x, y = Ints('x y')
1772 """Return `True` if `a` is a Z3 distinct expression.
1774 >>> x, y, z = Ints('x y z')
1775 >>> is_distinct(x == y)
1777 >>> is_distinct(Distinct(x, y, z))
1784 """Return the Boolean Z3 sort. If `ctx=None`, then the global context is used.
1788 >>> p = Const('p', BoolSort())
1791 >>> r = Function('r', IntSort(), IntSort(), BoolSort())
1794 >>> is_bool(r(0, 1))
1802 """Return the Boolean value `True` or `False`. If `ctx=None`, then the global context is used.
1806 >>> is_true(BoolVal(True))
1810 >>> is_false(BoolVal(False))
1821 """Return a Boolean constant named `name`. If `ctx=None`, then the global context is used.
1833 """Return a tuple of Boolean constants.
1835 `names` is a single string containing all names separated by blank spaces.
1836 If `ctx=None`, then the global context is used.
1838 >>> p, q, r = Bools('p q r')
1839 >>> And(p, Or(q, r))
1843 if isinstance(names, str):
1844 names = names.split(
" ")
1845 return [
Bool(name, ctx)
for name
in names]
1849 """Return a list of Boolean constants of size `sz`.
1851 The constants are named using the given prefix.
1852 If `ctx=None`, then the global context is used.
1854 >>> P = BoolVector('p', 3)
1858 And(p__0, p__1, p__2)
1860 return [
Bool(
"%s__%s" % (prefix, i))
for i
in range(sz)]
1864 """Return a fresh Boolean constant in the given context using the given prefix.
1866 If `ctx=None`, then the global context is used.
1868 >>> b1 = FreshBool()
1869 >>> b2 = FreshBool()
1878 """Create a Z3 implies expression.
1880 >>> p, q = Bools('p q')
1892 """Create a Z3 Xor expression.
1894 >>> p, q = Bools('p q')
1897 >>> simplify(Xor(p, q))
1908 """Create a Z3 not expression or probe.
1913 >>> simplify(Not(Not(p)))
1934 """Return `True` if one of the elements of the given collection is a Z3 probe."""
1942 """Create a Z3 and-expression or and-probe.
1944 >>> p, q, r = Bools('p q r')
1947 >>> P = BoolVector('p', 5)
1949 And(p__0, p__1, p__2, p__3, p__4)
1953 last_arg = args[len(args) - 1]
1954 if isinstance(last_arg, Context):
1955 ctx = args[len(args) - 1]
1956 args = args[:len(args) - 1]
1957 elif len(args) == 1
and isinstance(args[0], AstVector):
1959 args = [a
for a
in args[0]]
1965 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression or probe")
1975 """Create a Z3 or-expression or or-probe.
1977 >>> p, q, r = Bools('p q r')
1980 >>> P = BoolVector('p', 5)
1982 Or(p__0, p__1, p__2, p__3, p__4)
1986 last_arg = args[len(args) - 1]
1987 if isinstance(last_arg, Context):
1988 ctx = args[len(args) - 1]
1989 args = args[:len(args) - 1]
1990 elif len(args) == 1
and isinstance(args[0], AstVector):
1992 args = [a
for a
in args[0]]
1998 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression or probe")
2014 """Patterns are hints for quantifier instantiation.
2026 """Return `True` if `a` is a Z3 pattern (hint for quantifier instantiation.
2028 >>> f = Function('f', IntSort(), IntSort())
2030 >>> q = ForAll(x, f(x) == 0, patterns = [ f(x) ])
2032 ForAll(x, f(x) == 0)
2033 >>> q.num_patterns()
2035 >>> is_pattern(q.pattern(0))
2040 return isinstance(a, PatternRef)
2044 """Create a Z3 multi-pattern using the given expressions `*args`
2046 >>> f = Function('f', IntSort(), IntSort())
2047 >>> g = Function('g', IntSort(), IntSort())
2049 >>> q = ForAll(x, f(x) != g(x), patterns = [ MultiPattern(f(x), g(x)) ])
2051 ForAll(x, f(x) != g(x))
2052 >>> q.num_patterns()
2054 >>> is_pattern(q.pattern(0))
2057 MultiPattern(f(Var(0)), g(Var(0)))
2060 _z3_assert(len(args) > 0,
"At least one argument expected")
2081 """Universally and Existentially quantified formulas."""
2090 """Return the Boolean sort or sort of Lambda."""
2096 """Return `True` if `self` is a universal quantifier.
2098 >>> f = Function('f', IntSort(), IntSort())
2100 >>> q = ForAll(x, f(x) == 0)
2103 >>> q = Exists(x, f(x) != 0)
2110 """Return `True` if `self` is an existential quantifier.
2112 >>> f = Function('f', IntSort(), IntSort())
2114 >>> q = ForAll(x, f(x) == 0)
2117 >>> q = Exists(x, f(x) != 0)
2124 """Return `True` if `self` is a lambda expression.
2126 >>> f = Function('f', IntSort(), IntSort())
2128 >>> q = Lambda(x, f(x))
2131 >>> q = Exists(x, f(x) != 0)
2138 """Return the Z3 expression `self[arg]`.
2145 """Return the weight annotation of `self`.
2147 >>> f = Function('f', IntSort(), IntSort())
2149 >>> q = ForAll(x, f(x) == 0)
2152 >>> q = ForAll(x, f(x) == 0, weight=10)
2159 """Return the skolem id of `self`.
2164 """Return the quantifier id of `self`.
2169 """Return the number of patterns (i.e., quantifier instantiation hints) in `self`.
2171 >>> f = Function('f', IntSort(), IntSort())
2172 >>> g = Function('g', IntSort(), IntSort())
2174 >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2175 >>> q.num_patterns()
2181 """Return a pattern (i.e., quantifier instantiation hints) in `self`.
2183 >>> f = Function('f', IntSort(), IntSort())
2184 >>> g = Function('g', IntSort(), IntSort())
2186 >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2187 >>> q.num_patterns()
2199 """Return the number of no-patterns."""
2203 """Return a no-pattern."""
2209 """Return the expression being quantified.
2211 >>> f = Function('f', IntSort(), IntSort())
2213 >>> q = ForAll(x, f(x) == 0)
2220 """Return the number of variables bounded by this quantifier.
2222 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2225 >>> q = ForAll([x, y], f(x, y) >= x)
2232 """Return a string representing a name used when displaying the quantifier.
2234 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2237 >>> q = ForAll([x, y], f(x, y) >= x)
2248 """Return the sort of a bound variable.
2250 >>> f = Function('f', IntSort(), RealSort(), IntSort())
2253 >>> q = ForAll([x, y], f(x, y) >= x)
2264 """Return a list containing a single element self.body()
2266 >>> f = Function('f', IntSort(), IntSort())
2268 >>> q = ForAll(x, f(x) == 0)
2272 return [self.
body()]
2276 """Return `True` if `a` is a Z3 quantifier.
2278 >>> f = Function('f', IntSort(), IntSort())
2280 >>> q = ForAll(x, f(x) == 0)
2281 >>> is_quantifier(q)
2283 >>> is_quantifier(f(x))
2286 return isinstance(a, QuantifierRef)
2289def _mk_quantifier(is_forall, vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2294 _z3_assert(all([
is_expr(p)
for p
in no_patterns]),
"no patterns are Z3 expressions")
2305 _vs = (Ast * num_vars)()
2306 for i
in range(num_vars):
2308 _vs[i] = vs[i].as_ast()
2310 num_pats = len(patterns)
2311 _pats = (Pattern * num_pats)()
2312 for i
in range(num_pats):
2313 _pats[i] = patterns[i].ast
2320 num_no_pats, _no_pats,
2321 body.as_ast()), ctx)
2324def ForAll(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2325 """Create a Z3 forall formula.
2327 The parameters `weight`, `qid`, `skid`, `patterns` and `no_patterns` are optional annotations.
2329 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2332 >>> ForAll([x, y], f(x, y) >= x)
2333 ForAll([x, y], f(x, y) >= x)
2334 >>> ForAll([x, y], f(x, y) >= x, patterns=[ f(x, y) ])
2335 ForAll([x, y], f(x, y) >= x)
2336 >>> ForAll([x, y], f(x, y) >= x, weight=10)
2337 ForAll([x, y], f(x, y) >= x)
2339 return _mk_quantifier(
True, vs, body, weight, qid, skid, patterns, no_patterns)
2342def Exists(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2343 """Create a Z3 exists formula.
2345 The parameters `weight`, `qif`, `skid`, `patterns` and `no_patterns` are optional annotations.
2348 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2351 >>> q = Exists([x, y], f(x, y) >= x, skid="foo")
2353 Exists([x, y], f(x, y) >= x)
2354 >>> is_quantifier(q)
2356 >>> r = Tactic('nnf')(q).as_expr()
2357 >>> is_quantifier(r)
2360 return _mk_quantifier(
False, vs, body, weight, qid, skid, patterns, no_patterns)
2364 """Create a Z3 lambda expression.
2366 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2367 >>> mem0 = Array('mem0', IntSort(), IntSort())
2368 >>> lo, hi, e, i = Ints('lo hi e i')
2369 >>> mem1 = Lambda([i], If(And(lo <= i, i <= hi), e, mem0[i]))
2371 Lambda(i, If(And(lo <= i, i <= hi), e, mem0[i]))
2377 _vs = (Ast * num_vars)()
2378 for i
in range(num_vars):
2380 _vs[i] = vs[i].as_ast()
2391 """Real and Integer sorts."""
2394 """Return `True` if `self` is of the sort Real.
2399 >>> (x + 1).is_real()
2405 return self.
kind() == Z3_REAL_SORT
2408 """Return `True` if `self` is of the sort Integer.
2413 >>> (x + 1).is_int()
2419 return self.
kind() == Z3_INT_SORT
2425 """Return `True` if `self` is a subsort of `other`."""
2429 """Try to cast `val` as an Integer or Real.
2431 >>> IntSort().cast(10)
2433 >>> is_int(IntSort().cast(10))
2437 >>> RealSort().cast(10)
2439 >>> is_real(RealSort().cast(10))
2448 if val_s.is_int()
and self.
is_real():
2450 if val_s.is_bool()
and self.
is_int():
2451 return If(val, 1, 0)
2452 if val_s.is_bool()
and self.
is_real():
2455 _z3_assert(
False,
"Z3 Integer/Real expression expected")
2462 msg =
"int, long, float, string (numeral), or Z3 Integer/Real expression expected. Got %s"
2467 """Return `True` if s is an arithmetical sort (type).
2469 >>> is_arith_sort(IntSort())
2471 >>> is_arith_sort(RealSort())
2473 >>> is_arith_sort(BoolSort())
2475 >>> n = Int('x') + 1
2476 >>> is_arith_sort(n.sort())
2479 return isinstance(s, ArithSortRef)
2483 """Integer and Real expressions."""
2486 """Return the sort (type) of the arithmetical expression `self`.
2490 >>> (Real('x') + 1).sort()
2496 """Return `True` if `self` is an integer expression.
2501 >>> (x + 1).is_int()
2504 >>> (x + y).is_int()
2510 """Return `True` if `self` is an real expression.
2515 >>> (x + 1).is_real()
2521 """Create the Z3 expression `self + other`.
2534 """Create the Z3 expression `other + self`.
2544 """Create the Z3 expression `self * other`.
2553 if isinstance(other, BoolRef):
2554 return If(other, self, 0)
2559 """Create the Z3 expression `other * self`.
2569 """Create the Z3 expression `self - other`.
2582 """Create the Z3 expression `other - self`.
2592 """Create the Z3 expression `self**other` (** is the power operator).
2599 >>> simplify(IntVal(2)**8)
2606 """Create the Z3 expression `other**self` (** is the power operator).
2613 >>> simplify(2**IntVal(8))
2620 """Create the Z3 expression `other/self`.
2643 """Create the Z3 expression `other/self`."""
2647 """Create the Z3 expression `other/self`.
2664 """Create the Z3 expression `other/self`."""
2668 """Create the Z3 expression `other%self`.
2674 >>> simplify(IntVal(10) % IntVal(3))
2679 _z3_assert(a.is_int(),
"Z3 integer expression expected")
2683 """Create the Z3 expression `other%self`.
2691 _z3_assert(a.is_int(),
"Z3 integer expression expected")
2695 """Return an expression representing `-self`.
2715 """Create the Z3 expression `other <= self`.
2717 >>> x, y = Ints('x y')
2728 """Create the Z3 expression `other < self`.
2730 >>> x, y = Ints('x y')
2741 """Create the Z3 expression `other > self`.
2743 >>> x, y = Ints('x y')
2754 """Create the Z3 expression `other >= self`.
2756 >>> x, y = Ints('x y')
2768 """Return `True` if `a` is an arithmetical expression.
2777 >>> is_arith(IntVal(1))
2785 return isinstance(a, ArithRef)
2789 """Return `True` if `a` is an integer expression.
2796 >>> is_int(IntVal(1))
2808 """Return `True` if `a` is a real expression.
2820 >>> is_real(RealVal(1))
2835 """Return `True` if `a` is an integer value of sort Int.
2837 >>> is_int_value(IntVal(1))
2841 >>> is_int_value(Int('x'))
2843 >>> n = Int('x') + 1
2848 >>> is_int_value(n.arg(1))
2850 >>> is_int_value(RealVal("1/3"))
2852 >>> is_int_value(RealVal(1))
2859 """Return `True` if `a` is rational value of sort Real.
2861 >>> is_rational_value(RealVal(1))
2863 >>> is_rational_value(RealVal("3/5"))
2865 >>> is_rational_value(IntVal(1))
2867 >>> is_rational_value(1)
2869 >>> n = Real('x') + 1
2872 >>> is_rational_value(n.arg(1))
2874 >>> is_rational_value(Real('x'))
2881 """Return `True` if `a` is an algebraic value of sort Real.
2883 >>> is_algebraic_value(RealVal("3/5"))
2885 >>> n = simplify(Sqrt(2))
2888 >>> is_algebraic_value(n)
2895 """Return `True` if `a` is an expression of the form b + c.
2897 >>> x, y = Ints('x y')
2907 """Return `True` if `a` is an expression of the form b * c.
2909 >>> x, y = Ints('x y')
2919 """Return `True` if `a` is an expression of the form b - c.
2921 >>> x, y = Ints('x y')
2931 """Return `True` if `a` is an expression of the form b / c.
2933 >>> x, y = Reals('x y')
2938 >>> x, y = Ints('x y')
2948 """Return `True` if `a` is an expression of the form b div 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 = Ints('x y')
2984 """Return `True` if `a` is an expression of the form b < c.
2986 >>> x, y = Ints('x y')
2996 """Return `True` if `a` is an expression of the form b >= c.
2998 >>> x, y = Ints('x y')
3008 """Return `True` if `a` is an expression of the form b > c.
3010 >>> x, y = Ints('x y')
3020 """Return `True` if `a` is an expression of the form IsInt(b).
3023 >>> is_is_int(IsInt(x))
3032 """Return `True` if `a` is an expression of the form ToReal(b).
3047 """Return `True` if `a` is an expression of the form ToInt(b).
3062 """Integer values."""
3065 """Return a Z3 integer numeral as a Python long (bignum) numeral.
3078 """Return a Z3 integer numeral as a Python string.
3086 """Return a Z3 integer numeral as a Python binary string.
3088 >>> v.as_binary_string()
3098 """Rational values."""
3101 """ Return the numerator of a Z3 rational numeral.
3103 >>> is_rational_value(RealVal("3/5"))
3105 >>> n = RealVal("3/5")
3108 >>> is_rational_value(Q(3,5))
3110 >>> Q(3,5).numerator()
3116 """ Return the denominator of a Z3 rational numeral.
3118 >>> is_rational_value(Q(3,5))
3127 """ Return the numerator as a Python long.
3129 >>> v = RealVal(10000000000)
3134 >>> v.numerator_as_long() + 1 == 10000000001
3140 """ Return the denominator as a Python long.
3142 >>> v = RealVal("1/3")
3145 >>> v.denominator_as_long()
3164 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3166 >>> v = RealVal("1/5")
3169 >>> v = RealVal("1/3")
3176 """Return a Z3 rational numeral as a Python string.
3185 """Return a Z3 rational as a Python Fraction object.
3187 >>> v = RealVal("1/5")
3198 """Algebraic irrational values."""
3201 """Return a Z3 rational number that approximates the algebraic number `self`.
3202 The result `r` is such that |r - self| <= 1/10^precision
3204 >>> x = simplify(Sqrt(2))
3206 6838717160008073720548335/4835703278458516698824704
3213 """Return a string representation of the algebraic number `self` in decimal notation
3214 using `prec` decimal places.
3216 >>> x = simplify(Sqrt(2))
3217 >>> x.as_decimal(10)
3219 >>> x.as_decimal(20)
3220 '1.41421356237309504880?'
3232 if isinstance(a, bool):
3236 if isinstance(a, float):
3238 if isinstance(a, str):
3243 _z3_assert(
False,
"Python bool, int, long or float expected")
3247 """Return the integer sort in the given context. If `ctx=None`, then the global context is used.
3251 >>> x = Const('x', IntSort())
3254 >>> x.sort() == IntSort()
3256 >>> x.sort() == BoolSort()
3264 """Return the real sort in the given context. If `ctx=None`, then the global context is used.
3268 >>> x = Const('x', RealSort())
3273 >>> x.sort() == RealSort()
3281 if isinstance(val, float):
3282 return str(int(val))
3283 elif isinstance(val, bool):
3293 """Return a Z3 integer value. If `ctx=None`, then the global context is used.
3305 """Return a Z3 real value.
3307 `val` may be a Python int, long, float or string representing a number in decimal or rational notation.
3308 If `ctx=None`, then the global context is used.
3312 >>> RealVal(1).sort()
3324 """Return a Z3 rational a/b.
3326 If `ctx=None`, then the global context is used.
3330 >>> RatVal(3,5).sort()
3334 _z3_assert(
_is_int(a)
or isinstance(a, str),
"First argument cannot be converted into an integer")
3335 _z3_assert(
_is_int(b)
or isinstance(b, str),
"Second argument cannot be converted into an integer")
3339def Q(a, b, ctx=None):
3340 """Return a Z3 rational a/b.
3342 If `ctx=None`, then the global context is used.
3353 """Return an integer constant named `name`. If `ctx=None`, then the global context is used.
3366 """Return a tuple of Integer constants.
3368 >>> x, y, z = Ints('x y z')
3373 if isinstance(names, str):
3374 names = names.split(
" ")
3375 return [
Int(name, ctx)
for name
in names]
3379 """Return a list of integer constants of size `sz`.
3381 >>> X = IntVector('x', 3)
3388 return [
Int(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3392 """Return a fresh integer constant in the given context using the given prefix.
3406 """Return a real constant named `name`. If `ctx=None`, then the global context is used.
3419 """Return a tuple of real constants.
3421 >>> x, y, z = Reals('x y z')
3424 >>> Sum(x, y, z).sort()
3428 if isinstance(names, str):
3429 names = names.split(
" ")
3430 return [
Real(name, ctx)
for name
in names]
3434 """Return a list of real constants of size `sz`.
3436 >>> X = RealVector('x', 3)
3445 return [
Real(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3449 """Return a fresh real constant in the given context using the given prefix.
3463 """ Return the Z3 expression ToReal(a).
3475 if isinstance(a, BoolRef):
3478 _z3_assert(a.is_int(),
"Z3 integer expression expected.")
3483 """ Return the Z3 expression ToInt(a).
3495 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3501 """ Return the Z3 predicate IsInt(a).
3504 >>> IsInt(x + "1/2")
3506 >>> solve(IsInt(x + "1/2"), x > 0, x < 1)
3508 >>> solve(IsInt(x + "1/2"), x > 0, x < 1, x != "1/2")
3512 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3518 """ Return a Z3 expression which represents the square root of a.
3531 """ Return a Z3 expression which represents the cubic root of a.
3550 """Bit-vector sort."""
3553 """Return the size (number of bits) of the bit-vector sort `self`.
3555 >>> b = BitVecSort(32)
3565 """Try to cast `val` as a Bit-Vector.
3567 >>> b = BitVecSort(32)
3570 >>> b.cast(10).sexpr()
3583 """Return True if `s` is a Z3 bit-vector sort.
3585 >>> is_bv_sort(BitVecSort(32))
3587 >>> is_bv_sort(IntSort())
3590 return isinstance(s, BitVecSortRef)
3594 """Bit-vector expressions."""
3597 """Return the sort of the bit-vector expression `self`.
3599 >>> x = BitVec('x', 32)
3602 >>> x.sort() == BitVecSort(32)
3608 """Return the number of bits of the bit-vector expression `self`.
3610 >>> x = BitVec('x', 32)
3613 >>> Concat(x, x).size()
3619 """Create the Z3 expression `self + other`.
3621 >>> x = BitVec('x', 32)
3622 >>> y = BitVec('y', 32)
3632 """Create the Z3 expression `other + self`.
3634 >>> x = BitVec('x', 32)
3642 """Create the Z3 expression `self * other`.
3644 >>> x = BitVec('x', 32)
3645 >>> y = BitVec('y', 32)
3655 """Create the Z3 expression `other * self`.
3657 >>> x = BitVec('x', 32)
3665 """Create the Z3 expression `self - other`.
3667 >>> x = BitVec('x', 32)
3668 >>> y = BitVec('y', 32)
3678 """Create the Z3 expression `other - self`.
3680 >>> x = BitVec('x', 32)
3688 """Create the Z3 expression bitwise-or `self | other`.
3690 >>> x = BitVec('x', 32)
3691 >>> y = BitVec('y', 32)
3701 """Create the Z3 expression bitwise-or `other | self`.
3703 >>> x = BitVec('x', 32)
3711 """Create the Z3 expression bitwise-and `self & other`.
3713 >>> x = BitVec('x', 32)
3714 >>> y = BitVec('y', 32)
3724 """Create the Z3 expression bitwise-or `other & self`.
3726 >>> x = BitVec('x', 32)
3734 """Create the Z3 expression bitwise-xor `self ^ other`.
3736 >>> x = BitVec('x', 32)
3737 >>> y = BitVec('y', 32)
3747 """Create the Z3 expression bitwise-xor `other ^ self`.
3749 >>> x = BitVec('x', 32)
3759 >>> x = BitVec('x', 32)
3766 """Return an expression representing `-self`.
3768 >>> x = BitVec('x', 32)
3777 """Create the Z3 expression bitwise-not `~self`.
3779 >>> x = BitVec('x', 32)
3788 """Create the Z3 expression (signed) division `self / other`.
3790 Use the function UDiv() for unsigned division.
3792 >>> x = BitVec('x', 32)
3793 >>> y = BitVec('y', 32)
3800 >>> UDiv(x, y).sexpr()
3807 """Create the Z3 expression (signed) division `self / other`."""
3811 """Create the Z3 expression (signed) division `other / self`.
3813 Use the function UDiv() for unsigned division.
3815 >>> x = BitVec('x', 32)
3818 >>> (10 / x).sexpr()
3819 '(bvsdiv #x0000000a x)'
3820 >>> UDiv(10, x).sexpr()
3821 '(bvudiv #x0000000a x)'
3827 """Create the Z3 expression (signed) division `other / self`."""
3831 """Create the Z3 expression (signed) mod `self % other`.
3833 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3835 >>> x = BitVec('x', 32)
3836 >>> y = BitVec('y', 32)
3843 >>> URem(x, y).sexpr()
3845 >>> SRem(x, y).sexpr()
3852 """Create the Z3 expression (signed) mod `other % self`.
3854 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3856 >>> x = BitVec('x', 32)
3859 >>> (10 % x).sexpr()
3860 '(bvsmod #x0000000a x)'
3861 >>> URem(10, x).sexpr()
3862 '(bvurem #x0000000a x)'
3863 >>> SRem(10, x).sexpr()
3864 '(bvsrem #x0000000a x)'
3870 """Create the Z3 expression (signed) `other <= self`.
3872 Use the function ULE() for unsigned less than or equal to.
3874 >>> x, y = BitVecs('x y', 32)
3877 >>> (x <= y).sexpr()
3879 >>> ULE(x, y).sexpr()
3886 """Create the Z3 expression (signed) `other < self`.
3888 Use the function ULT() for unsigned less than.
3890 >>> x, y = BitVecs('x y', 32)
3895 >>> ULT(x, y).sexpr()
3902 """Create the Z3 expression (signed) `other > self`.
3904 Use the function UGT() for unsigned greater than.
3906 >>> x, y = BitVecs('x y', 32)
3911 >>> UGT(x, y).sexpr()
3918 """Create the Z3 expression (signed) `other >= self`.
3920 Use the function UGE() for unsigned greater than or equal to.
3922 >>> x, y = BitVecs('x y', 32)
3925 >>> (x >= y).sexpr()
3927 >>> UGE(x, y).sexpr()
3934 """Create the Z3 expression (arithmetical) right shift `self >> other`
3936 Use the function LShR() for the right logical shift
3938 >>> x, y = BitVecs('x y', 32)
3941 >>> (x >> y).sexpr()
3943 >>> LShR(x, y).sexpr()
3947 >>> BitVecVal(4, 3).as_signed_long()
3949 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
3951 >>> simplify(BitVecVal(4, 3) >> 1)
3953 >>> simplify(LShR(BitVecVal(4, 3), 1))
3955 >>> simplify(BitVecVal(2, 3) >> 1)
3957 >>> simplify(LShR(BitVecVal(2, 3), 1))
3964 """Create the Z3 expression left shift `self << other`
3966 >>> x, y = BitVecs('x y', 32)
3969 >>> (x << y).sexpr()
3971 >>> simplify(BitVecVal(2, 3) << 1)
3978 """Create the Z3 expression (arithmetical) right shift `other` >> `self`.
3980 Use the function LShR() for the right logical shift
3982 >>> x = BitVec('x', 32)
3985 >>> (10 >> x).sexpr()
3986 '(bvashr #x0000000a x)'
3992 """Create the Z3 expression left shift `other << self`.
3994 Use the function LShR() for the right logical shift
3996 >>> x = BitVec('x', 32)
3999 >>> (10 << x).sexpr()
4000 '(bvshl #x0000000a x)'
4007 """Bit-vector values."""
4010 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4012 >>> v = BitVecVal(0xbadc0de, 32)
4015 >>> print("0x%.8x" % v.as_long())
4021 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4022 The most significant bit is assumed to be the sign.
4024 >>> BitVecVal(4, 3).as_signed_long()
4026 >>> BitVecVal(7, 3).as_signed_long()
4028 >>> BitVecVal(3, 3).as_signed_long()
4030 >>> BitVecVal(2**32 - 1, 32).as_signed_long()
4032 >>> BitVecVal(2**64 - 1, 64).as_signed_long()
4037 if val >= 2**(sz - 1):
4039 if val < -2**(sz - 1):
4050 """Return the Python value of a Z3 bit-vector numeral."""
4056 """Return `True` if `a` is a Z3 bit-vector expression.
4058 >>> b = BitVec('b', 32)
4066 return isinstance(a, BitVecRef)
4070 """Return `True` if `a` is a Z3 bit-vector numeral value.
4072 >>> b = BitVec('b', 32)
4075 >>> b = BitVecVal(10, 32)
4085 """Return the Z3 expression BV2Int(a).
4087 >>> b = BitVec('b', 3)
4088 >>> BV2Int(b).sort()
4093 >>> x > BV2Int(b, is_signed=False)
4095 >>> x > BV2Int(b, is_signed=True)
4096 x > If(b < 0, BV2Int(b) - 8, BV2Int(b))
4097 >>> solve(x > BV2Int(b), b == 1, x < 3)
4101 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4108 """Return the z3 expression Int2BV(a, num_bits).
4109 It is a bit-vector of width num_bits and represents the
4110 modulo of a by 2^num_bits
4117 """Return a Z3 bit-vector sort of the given size. If `ctx=None`, then the global context is used.
4119 >>> Byte = BitVecSort(8)
4120 >>> Word = BitVecSort(16)
4123 >>> x = Const('x', Byte)
4124 >>> eq(x, BitVec('x', 8))
4132 """Return a bit-vector value with the given number of bits. If `ctx=None`, then the global context is used.
4134 >>> v = BitVecVal(10, 32)
4137 >>> print("0x%.8x" % v.as_long())
4149 """Return a bit-vector constant named `name`. `bv` may be the number of bits of a bit-vector sort.
4150 If `ctx=None`, then the global context is used.
4152 >>> x = BitVec('x', 16)
4159 >>> word = BitVecSort(16)
4160 >>> x2 = BitVec('x', word)
4164 if isinstance(bv, BitVecSortRef):
4173 """Return a tuple of bit-vector constants of size bv.
4175 >>> x, y, z = BitVecs('x y z', 16)
4182 >>> Product(x, y, z)
4184 >>> simplify(Product(x, y, z))
4188 if isinstance(names, str):
4189 names = names.split(
" ")
4190 return [
BitVec(name, bv, ctx)
for name
in names]
4194 """Create a Z3 bit-vector concatenation expression.
4196 >>> v = BitVecVal(1, 4)
4197 >>> Concat(v, v+1, v)
4198 Concat(Concat(1, 1 + 1), 1)
4199 >>> simplify(Concat(v, v+1, v))
4201 >>> print("%.3x" % simplify(Concat(v, v+1, v)).as_long())
4207 _z3_assert(sz >= 2,
"At least two arguments expected.")
4214 if is_seq(args[0])
or isinstance(args[0], str):
4217 _z3_assert(all([
is_seq(a)
for a
in args]),
"All arguments must be sequence expressions.")
4220 v[i] = args[i].as_ast()
4225 _z3_assert(all([
is_re(a)
for a
in args]),
"All arguments must be regular expressions.")
4228 v[i] = args[i].as_ast()
4232 _z3_assert(all([
is_bv(a)
for a
in args]),
"All arguments must be Z3 bit-vector expressions.")
4234 for i
in range(sz - 1):
4240 """Create a Z3 bit-vector extraction expression or sequence extraction expression.
4242 Extract is overloaded to work with both bit-vectors and sequences:
4244 **Bit-vector extraction**: Extract(high, low, bitvector)
4245 Extracts bits from position `high` down to position `low` (both inclusive).
4246 - high: int - the highest bit position to extract (0-indexed from right)
4247 - low: int - the lowest bit position to extract (0-indexed from right)
4248 - bitvector: BitVecRef - the bit-vector to extract from
4249 Returns a new bit-vector containing bits [high:low]
4251 **Sequence extraction**: Extract(sequence, offset, length)
4252 Extracts a subsequence starting at the given offset with the specified length.
4253 The functions SubString and SubSeq are redirected to this form of Extract.
4254 - sequence: SeqRef or str - the sequence to extract from
4255 - offset: int - the starting position (0-indexed)
4256 - length: int - the number of elements to extract
4257 Returns a new sequence containing the extracted subsequence
4259 >>> # Bit-vector extraction examples
4260 >>> x = BitVec('x', 8)
4261 >>> Extract(6, 2, x) # Extract bits 6 down to 2 (5 bits total)
4263 >>> Extract(6, 2, x).sort() # Result is a 5-bit vector
4265 >>> Extract(7, 0, x) # Extract all 8 bits
4267 >>> Extract(3, 3, x) # Extract single bit at position 3
4270 >>> # Sequence extraction examples
4271 >>> s = StringVal("hello")
4272 >>> Extract(s, 1, 3) # Extract 3 characters starting at position 1
4273 str.substr("hello", 1, 3)
4274 >>> simplify(Extract(StringVal("abcd"), 2, 1)) # Extract 1 character at position 2
4276 >>> simplify(Extract(StringVal("abcd"), 0, 2)) # Extract first 2 characters
4279 if isinstance(high, str):
4286 _z3_assert(low <= high,
"First argument must be greater than or equal to second argument")
4288 "First and second arguments must be non negative integers")
4289 _z3_assert(
is_bv(a),
"Third argument must be a Z3 bit-vector expression")
4295 _z3_assert(
is_bv(a)
or is_bv(b),
"First or second argument must be a Z3 bit-vector expression")
4299 """Create the Z3 expression (unsigned) `other <= self`.
4301 Use the operator <= for signed less than or equal to.
4303 >>> x, y = BitVecs('x y', 32)
4306 >>> (x <= y).sexpr()
4308 >>> ULE(x, y).sexpr()
4317 """Create the Z3 expression (unsigned) `other < self`.
4319 Use the operator < for signed less than.
4321 >>> x, y = BitVecs('x y', 32)
4326 >>> ULT(x, y).sexpr()
4335 """Create the Z3 expression (unsigned) `other >= self`.
4337 Use the operator >= for signed greater than or equal to.
4339 >>> x, y = BitVecs('x y', 32)
4342 >>> (x >= y).sexpr()
4344 >>> UGE(x, y).sexpr()
4353 """Create the Z3 expression (unsigned) `other > self`.
4355 Use the operator > for signed greater than.
4357 >>> x, y = BitVecs('x y', 32)
4362 >>> UGT(x, y).sexpr()
4371 """Create the Z3 expression (unsigned) division `self / other`.
4373 Use the operator / for signed division.
4375 >>> x = BitVec('x', 32)
4376 >>> y = BitVec('y', 32)
4379 >>> UDiv(x, y).sort()
4383 >>> UDiv(x, y).sexpr()
4392 """Create the Z3 expression (unsigned) remainder `self % other`.
4394 Use the operator % for signed modulus, and SRem() for signed remainder.
4396 >>> x = BitVec('x', 32)
4397 >>> y = BitVec('y', 32)
4400 >>> URem(x, y).sort()
4404 >>> URem(x, y).sexpr()
4413 """Create the Z3 expression signed remainder.
4415 Use the operator % for signed modulus, and URem() for unsigned remainder.
4417 >>> x = BitVec('x', 32)
4418 >>> y = BitVec('y', 32)
4421 >>> SRem(x, y).sort()
4425 >>> SRem(x, y).sexpr()
4434 """Create the Z3 expression logical right shift.
4436 Use the operator >> for the arithmetical right shift.
4438 >>> x, y = BitVecs('x y', 32)
4441 >>> (x >> y).sexpr()
4443 >>> LShR(x, y).sexpr()
4447 >>> BitVecVal(4, 3).as_signed_long()
4449 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
4451 >>> simplify(BitVecVal(4, 3) >> 1)
4453 >>> simplify(LShR(BitVecVal(4, 3), 1))
4455 >>> simplify(BitVecVal(2, 3) >> 1)
4457 >>> simplify(LShR(BitVecVal(2, 3), 1))
4466 """Return an expression representing `a` rotated to the left `b` times.
4468 >>> a, b = BitVecs('a b', 16)
4469 >>> RotateLeft(a, b)
4471 >>> simplify(RotateLeft(a, 0))
4473 >>> simplify(RotateLeft(a, 16))
4482 """Return an expression representing `a` rotated to the right `b` times.
4484 >>> a, b = BitVecs('a b', 16)
4485 >>> RotateRight(a, b)
4487 >>> simplify(RotateRight(a, 0))
4489 >>> simplify(RotateRight(a, 16))
4498 """Return a bit-vector expression with `n` extra sign-bits.
4500 >>> x = BitVec('x', 16)
4501 >>> n = SignExt(8, x)
4508 >>> v0 = BitVecVal(2, 2)
4513 >>> v = simplify(SignExt(6, v0))
4518 >>> print("%.x" % v.as_long())
4523 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4528 """Return a bit-vector expression with `n` extra zero-bits.
4530 >>> x = BitVec('x', 16)
4531 >>> n = ZeroExt(8, x)
4538 >>> v0 = BitVecVal(2, 2)
4543 >>> v = simplify(ZeroExt(6, v0))
4551 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4556 """Return an expression representing `n` copies of `a`.
4558 >>> x = BitVec('x', 8)
4559 >>> n = RepeatBitVec(4, x)
4564 >>> v0 = BitVecVal(10, 4)
4565 >>> print("%.x" % v0.as_long())
4567 >>> v = simplify(RepeatBitVec(4, v0))
4570 >>> print("%.x" % v.as_long())
4575 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4580 """Return the reduction-and expression of `a`."""
4582 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4587 """Return the reduction-or expression of `a`."""
4589 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4594 """A predicate the determines that bit-vector addition does not overflow"""
4601 """A predicate the determines that signed bit-vector addition does not underflow"""
4608 """A predicate the determines that bit-vector subtraction does not overflow"""
4615 """A predicate the determines that bit-vector subtraction does not underflow"""
4622 """A predicate the determines that bit-vector signed division does not overflow"""
4629 """A predicate the determines that bit-vector unary negation does not overflow"""
4631 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4636 """A predicate the determines that bit-vector multiplication does not overflow"""
4643 """A predicate the determines that bit-vector signed multiplication does not underflow"""
4659 """Return the domain of the array sort `self`.
4661 >>> A = ArraySort(IntSort(), BoolSort())
4668 """Return the domain of the array sort `self`.
4673 """Return the range of the array sort `self`.
4675 >>> A = ArraySort(IntSort(), BoolSort())
4683 """Array expressions. """
4686 """Return the array sort of the array expression `self`.
4688 >>> a = Array('a', IntSort(), BoolSort())
4695 """Shorthand for `self.sort().domain()`.
4697 >>> a = Array('a', IntSort(), BoolSort())
4704 """Shorthand for self.sort().domain_n(i)`."""
4708 """Shorthand for `self.sort().range()`.
4710 >>> a = Array('a', IntSort(), BoolSort())
4717 """Return the Z3 expression `self[arg]`.
4719 >>> a = Array('a', IntSort(), BoolSort())
4733 if isinstance(arg, tuple):
4734 args = [ar.sort().domain_n(i).cast(arg[i])
for i
in range(len(arg))]
4737 arg = ar.sort().domain().cast(arg)
4746 """Return `True` if `a` is a Z3 array expression.
4748 >>> a = Array('a', IntSort(), IntSort())
4751 >>> is_array(Store(a, 0, 1))
4756 return isinstance(a, ArrayRef)
4760 """Return `True` if `a` is a Z3 constant array.
4762 >>> a = K(IntSort(), 10)
4763 >>> is_const_array(a)
4765 >>> a = Array('a', IntSort(), IntSort())
4766 >>> is_const_array(a)
4773 """Return `True` if `a` is a Z3 constant array.
4775 >>> a = K(IntSort(), 10)
4778 >>> a = Array('a', IntSort(), IntSort())
4786 """Return `True` if `a` is a Z3 map array expression.
4788 >>> f = Function('f', IntSort(), IntSort())
4789 >>> b = Array('b', IntSort(), IntSort())
4802 """Return `True` if `a` is a Z3 default array expression.
4803 >>> d = Default(K(IntSort(), 10))
4807 return is_app_of(a, Z3_OP_ARRAY_DEFAULT)
4811 """Return the function declaration associated with a Z3 map array expression.
4813 >>> f = Function('f', IntSort(), IntSort())
4814 >>> b = Array('b', IntSort(), IntSort())
4816 >>> eq(f, get_map_func(a))
4820 >>> get_map_func(a)(0)
4835 """Return the Z3 array sort with the given domain and range sorts.
4837 >>> A = ArraySort(IntSort(), BoolSort())
4844 >>> AA = ArraySort(IntSort(), A)
4846 Array(Int, Array(Int, Bool))
4850 _z3_assert(len(sig) > 1,
"At least two arguments expected")
4851 arity = len(sig) - 1
4857 _z3_assert(s.ctx == r.ctx,
"Context mismatch")
4861 dom = (Sort * arity)()
4862 for i
in range(arity):
4868 """Return an array constant named `name` with the given domain and range sorts.
4870 >>> a = Array('a', IntSort(), IntSort())
4882 """Return a Z3 store array expression.
4884 >>> a = Array('a', IntSort(), IntSort())
4885 >>> i, v = Ints('i v')
4886 >>> s = Update(a, i, v)
4889 >>> prove(s[i] == v)
4892 >>> prove(Implies(i != j, s[j] == a[j]))
4900 raise Z3Exception(
"array update requires index and value arguments")
4904 i = a.sort().domain().cast(i)
4905 v = a.sort().range().cast(v)
4907 v = a.sort().range().cast(args[-1])
4908 idxs = [a.sort().domain_n(i).cast(args[i])
for i
in range(len(args)-1)]
4914 """ Return a default value for array expression.
4915 >>> b = K(IntSort(), 1)
4916 >>> prove(Default(b) == 1)
4925 """Return a Z3 store array expression.
4927 >>> a = Array('a', IntSort(), IntSort())
4928 >>> i, v = Ints('i v')
4929 >>> s = Store(a, i, v)
4932 >>> prove(s[i] == v)
4935 >>> prove(Implies(i != j, s[j] == a[j]))
4942 """Return a Z3 select array expression.
4944 >>> a = Array('a', IntSort(), IntSort())
4948 >>> eq(Select(a, i), a[i])
4958 """Return a Z3 map array expression.
4960 >>> f = Function('f', IntSort(), IntSort(), IntSort())
4961 >>> a1 = Array('a1', IntSort(), IntSort())
4962 >>> a2 = Array('a2', IntSort(), IntSort())
4963 >>> b = Map(f, a1, a2)
4966 >>> prove(b[0] == f(a1[0], a2[0]))
4971 _z3_assert(len(args) > 0,
"At least one Z3 array expression expected")
4974 _z3_assert(len(args) == f.arity(),
"Number of arguments mismatch")
4981 """Return a Z3 constant array expression.
4983 >>> a = K(IntSort(), 10)
5003 """Return extensionality index for one-dimensional arrays.
5004 >> a, b = Consts('a b', SetSort(IntSort()))
5021 """Return `True` if `a` is a Z3 array select application.
5023 >>> a = Array('a', IntSort(), IntSort())
5034 """Return `True` if `a` is a Z3 array store application.
5036 >>> a = Array('a', IntSort(), IntSort())
5039 >>> is_store(Store(a, 0, 1))
5052 """ Create a set sort over element sort s"""
5057 """Create the empty set
5058 >>> EmptySet(IntSort())
5066 """Create the full set
5067 >>> FullSet(IntSort())
5075 """ Take the union of sets
5076 >>> a = Const('a', SetSort(IntSort()))
5077 >>> b = Const('b', SetSort(IntSort()))
5088 """ Take the union of sets
5089 >>> a = Const('a', SetSort(IntSort()))
5090 >>> b = Const('b', SetSort(IntSort()))
5091 >>> SetIntersect(a, b)
5101 """ Add element e to set s
5102 >>> a = Const('a', SetSort(IntSort()))
5112 """ Remove element e to set s
5113 >>> a = Const('a', SetSort(IntSort()))
5123 """ The complement of set s
5124 >>> a = Const('a', SetSort(IntSort()))
5125 >>> SetComplement(a)
5133 """ The set difference of a and b
5134 >>> a = Const('a', SetSort(IntSort()))
5135 >>> b = Const('b', SetSort(IntSort()))
5136 >>> SetDifference(a, b)
5144 """ Check if e is a member of set s
5145 >>> a = Const('a', SetSort(IntSort()))
5155 """ Check if a is a subset of b
5156 >>> a = Const('a', SetSort(IntSort()))
5157 >>> b = Const('b', SetSort(IntSort()))
5172 """Return `True` if acc is pair of the form (String, Datatype or Sort). """
5173 if not isinstance(acc, tuple):
5177 return isinstance(acc[0], str)
and (isinstance(acc[1], Datatype)
or is_sort(acc[1]))
5181 """Helper class for declaring Z3 datatypes.
5183 >>> List = Datatype('List')
5184 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5185 >>> List.declare('nil')
5186 >>> List = List.create()
5187 >>> # List is now a Z3 declaration
5190 >>> List.cons(10, List.nil)
5192 >>> List.cons(10, List.nil).sort()
5194 >>> cons = List.cons
5198 >>> n = cons(1, cons(0, nil))
5200 cons(1, cons(0, nil))
5201 >>> simplify(cdr(n))
5203 >>> simplify(car(n))
5219 _z3_assert(isinstance(name, str),
"String expected")
5220 _z3_assert(isinstance(rec_name, str),
"String expected")
5223 "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)",
5228 """Declare constructor named `name` with the given accessors `args`.
5229 Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort
5230 or a reference to the datatypes being declared.
5232 In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
5233 declares the constructor named `cons` that builds a new List using an integer and a List.
5234 It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer
5235 of a `cons` cell, and `cdr` the list of a `cons` cell. After all constructors were declared,
5236 we use the method create() to create the actual datatype in Z3.
5238 >>> List = Datatype('List')
5239 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5240 >>> List.declare('nil')
5241 >>> List = List.create()
5244 _z3_assert(isinstance(name, str),
"String expected")
5245 _z3_assert(name !=
"",
"Constructor name cannot be empty")
5252 """Create a Z3 datatype based on the constructors declared using the method `declare()`.
5254 The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
5256 >>> List = Datatype('List')
5257 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5258 >>> List.declare('nil')
5259 >>> List = List.create()
5262 >>> List.cons(10, List.nil)
5269 """Auxiliary object used to create Z3 datatypes."""
5276 if self.
ctx.ref()
is not None and Z3_del_constructor
is not None:
5281 """Auxiliary object used to create Z3 datatypes."""
5288 if self.
ctx.ref()
is not None and Z3_del_constructor_list
is not None:
5293 """Create mutually recursive Z3 datatypes using 1 or more Datatype helper objects.
5295 In the following example we define a Tree-List using two mutually recursive datatypes.
5297 >>> TreeList = Datatype('TreeList')
5298 >>> Tree = Datatype('Tree')
5299 >>> # Tree has two constructors: leaf and node
5300 >>> Tree.declare('leaf', ('val', IntSort()))
5301 >>> # a node contains a list of trees
5302 >>> Tree.declare('node', ('children', TreeList))
5303 >>> TreeList.declare('nil')
5304 >>> TreeList.declare('cons', ('car', Tree), ('cdr', TreeList))
5305 >>> Tree, TreeList = CreateDatatypes(Tree, TreeList)
5306 >>> Tree.val(Tree.leaf(10))
5308 >>> simplify(Tree.val(Tree.leaf(10)))
5310 >>> n1 = Tree.node(TreeList.cons(Tree.leaf(10), TreeList.cons(Tree.leaf(20), TreeList.nil)))
5312 node(cons(leaf(10), cons(leaf(20), nil)))
5313 >>> n2 = Tree.node(TreeList.cons(n1, TreeList.nil))
5314 >>> simplify(n2 == n1)
5316 >>> simplify(TreeList.car(Tree.children(n2)) == n1)
5321 _z3_assert(len(ds) > 0,
"At least one Datatype must be specified")
5322 _z3_assert(all([isinstance(d, Datatype)
for d
in ds]),
"Arguments must be Datatypes")
5323 _z3_assert(all([d.ctx == ds[0].ctx
for d
in ds]),
"Context mismatch")
5324 _z3_assert(all([d.constructors != []
for d
in ds]),
"Non-empty Datatypes expected")
5327 names = (Symbol * num)()
5328 out = (Sort * num)()
5329 clists = (ConstructorList * num)()
5331 for i
in range(num):
5334 num_cs = len(d.constructors)
5335 cs = (Constructor * num_cs)()
5336 for j
in range(num_cs):
5337 c = d.constructors[j]
5342 fnames = (Symbol * num_fs)()
5343 sorts = (Sort * num_fs)()
5344 refs = (ctypes.c_uint * num_fs)()
5345 for k
in range(num_fs):
5349 if isinstance(ftype, Datatype):
5352 ds.count(ftype) == 1,
5353 "One and only one occurrence of each datatype is expected",
5356 refs[k] = ds.index(ftype)
5360 sorts[k] = ftype.ast
5369 for i
in range(num):
5371 num_cs = dref.num_constructors()
5372 for j
in range(num_cs):
5373 cref = dref.constructor(j)
5374 cref_name = cref.name()
5375 cref_arity = cref.arity()
5376 if cref.arity() == 0:
5378 setattr(dref, cref_name, cref)
5379 rref = dref.recognizer(j)
5380 setattr(dref,
"is_" + cref_name, rref)
5381 for k
in range(cref_arity):
5382 aref = dref.accessor(j, k)
5383 setattr(dref, aref.name(), aref)
5385 return tuple(result)
5389 """Datatype sorts."""
5392 """Return the number of constructors in the given Z3 datatype.
5394 >>> List = Datatype('List')
5395 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5396 >>> List.declare('nil')
5397 >>> List = List.create()
5398 >>> # List is now a Z3 declaration
5399 >>> List.num_constructors()
5405 """Return a constructor of the datatype `self`.
5407 >>> List = Datatype('List')
5408 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5409 >>> List.declare('nil')
5410 >>> List = List.create()
5411 >>> # List is now a Z3 declaration
5412 >>> List.num_constructors()
5414 >>> List.constructor(0)
5416 >>> List.constructor(1)
5424 """In Z3, each constructor has an associated recognizer predicate.
5426 If the constructor is named `name`, then the recognizer `is_name`.
5428 >>> List = Datatype('List')
5429 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5430 >>> List.declare('nil')
5431 >>> List = List.create()
5432 >>> # List is now a Z3 declaration
5433 >>> List.num_constructors()
5435 >>> List.recognizer(0)
5437 >>> List.recognizer(1)
5439 >>> simplify(List.is_nil(List.cons(10, List.nil)))
5441 >>> simplify(List.is_cons(List.cons(10, List.nil)))
5443 >>> l = Const('l', List)
5444 >>> simplify(List.is_cons(l))
5452 """In Z3, each constructor has 0 or more accessor.
5453 The number of accessors is equal to the arity of the constructor.
5455 >>> List = Datatype('List')
5456 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5457 >>> List.declare('nil')
5458 >>> List = List.create()
5459 >>> List.num_constructors()
5461 >>> List.constructor(0)
5463 >>> num_accs = List.constructor(0).arity()
5466 >>> List.accessor(0, 0)
5468 >>> List.accessor(0, 1)
5470 >>> List.constructor(1)
5472 >>> num_accs = List.constructor(1).arity()
5486 """Datatype expressions."""
5489 """Return the datatype sort of the datatype expression `self`."""
5493 """Create a reference to a sort that was declared, or will be declared, as a recursive datatype.
5496 name: name of the datatype sort
5497 params: optional list/tuple of sort parameters for parametric datatypes
5498 ctx: Z3 context (optional)
5501 >>> # Non-parametric datatype
5502 >>> TreeRef = DatatypeSort('Tree')
5503 >>> # Parametric datatype with one parameter
5504 >>> ListIntRef = DatatypeSort('List', [IntSort()])
5505 >>> # Parametric datatype with multiple parameters
5506 >>> PairRef = DatatypeSort('Pair', [IntSort(), BoolSort()])
5509 if params
is None or len(params) == 0:
5512 _params = (Sort * len(params))()
5513 for i
in range(len(params)):
5514 _params[i] = params[i].ast
5518 """Create a named tuple sort base on a set of underlying sorts
5520 >>> pair, mk_pair, (first, second) = TupleSort("pair", [IntSort(), StringSort()])
5523 projects = [(
"project%d" % i, sorts[i])
for i
in range(len(sorts))]
5524 tuple.declare(name, *projects)
5525 tuple = tuple.create()
5526 return tuple, tuple.constructor(0), [tuple.accessor(0, i)
for i
in range(len(sorts))]
5530 """Create a named tagged union sort base on a set of underlying sorts
5532 >>> sum, ((inject0, extract0), (inject1, extract1)) = DisjointSum("+", [IntSort(), StringSort()])
5535 for i
in range(len(sorts)):
5536 sum.declare(
"inject%d" % i, (
"project%d" % i, sorts[i]))
5538 return sum, [(sum.constructor(i), sum.accessor(i, 0))
for i
in range(len(sorts))]
5542 """Return a new enumeration sort named `name` containing the given values.
5544 The result is a pair (sort, list of constants).
5546 >>> Color, (red, green, blue) = EnumSort('Color', ['red', 'green', 'blue'])
5549 _z3_assert(isinstance(name, str),
"Name must be a string")
5550 _z3_assert(all([isinstance(v, str)
for v
in values]),
"Enumeration sort values must be strings")
5551 _z3_assert(len(values) > 0,
"At least one value expected")
5554 _val_names = (Symbol * num)()
5555 for i
in range(num):
5556 _val_names[i] =
to_symbol(values[i], ctx)
5557 _values = (FuncDecl * num)()
5558 _testers = (FuncDecl * num)()
5562 for i
in range(num):
5564 V = [a()
for a
in V]
5575 """Set of parameters used to configure Solvers, Tactics and Simplifiers in Z3.
5577 Consider using the function `args2params` to create instances of this object.
5592 if self.
ctx.ref()
is not None and Z3_params_dec_ref
is not None:
5596 """Set parameter name with value val."""
5598 _z3_assert(isinstance(name, str),
"parameter name must be a string")
5600 if isinstance(val, bool):
5604 elif isinstance(val, float):
5606 elif isinstance(val, str):
5616 _z3_assert(isinstance(ds, ParamDescrsRef),
"parameter description set expected")
5621 """Convert python arguments into a Z3_params object.
5622 A ':' is added to the keywords, and '_' is replaced with '-'
5624 >>> args2params(['model', True, 'relevancy', 2], {'elim_and' : True})
5625 (params model true relevancy 2 elim_and true)
5628 _z3_assert(len(arguments) % 2 == 0,
"Argument list must have an even number of elements.")
5644 """Set of parameter descriptions for Solvers, Tactics and Simplifiers in Z3.
5648 _z3_assert(isinstance(descr, ParamDescrs),
"parameter description object expected")
5654 return ParamsDescrsRef(self.
descr, self.
ctx)
5657 if self.
ctx.ref()
is not None and Z3_param_descrs_dec_ref
is not None:
5661 """Return the size of in the parameter description `self`.
5666 """Return the size of in the parameter description `self`.
5671 """Return the i-th parameter name in the parameter description `self`.
5676 """Return the kind of the parameter named `n`.
5681 """Return the documentation string of the parameter named `n`.
5702 """Goal is a collection of constraints we want to find a solution or show to be unsatisfiable (infeasible).
5704 Goals are processed using Tactics. A Tactic transforms a goal into a set of subgoals.
5705 A goal has a solution if one of its subgoals has a solution.
5706 A goal is unsatisfiable if all subgoals are unsatisfiable.
5709 def __init__(self, models=True, unsat_cores=False, proofs=False, ctx=None, goal=None):
5712 "If goal is different from None, then ctx must be also different from None")
5715 if self.
goal is None:
5720 if self.
goal is not None and self.
ctx.ref()
is not None and Z3_goal_dec_ref
is not None:
5724 """Return the depth of the goal `self`.
5725 The depth corresponds to the number of tactics applied to `self`.
5727 >>> x, y = Ints('x y')
5729 >>> g.add(x == 0, y >= x + 1)
5732 >>> r = Then('simplify', 'solve-eqs')(g)
5733 >>> # r has 1 subgoal
5742 """Return `True` if `self` contains the `False` constraints.
5744 >>> x, y = Ints('x y')
5746 >>> g.inconsistent()
5748 >>> g.add(x == 0, x == 1)
5751 >>> g.inconsistent()
5753 >>> g2 = Tactic('propagate-values')(g)[0]
5754 >>> g2.inconsistent()
5760 """Return the precision (under-approximation, over-approximation, or precise) of the goal `self`.
5763 >>> g.prec() == Z3_GOAL_PRECISE
5765 >>> x, y = Ints('x y')
5766 >>> g.add(x == y + 1)
5767 >>> g.prec() == Z3_GOAL_PRECISE
5769 >>> t = With(Tactic('add-bounds'), add_bound_lower=0, add_bound_upper=10)
5772 [x == y + 1, x <= 10, x >= 0, y <= 10, y >= 0]
5773 >>> g2.prec() == Z3_GOAL_PRECISE
5775 >>> g2.prec() == Z3_GOAL_UNDER
5781 """Alias for `prec()`.
5784 >>> g.precision() == Z3_GOAL_PRECISE
5790 """Return the number of constraints in the goal `self`.
5795 >>> x, y = Ints('x y')
5796 >>> g.add(x == 0, y > x)
5803 """Return the number of constraints in the goal `self`.
5808 >>> x, y = Ints('x y')
5809 >>> g.add(x == 0, y > x)
5816 """Return a constraint in the goal `self`.
5819 >>> x, y = Ints('x y')
5820 >>> g.add(x == 0, y > x)
5829 """Return a constraint in the goal `self`.
5832 >>> x, y = Ints('x y')
5833 >>> g.add(x == 0, y > x)
5839 if arg >= len(self):
5841 return self.
get(arg)
5844 """Assert constraints into the goal.
5848 >>> g.assert_exprs(x > 0, x < 2)
5863 >>> g.append(x > 0, x < 2)
5874 >>> g.insert(x > 0, x < 2)
5885 >>> g.add(x > 0, x < 2)
5892 """Retrieve model from a satisfiable goal
5893 >>> a, b = Ints('a b')
5895 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
5896 >>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
5899 [Or(b == 0, b == 1), Not(0 <= b)]
5901 [Or(b == 0, b == 1), Not(1 <= b)]
5902 >>> # Remark: the subgoal r[0] is unsatisfiable
5903 >>> # Creating a solver for solving the second subgoal
5910 >>> # Model s.model() does not assign a value to `a`
5911 >>> # It is a model for subgoal `r[1]`, but not for goal `g`
5912 >>> # The method convert_model creates a model for `g` from a model for `r[1]`.
5913 >>> r[1].convert_model(s.model())
5917 _z3_assert(isinstance(model, ModelRef),
"Z3 Model expected")
5921 return obj_to_string(self)
5924 """Return a textual representation of the s-expression representing the goal."""
5928 """Return a textual representation of the goal in DIMACS format."""
5932 """Copy goal `self` to context `target`.
5940 >>> g2 = g.translate(c2)
5943 >>> g.ctx == main_ctx()
5947 >>> g2.ctx == main_ctx()
5951 _z3_assert(isinstance(target, Context),
"target must be a context")
5961 """Return a new simplified goal.
5963 This method is essentially invoking the simplify tactic.
5967 >>> g.add(x + 1 >= 2)
5970 >>> g2 = g.simplify()
5973 >>> # g was not modified
5978 return t.apply(self, *arguments, **keywords)[0]
5981 """Return goal `self` as a single Z3 expression.
6000 return And([self.
get(i)
for i
in range(len(self))], self.
ctx)
6010 """A collection (vector) of ASTs."""
6019 assert ctx
is not None
6024 if self.
vector is not None and self.
ctx.ref()
is not None and Z3_ast_vector_dec_ref
is not None:
6028 """Return the size of the vector `self`.
6033 >>> A.push(Int('x'))
6034 >>> A.push(Int('x'))
6041 """Return the AST at position `i`.
6044 >>> A.push(Int('x') + 1)
6045 >>> A.push(Int('y'))
6052 if isinstance(i, int):
6060 elif isinstance(i, slice):
6062 for ii
in range(*i.indices(self.
__len__())):
6070 """Update AST at position `i`.
6073 >>> A.push(Int('x') + 1)
6074 >>> A.push(Int('y'))
6086 """Add `v` in the end of the vector.
6091 >>> A.push(Int('x'))
6098 """Resize the vector to `sz` elements.
6104 >>> for i in range(10): A[i] = Int('x')
6111 """Return `True` if the vector contains `item`.
6134 """Copy vector `self` to context `other_ctx`.
6140 >>> B = A.translate(c2)
6156 return obj_to_string(self)
6159 """Return a textual representation of the s-expression representing the vector."""
6170 """A mapping from ASTs to ASTs."""
6179 assert ctx
is not None
6187 if self.
map is not None and self.
ctx.ref()
is not None and Z3_ast_map_dec_ref
is not None:
6191 """Return the size of the map.
6197 >>> M[x] = IntVal(1)
6204 """Return `True` if the map contains key `key`.
6217 """Retrieve the value associated with key `key`.
6228 """Add/Update key `k` with value `v`.
6237 >>> M[x] = IntVal(1)
6247 """Remove the entry associated with key `k`.
6261 """Remove all entries from the map.
6266 >>> M[x+x] = IntVal(1)
6276 """Return an AstVector containing all keys in the map.
6281 >>> M[x+x] = IntVal(1)
6295 """Store the value of the interpretation of a function in a particular point."""
6306 if self.
ctx.ref()
is not None and Z3_func_entry_dec_ref
is not None:
6310 """Return the number of arguments in the given entry.
6312 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6314 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6319 >>> f_i.num_entries()
6321 >>> e = f_i.entry(0)
6328 """Return the value of argument `idx`.
6330 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6332 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6337 >>> f_i.num_entries()
6339 >>> e = f_i.entry(0)
6350 ... except IndexError:
6351 ... print("index error")
6359 """Return the value of the function at point `self`.
6361 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6363 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6368 >>> f_i.num_entries()
6370 >>> e = f_i.entry(0)
6381 """Return entry `self` as a Python list.
6382 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6384 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6389 >>> f_i.num_entries()
6391 >>> e = f_i.entry(0)
6396 args.append(self.
value())
6404 """Stores the interpretation of a function in a Z3 model."""
6409 if self.
f is not None:
6413 if self.
f is not None and self.
ctx.ref()
is not None and Z3_func_interp_dec_ref
is not None:
6418 Return the `else` value for a function interpretation.
6419 Return None if Z3 did not specify the `else` value for
6422 >>> f = Function('f', IntSort(), IntSort())
6424 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6430 >>> m[f].else_value()
6440 """Return the number of entries/points in the function interpretation `self`.
6442 >>> f = Function('f', IntSort(), IntSort())
6444 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6450 >>> m[f].num_entries()
6456 """Return the number of arguments for each entry in the function interpretation `self`.
6458 >>> f = Function('f', IntSort(), IntSort())
6460 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6470 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6472 >>> f = Function('f', IntSort(), IntSort())
6474 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6480 >>> m[f].num_entries()
6490 """Copy model 'self' to context 'other_ctx'.
6501 """Return the function interpretation as a Python list.
6502 >>> f = Function('f', IntSort(), IntSort())
6504 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6518 return obj_to_string(self)
6522 """Model/Solution of a satisfiability problem (aka system of constraints)."""
6525 assert ctx
is not None
6531 if self.
ctx.ref()
is not None and Z3_model_dec_ref
is not None:
6535 return obj_to_string(self)
6538 """Return a textual representation of the s-expression representing the model."""
6541 def eval(self, t, model_completion=False):
6542 """Evaluate the expression `t` in the model `self`.
6543 If `model_completion` is enabled, then a default interpretation is automatically added
6544 for symbols that do not have an interpretation in the model `self`.
6548 >>> s.add(x > 0, x < 2)
6561 >>> m.eval(y, model_completion=True)
6563 >>> # Now, m contains an interpretation for y
6570 raise Z3Exception(
"failed to evaluate expression in the model")
6573 """Alias for `eval`.
6577 >>> s.add(x > 0, x < 2)
6581 >>> m.evaluate(x + 1)
6583 >>> m.evaluate(x == 1)
6586 >>> m.evaluate(y + x)
6590 >>> m.evaluate(y, model_completion=True)
6592 >>> # Now, m contains an interpretation for y
6593 >>> m.evaluate(y + x)
6596 return self.
eval(t, model_completion)
6599 """Return the number of constant and function declarations in the model `self`.
6601 >>> f = Function('f', IntSort(), IntSort())
6604 >>> s.add(x > 0, f(x) != x)
6613 return num_consts + num_funcs
6616 """Return the interpretation for a given declaration or constant.
6618 >>> f = Function('f', IntSort(), IntSort())
6621 >>> s.add(x > 0, x < 2, f(x) == 0)
6631 _z3_assert(isinstance(decl, FuncDeclRef)
or is_const(decl),
"Z3 declaration expected")
6635 if decl.arity() == 0:
6637 if _r.value
is None:
6653 sz = fi.num_entries()
6657 e =
Store(e, fe.arg_value(0), fe.value())
6668 """Return the number of uninterpreted sorts that contain an interpretation in the model `self`.
6670 >>> A = DeclareSort('A')
6671 >>> a, b = Consts('a b', A)
6683 """Return the uninterpreted sort at position `idx` < self.num_sorts().
6685 >>> A = DeclareSort('A')
6686 >>> B = DeclareSort('B')
6687 >>> a1, a2 = Consts('a1 a2', A)
6688 >>> b1, b2 = Consts('b1 b2', B)
6690 >>> s.add(a1 != a2, b1 != b2)
6706 """Return all uninterpreted sorts that have an interpretation in the model `self`.
6708 >>> A = DeclareSort('A')
6709 >>> B = DeclareSort('B')
6710 >>> a1, a2 = Consts('a1 a2', A)
6711 >>> b1, b2 = Consts('b1 b2', B)
6713 >>> s.add(a1 != a2, b1 != b2)
6723 """Return the interpretation for the uninterpreted sort `s` in the model `self`.
6725 >>> A = DeclareSort('A')
6726 >>> a, b = Consts('a b', A)
6732 >>> m.get_universe(A)
6736 _z3_assert(isinstance(s, SortRef),
"Z3 sort expected")
6743 """If `idx` is an integer, then the declaration at position `idx` in the model `self` is returned.
6744 If `idx` is a declaration, then the actual interpretation is returned.
6746 The elements can be retrieved using position or the actual declaration.
6748 >>> f = Function('f', IntSort(), IntSort())
6751 >>> s.add(x > 0, x < 2, f(x) == 0)
6765 >>> for d in m: print("%s -> %s" % (d, m[d]))
6770 if idx >= len(self):
6773 if (idx < num_consts):
6777 if isinstance(idx, FuncDeclRef):
6781 if isinstance(idx, SortRef):
6784 _z3_assert(
False,
"Integer, Z3 declaration, or Z3 constant expected")
6788 """Return a list with all symbols that have an interpretation in the model `self`.
6789 >>> f = Function('f', IntSort(), IntSort())
6792 >>> s.add(x > 0, x < 2, f(x) == 0)
6807 """Update the interpretation of a constant"""
6810 if is_func_decl(x)
and x.arity() != 0
and isinstance(value, FuncInterp):
6814 for i
in range(value.num_entries()):
6819 v.push(e.arg_value(j))
6824 raise Z3Exception(
"Expecting 0-ary function or constant expression")
6829 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
6832 _z3_assert(isinstance(target, Context),
"argument must be a Z3 context")
6837 """Perform model-based projection on fml with respect to vars.
6838 Assume that the model satisfies fml. Then compute a projection fml_p, such
6839 that vars do not occur free in fml_p, fml_p is true in the model and
6840 fml_p => exists vars . fml
6842 ctx = self.
ctx.ref()
6843 _vars = (Ast * len(vars))()
6844 for i
in range(len(vars)):
6845 _vars[i] = vars[i].as_ast()
6849 """Perform model-based projection, but also include realizer terms for the projected variables"""
6850 ctx = self.
ctx.ref()
6851 _vars = (Ast * len(vars))()
6852 for i
in range(len(vars)):
6853 _vars[i] = vars[i].as_ast()
6855 result = Z3_qe_model_project_with_witness(ctx, self.
model, len(vars), _vars, fml.ast, defs.map)
6870 for k, v
in eval.items():
6871 mdl.update_value(k, v)
6876 """Return true if n is a Z3 expression of the form (_ as-array f)."""
6877 return isinstance(n, ExprRef)
and Z3_is_as_array(n.ctx.ref(), n.as_ast())
6881 """Return the function declaration f associated with a Z3 expression of the form (_ as-array f)."""
6894 """Statistics for `Solver.check()`."""
6905 if self.
ctx.ref()
is not None and Z3_stats_dec_ref
is not None:
6912 out.write(u(
'<table border="1" cellpadding="2" cellspacing="0">'))
6915 out.write(u(
'<tr style="background-color:#CFCFCF">'))
6918 out.write(u(
"<tr>"))
6920 out.write(u(
"<td>%s</td><td>%s</td></tr>" % (k, v)))
6921 out.write(u(
"</table>"))
6922 return out.getvalue()
6927 """Return the number of statistical counters.
6930 >>> s = Then('simplify', 'nlsat').solver()
6934 >>> st = s.statistics()
6941 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6944 >>> s = Then('simplify', 'nlsat').solver()
6948 >>> st = s.statistics()
6952 ('nlsat propagations', 2)
6954 ('nlsat restarts', 1)
6956 if idx >= len(self):
6965 """Return the list of statistical counters.
6968 >>> s = Then('simplify', 'nlsat').solver()
6972 >>> st = s.statistics()
6977 """Return the value of a particular statistical counter.
6980 >>> s = Then('simplify', 'nlsat').solver()
6984 >>> st = s.statistics()
6985 >>> st.get_key_value('nlsat propagations')
6988 for idx
in range(len(self)):
6994 raise Z3Exception(
"unknown key")
6997 """Access the value of statistical using attributes.
6999 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
7000 we should use '_' (e.g., 'nlsat_propagations').
7003 >>> s = Then('simplify', 'nlsat').solver()
7007 >>> st = s.statistics()
7008 >>> st.nlsat_propagations
7013 key = name.replace(
"_",
" ")
7017 raise AttributeError
7027 """Represents the result of a satisfiability check: sat, unsat, unknown.
7033 >>> isinstance(r, CheckSatResult)
7044 return isinstance(other, CheckSatResult)
and self.
r == other.r
7047 return not self.
__eq__(other)
7051 if self.
r == Z3_L_TRUE:
7053 elif self.
r == Z3_L_FALSE:
7054 return "<b>unsat</b>"
7056 return "<b>unknown</b>"
7058 if self.
r == Z3_L_TRUE:
7060 elif self.
r == Z3_L_FALSE:
7066 in_html = in_html_mode()
7069 set_html_mode(in_html)
7080 Solver API provides methods for implementing the main SMT 2.0 commands:
7081 push, pop, check, get-model, etc.
7084 def __init__(self, solver=None, ctx=None, logFile=None):
7085 assert solver
is None or ctx
is not None
7094 if logFile
is not None:
7095 self.
set(
"smtlib2_log", logFile)
7098 if self.
solver is not None and self.
ctx.ref()
is not None and Z3_solver_dec_ref
is not None:
7109 """Set a configuration option.
7110 The method `help()` return a string containing all available options.
7113 >>> # The option MBQI can be set using three different approaches.
7114 >>> s.set(mbqi=True)
7115 >>> s.set('MBQI', True)
7116 >>> s.set(':mbqi', True)
7122 """Create a backtracking point.
7144 """Backtrack \\c num backtracking points.
7166 """Return the current number of backtracking points.
7184 """Remove all asserted constraints and backtracking points created using `push()`.
7198 """Assert constraints into the solver.
7202 >>> s.assert_exprs(x > 0, x < 2)
7209 if isinstance(arg, Goal)
or isinstance(arg, AstVector):
7217 """Assert constraints into the solver.
7221 >>> s.add(x > 0, x < 2)
7232 """Assert constraints into the solver.
7236 >>> s.append(x > 0, x < 2)
7243 """Assert constraints into the solver.
7247 >>> s.insert(x > 0, x < 2)
7254 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
7256 If `p` is a string, it will be automatically converted into a Boolean constant.
7261 >>> s.set(unsat_core=True)
7262 >>> s.assert_and_track(x > 0, 'p1')
7263 >>> s.assert_and_track(x != 1, 'p2')
7264 >>> s.assert_and_track(x < 0, p3)
7265 >>> print(s.check())
7267 >>> c = s.unsat_core()
7277 if isinstance(p, str):
7279 _z3_assert(isinstance(a, BoolRef),
"Boolean expression expected")
7284 """Check whether the assertions in the given solver plus the optional assumptions are consistent or not.
7290 >>> s.add(x > 0, x < 2)
7293 >>> s.model().eval(x)
7299 >>> s.add(2**x == 4)
7305 num = len(assumptions)
7306 _assumptions = (Ast * num)()
7307 for i
in range(num):
7308 _assumptions[i] = s.cast(assumptions[i]).as_ast()
7313 """Return a model for the last `check()`.
7315 This function raises an exception if
7316 a model is not available (e.g., last `check()` returned unsat).
7320 >>> s.add(a + 2 == 0)
7329 raise Z3Exception(
"model is not available")
7332 """Import model converter from other into the current solver"""
7333 Z3_solver_import_model_converter(self.ctx.ref(), other.solver, self.solver)
7335 def interrupt(self):
7336 """Interrupt the execution of the solver object.
7337 Remarks: This ensures that the interrupt applies only
7338 to the given solver object and it applies only if it is running.
7340 Z3_solver_interrupt(self.ctx.ref(), self.solver)
7342 def unsat_core(self):
7343 """Return a subset (as an AST vector) of the assumptions provided to the last check().
7345 These are the assumptions Z3 used in the unsatisfiability proof.
7346 Assumptions are available in Z3. They are used to extract unsatisfiable cores.
7347 They may be also used to "retract" assumptions. Note that, assumptions are not really
7348 "soft constraints", but they can be used to implement them.
7350 >>> p1, p2, p3 = Bools('p1 p2 p3')
7351 >>> x, y = Ints('x y')
7353 >>> s.add(Implies(p1, x > 0))
7354 >>> s.add(Implies(p2, y > x))
7355 >>> s.add(Implies(p2, y < 1))
7356 >>> s.add(Implies(p3, y > -3))
7357 >>> s.check(p1, p2, p3)
7359 >>> core = s.unsat_core()
7368 >>> # "Retracting" p2
7372 return AstVector(Z3_solver_get_unsat_core(self.ctx.ref(), self.solver), self.ctx)
7374 def consequences(self, assumptions, variables):
7375 """Determine fixed values for the variables based on the solver state and assumptions.
7377 >>> a, b, c, d = Bools('a b c d')
7378 >>> s.add(Implies(a,b), Implies(b, c))
7379 >>> s.consequences([a],[b,c,d])
7380 (sat, [Implies(a, b), Implies(a, c)])
7381 >>> s.consequences([Not(c),d],[a,b,c,d])
7382 (sat, [Implies(d, d), Implies(Not(c), Not(c)), Implies(Not(c), Not(b)), Implies(Not(c), Not(a))])
7384 if isinstance(assumptions, list):
7385 _asms = AstVector(None, self.ctx)
7386 for a in assumptions:
7389 if isinstance(variables, list):
7390 _vars = AstVector(None, self.ctx)
7394 _z3_assert(isinstance(assumptions, AstVector), "ast vector expected")
7395 _z3_assert(isinstance(variables, AstVector), "ast vector expected")
7396 consequences = AstVector(None, self.ctx)
7397 r = Z3_solver_get_consequences(self.ctx.ref(), self.solver, assumptions.vector,
7398 variables.vector, consequences.vector)
7399 sz = len(consequences)
7400 consequences = [consequences[i] for i in range(sz)]
7401 return CheckSatResult(r), consequences
7403 def from_file(self, filename):
7404 """Parse assertions from a file"""
7405 Z3_solver_from_file(self.ctx.ref(), self.solver, filename)
7407 def from_string(self, s):
7408 """Parse assertions from a string"""
7409 Z3_solver_from_string(self.ctx.ref(), self.solver, s)
7411 def cube(self, vars=None):
7413 The method takes an optional set of variables that restrict which
7414 variables may be used as a starting point for cubing.
7415 If vars is not None, then the first case split is based on a variable in
7418 self.cube_vs = AstVector(None, self.ctx)
7419 if vars is not None:
7421 self.cube_vs.push(v)
7423 lvl = self.backtrack_level
7424 self.backtrack_level = 4000000000
7425 r = AstVector(Z3_solver_cube(self.ctx.ref(), self.solver, self.cube_vs.vector, lvl), self.ctx)
7426 if (len(r) == 1 and is_false(r[0])):
7432 def cube_vars(self):
7433 """Access the set of variables that were touched by the most recently generated cube.
7434 This set of variables can be used as a starting point for additional cubes.
7435 The idea is that variables that appear in clauses that are reduced by the most recent
7436 cube are likely more useful to cube on."""
7440 """Retrieve congruence closure root of the term t relative to the current search state
7441 The function primarily works for SimpleSolver. Terms and variables that are
7442 eliminated during pre-processing are not visible to the congruence closure.
7444 t = _py2expr(t, self.ctx)
7445 return _to_expr_ref(Z3_solver_congruence_root(self.ctx.ref(), self.solver, t.ast), self.ctx)
7448 """Retrieve congruence closure sibling of the term t relative to the current search state
7449 The function primarily works for SimpleSolver. Terms and variables that are
7450 eliminated during pre-processing are not visible to the congruence closure.
7452 t = _py2expr(t, self.ctx)
7453 return _to_expr_ref(Z3_solver_congruence_next(self.ctx.ref(), self.solver, t.ast), self.ctx)
7455 def explain_congruent(self, a, b):
7456 """Explain congruence of a and b relative to the current search state"""
7457 a = _py2expr(a, self.ctx)
7458 b = _py2expr(b, self.ctx)
7459 return _to_expr_ref(Z3_solver_congruence_explain(self.ctx.ref(), self.solver, a.ast, b.ast), self.ctx)
7462 def solve_for(self, ts):
7463 """Retrieve a solution for t relative to linear equations maintained in the current state."""
7464 vars = AstVector(ctx=self.ctx);
7465 terms = AstVector(ctx=self.ctx);
7466 guards = AstVector(ctx=self.ctx);
7468 t = _py2expr(t, self.ctx)
7470 Z3_solver_solve_for(self.ctx.ref(), self.solver, vars.vector, terms.vector, guards.vector)
7471 return [(vars[i], terms[i], guards[i]) for i in range(len(vars))]
7475 """Return a proof for the last `check()`. Proof construction must be enabled."""
7476 return _to_expr_ref(Z3_solver_get_proof(self.ctx.ref(), self.solver), self.ctx)
7478 def assertions(self):
7479 """Return an AST vector containing all added constraints.
7490 return AstVector(Z3_solver_get_assertions(self.ctx.ref(), self.solver), self.ctx)
7493 """Return an AST vector containing all currently inferred units.
7495 return AstVector(Z3_solver_get_units(self.ctx.ref(), self.solver), self.ctx)
7497 def non_units(self):
7498 """Return an AST vector containing all atomic formulas in solver state that are not units.
7500 return AstVector(Z3_solver_get_non_units(self.ctx.ref(), self.solver), self.ctx)
7502 def trail_levels(self):
7503 """Return trail and decision levels of the solver state after a check() call.
7505 trail = self.trail()
7506 levels = (ctypes.c_uint * len(trail))()
7507 Z3_solver_get_levels(self.ctx.ref(), self.solver, trail.vector, len(trail), levels)
7508 return trail, levels
7510 def set_initial_value(self, var, value):
7511 """initialize the solver's state by setting the initial value of var to value
7514 value = s.cast(value)
7515 Z3_solver_set_initial_value(self.ctx.ref(), self.solver, var.ast, value.ast)
7518 """Return trail of the solver state after a check() call.
7520 return AstVector(Z3_solver_get_trail(self.ctx.ref(), self.solver), self.ctx)
7522 def statistics(self):
7523 """Return statistics for the last `check()`.
7525 >>> s = SimpleSolver()
7530 >>> st = s.statistics()
7531 >>> st.get_key_value('final checks')
7538 return Statistics(Z3_solver_get_statistics(self.ctx.ref(), self.solver), self.ctx)
7540 def reason_unknown(self):
7541 """Return a string describing why the last `check()` returned `unknown`.
7544 >>> s = SimpleSolver()
7545 >>> s.add(x == 2**x)
7548 >>> s.reason_unknown()
7549 '(incomplete (theory arithmetic))'
7551 return Z3_solver_get_reason_unknown(self.ctx.ref(), self.solver)
7554 """Display a string describing all available options."""
7555 print(Z3_solver_get_help(self.ctx.ref(), self.solver))
7557 def param_descrs(self):
7558 """Return the parameter description set."""
7559 return ParamDescrsRef(Z3_solver_get_param_descrs(self.ctx.ref(), self.solver), self.ctx)
7562 """Return a formatted string with all added constraints."""
7563 return obj_to_string(self)
7565 def translate(self, target):
7566 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
7570 >>> s1 = Solver(ctx=c1)
7571 >>> s2 = s1.translate(c2)
7574 _z3_assert(isinstance(target, Context), "argument must be a Z3 context")
7575 solver = Z3_solver_translate(self.ctx.ref(), self.solver, target.ref())
7576 return Solver(solver, target)
7579 return self.translate(self.ctx)
7581 def __deepcopy__(self, memo={}):
7582 return self.translate(self.ctx)
7585 """Return a formatted string (in Lisp-like format) with all added constraints.
7586 We say the string is in s-expression format.
7594 return Z3_solver_to_string(self.ctx.ref(), self.solver)
7596 def dimacs(self, include_names=True):
7597 """Return a textual representation of the solver in DIMACS format."""
7598 return Z3_solver_to_dimacs_string(self.ctx.ref(), self.solver, include_names)
7601 """return SMTLIB2 formatted benchmark for solver's assertions"""
7602 es = self.assertions()
7608 for i in range(sz1):
7609 v[i] = es[i].as_ast()
7611 e = es[sz1].as_ast()
7613 e = BoolVal(True, self.ctx).as_ast()
7614 return Z3_benchmark_to_smtlib_string(
7615 self.ctx.ref(), "benchmark generated from python API", "", "unknown", "", sz1, v, e,
7619def SolverFor(logic, ctx=None, logFile=None):
7620 """Create a solver customized for the given logic.
7622 The parameter `logic` is a string. It should be contains
7623 the name of a SMT-LIB logic.
7624 See http://www.smtlib.org/ for the name of all available logics.
7626 >>> s = SolverFor("QF_LIA")
7636 logic = to_symbol(logic)
7637 return Solver(Z3_mk_solver_for_logic(ctx.ref(), logic), ctx, logFile)
7640def SimpleSolver(ctx=None, logFile=None):
7641 """Return a simple general purpose solver with limited amount of preprocessing.
7643 >>> s = SimpleSolver()
7650 return Solver(Z3_mk_simple_solver(ctx.ref()), ctx, logFile)
7652#########################################
7656#########################################
7659class Fixedpoint(Z3PPObject):
7660 """Fixedpoint API provides methods for solving with recursive predicates"""
7662 def __init__(self, fixedpoint=None, ctx=None):
7663 assert fixedpoint is None or ctx is not None
7664 self.ctx = _get_ctx(ctx)
7665 self.fixedpoint = None
7666 if fixedpoint is None:
7667 self.fixedpoint = Z3_mk_fixedpoint(self.ctx.ref())
7669 self.fixedpoint = fixedpoint
7670 Z3_fixedpoint_inc_ref(self.ctx.ref(), self.fixedpoint)
7673 def __deepcopy__(self, memo={}):
7674 return FixedPoint(self.fixedpoint, self.ctx)
7677 if self.fixedpoint is not None and self.ctx.ref() is not None and Z3_fixedpoint_dec_ref is not None:
7678 Z3_fixedpoint_dec_ref(self.ctx.ref(), self.fixedpoint)
7680 def set(self, *args, **keys):
7681 """Set a configuration option. The method `help()` return a string containing all available options.
7683 p = args2params(args, keys, self.ctx)
7684 Z3_fixedpoint_set_params(self.ctx.ref(), self.fixedpoint, p.params)
7687 """Display a string describing all available options."""
7688 print(Z3_fixedpoint_get_help(self.ctx.ref(), self.fixedpoint))
7690 def param_descrs(self):
7691 """Return the parameter description set."""
7692 return ParamDescrsRef(Z3_fixedpoint_get_param_descrs(self.ctx.ref(), self.fixedpoint), self.ctx)
7694 def assert_exprs(self, *args):
7695 """Assert constraints as background axioms for the fixedpoint solver."""
7696 args = _get_args(args)
7697 s = BoolSort(self.ctx)
7699 if isinstance(arg, Goal) or isinstance(arg, AstVector):
7701 f = self.abstract(f)
7702 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, f.as_ast())
7705 arg = self.abstract(arg)
7706 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, arg.as_ast())
7708 def add(self, *args):
7709 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7710 self.assert_exprs(*args)
7712 def __iadd__(self, fml):
7716 def append(self, *args):
7717 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7718 self.assert_exprs(*args)
7720 def insert(self, *args):
7721 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7722 self.assert_exprs(*args)
7724 def add_rule(self, head, body=None, name=None):
7725 """Assert rules defining recursive predicates to the fixedpoint solver.
7728 >>> s = Fixedpoint()
7729 >>> s.register_relation(a.decl())
7730 >>> s.register_relation(b.decl())
7738 name = to_symbol(name, self.ctx)
7740 head = self.abstract(head)
7741 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, head.as_ast(), name)
7743 body = _get_args(body)
7744 f = self.abstract(Implies(And(body, self.ctx), head))
7745 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7747 def rule(self, head, body=None, name=None):
7748 """Assert rules defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7749 self.add_rule(head, body, name)
7751 def fact(self, head, name=None):
7752 """Assert facts defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7753 self.add_rule(head, None, name)
7755 def query(self, *query):
7756 """Query the fixedpoint engine whether formula is derivable.
7757 You can also pass an tuple or list of recursive predicates.
7759 query = _get_args(query)
7761 if sz >= 1 and isinstance(query[0], FuncDeclRef):
7762 _decls = (FuncDecl * sz)()
7767 r = Z3_fixedpoint_query_relations(self.ctx.ref(), self.fixedpoint, sz, _decls)
7772 query = And(query, self.ctx)
7773 query = self.abstract(query, False)
7774 r = Z3_fixedpoint_query(self.ctx.ref(), self.fixedpoint, query.as_ast())
7775 return CheckSatResult(r)
7777 def query_from_lvl(self, lvl, *query):
7778 """Query the fixedpoint engine whether formula is derivable starting at the given query level.
7780 query = _get_args(query)
7782 if sz >= 1 and isinstance(query[0], FuncDecl):
7783 _z3_assert(False, "unsupported")
7789 query = self.abstract(query, False)
7790 r = Z3_fixedpoint_query_from_lvl(self.ctx.ref(), self.fixedpoint, query.as_ast(), lvl)
7791 return CheckSatResult(r)
7793 def update_rule(self, head, body, name):
7797 name = to_symbol(name, self.ctx)
7798 body = _get_args(body)
7799 f = self.abstract(Implies(And(body, self.ctx), head))
7800 Z3_fixedpoint_update_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7802 def get_answer(self):
7803 """Retrieve answer from last query call."""
7804 r = Z3_fixedpoint_get_answer(self.ctx.ref(), self.fixedpoint)
7805 return _to_expr_ref(r, self.ctx)
7807 def get_ground_sat_answer(self):
7808 """Retrieve a ground cex from last query call."""
7809 r = Z3_fixedpoint_get_ground_sat_answer(self.ctx.ref(), self.fixedpoint)
7810 return _to_expr_ref(r, self.ctx)
7812 def get_rules_along_trace(self):
7813 """retrieve rules along the counterexample trace"""
7814 return AstVector(Z3_fixedpoint_get_rules_along_trace(self.ctx.ref(), self.fixedpoint), self.ctx)
7816 def get_rule_names_along_trace(self):
7817 """retrieve rule names along the counterexample trace"""
7818 # this is a hack as I don't know how to return a list of symbols from C++;
7819 # obtain names as a single string separated by semicolons
7820 names = _symbol2py(self.ctx, Z3_fixedpoint_get_rule_names_along_trace(self.ctx.ref(), self.fixedpoint))
7821 # split into individual names
7822 return names.split(";")
7824 def get_num_levels(self, predicate):
7825 """Retrieve number of levels used for predicate in PDR engine"""
7826 return Z3_fixedpoint_get_num_levels(self.ctx.ref(), self.fixedpoint, predicate.ast)
7828 def get_cover_delta(self, level, predicate):
7829 """Retrieve properties known about predicate for the level'th unfolding.
7830 -1 is treated as the limit (infinity)
7832 r = Z3_fixedpoint_get_cover_delta(self.ctx.ref(), self.fixedpoint, level, predicate.ast)
7833 return _to_expr_ref(r, self.ctx)
7835 def add_cover(self, level, predicate, property):
7836 """Add property to predicate for the level'th unfolding.
7837 -1 is treated as infinity (infinity)
7839 Z3_fixedpoint_add_cover(self.ctx.ref(), self.fixedpoint, level, predicate.ast, property.ast)
7841 def register_relation(self, *relations):
7842 """Register relation as recursive"""
7843 relations = _get_args(relations)
7845 Z3_fixedpoint_register_relation(self.ctx.ref(), self.fixedpoint, f.ast)
7847 def set_predicate_representation(self, f, *representations):
7848 """Control how relation is represented"""
7849 representations = _get_args(representations)
7850 representations = [to_symbol(s) for s in representations]
7851 sz = len(representations)
7852 args = (Symbol * sz)()
7854 args[i] = representations[i]
7855 Z3_fixedpoint_set_predicate_representation(self.ctx.ref(), self.fixedpoint, f.ast, sz, args)
7857 def parse_string(self, s):
7858 """Parse rules and queries from a string"""
7859 return AstVector(Z3_fixedpoint_from_string(self.ctx.ref(), self.fixedpoint, s), self.ctx)
7861 def parse_file(self, f):
7862 """Parse rules and queries from a file"""
7863 return AstVector(Z3_fixedpoint_from_file(self.ctx.ref(), self.fixedpoint, f), self.ctx)
7865 def get_rules(self):
7866 """retrieve rules that have been added to fixedpoint context"""
7867 return AstVector(Z3_fixedpoint_get_rules(self.ctx.ref(), self.fixedpoint), self.ctx)
7869 def get_assertions(self):
7870 """retrieve assertions that have been added to fixedpoint context"""
7871 return AstVector(Z3_fixedpoint_get_assertions(self.ctx.ref(), self.fixedpoint), self.ctx)
7874 """Return a formatted string with all added rules and constraints."""
7878 """Return a formatted string (in Lisp-like format) with all added constraints.
7879 We say the string is in s-expression format.
7881 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, 0, (Ast * 0)())
7883 def to_string(self, queries):
7884 """Return a formatted string (in Lisp-like format) with all added constraints.
7885 We say the string is in s-expression format.
7886 Include also queries.
7888 args, len = _to_ast_array(queries)
7889 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, len, args)
7891 def statistics(self):
7892 """Return statistics for the last `query()`.
7894 return Statistics(Z3_fixedpoint_get_statistics(self.ctx.ref(), self.fixedpoint), self.ctx)
7896 def reason_unknown(self):
7897 """Return a string describing why the last `query()` returned `unknown`.
7899 return Z3_fixedpoint_get_reason_unknown(self.ctx.ref(), self.fixedpoint)
7901 def declare_var(self, *vars):
7902 """Add variable or several variables.
7903 The added variable or variables will be bound in the rules
7906 vars = _get_args(vars)
7910 def abstract(self, fml, is_forall=True):
7914 return ForAll(self.vars, fml)
7916 return Exists(self.vars, fml)
7919#########################################
7923#########################################
7925class FiniteDomainSortRef(SortRef):
7926 """Finite domain sort."""
7929 """Return the size of the finite domain sort"""
7930 r = (ctypes.c_ulonglong * 1)()
7931 if Z3_get_finite_domain_sort_size(self.ctx_ref(), self.ast, r):
7934 raise Z3Exception("Failed to retrieve finite domain sort size")
7937def FiniteDomainSort(name, sz, ctx=None):
7938 """Create a named finite domain sort of a given size sz"""
7939 if not isinstance(name, Symbol):
7940 name = to_symbol(name)
7942 return FiniteDomainSortRef(Z3_mk_finite_domain_sort(ctx.ref(), name, sz), ctx)
7945def is_finite_domain_sort(s):
7946 """Return True if `s` is a Z3 finite-domain sort.
7948 >>> is_finite_domain_sort(FiniteDomainSort('S', 100))
7950 >>> is_finite_domain_sort(IntSort())
7953 return isinstance(s, FiniteDomainSortRef)
7956class FiniteDomainRef(ExprRef):
7957 """Finite-domain expressions."""
7960 """Return the sort of the finite-domain expression `self`."""
7961 return FiniteDomainSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
7963 def as_string(self):
7964 """Return a Z3 floating point expression as a Python string."""
7965 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
7968def is_finite_domain(a):
7969 """Return `True` if `a` is a Z3 finite-domain expression.
7971 >>> s = FiniteDomainSort('S', 100)
7972 >>> b = Const('b', s)
7973 >>> is_finite_domain(b)
7975 >>> is_finite_domain(Int('x'))
7978 return isinstance(a, FiniteDomainRef)
7981class FiniteDomainNumRef(FiniteDomainRef):
7982 """Integer values."""
7985 """Return a Z3 finite-domain numeral as a Python long (bignum) numeral.
7987 >>> s = FiniteDomainSort('S', 100)
7988 >>> v = FiniteDomainVal(3, s)
7994 return int(self.as_string())
7996 def as_string(self):
7997 """Return a Z3 finite-domain numeral as a Python string.
7999 >>> s = FiniteDomainSort('S', 100)
8000 >>> v = FiniteDomainVal(42, s)
8004 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
8007def FiniteDomainVal(val, sort, ctx=None):
8008 """Return a Z3 finite-domain value. If `ctx=None`, then the global context is used.
8010 >>> s = FiniteDomainSort('S', 256)
8011 >>> FiniteDomainVal(255, s)
8013 >>> FiniteDomainVal('100', s)
8017 _z3_assert(is_finite_domain_sort(sort), "Expected finite-domain sort")
8019 return FiniteDomainNumRef(Z3_mk_numeral(ctx.ref(), _to_int_str(val), sort.ast), ctx)
8022def is_finite_domain_value(a):
8023 """Return `True` if `a` is a Z3 finite-domain value.
8025 >>> s = FiniteDomainSort('S', 100)
8026 >>> b = Const('b', s)
8027 >>> is_finite_domain_value(b)
8029 >>> b = FiniteDomainVal(10, s)
8032 >>> is_finite_domain_value(b)
8035 return is_finite_domain(a) and _is_numeral(a.ctx, a.as_ast())
8038#########################################
8042#########################################
8044class OptimizeObjective:
8045 def __init__(self, opt, value, is_max):
8048 self._is_max = is_max
8052 return _to_expr_ref(Z3_optimize_get_lower(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8056 return _to_expr_ref(Z3_optimize_get_upper(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8058 def lower_values(self):
8060 return AstVector(Z3_optimize_get_lower_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8062 def upper_values(self):
8064 return AstVector(Z3_optimize_get_upper_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8073 return "%s:%s" % (self._value, self._is_max)
8079def _global_on_model(ctx):
8080 (fn, mdl) = _on_models[ctx]
8084_on_model_eh = on_model_eh_type(_global_on_model)
8087class Optimize(Z3PPObject):
8088 """Optimize API provides methods for solving using objective functions and weighted soft constraints"""
8090 def __init__(self, optimize=None, ctx=None):
8091 self.ctx = _get_ctx(ctx)
8092 if optimize is None:
8093 self.optimize = Z3_mk_optimize(self.ctx.ref())
8095 self.optimize = optimize
8096 self._on_models_id = None
8097 Z3_optimize_inc_ref(self.ctx.ref(), self.optimize)
8099 def __deepcopy__(self, memo={}):
8100 return Optimize(self.optimize, self.ctx)
8103 if self.optimize is not None and self.ctx.ref() is not None and Z3_optimize_dec_ref is not None:
8104 Z3_optimize_dec_ref(self.ctx.ref(), self.optimize)
8105 if self._on_models_id is not None:
8106 del _on_models[self._on_models_id]
8108 def __enter__(self):
8112 def __exit__(self, *exc_info):
8115 def set(self, *args, **keys):
8116 """Set a configuration option.
8117 The method `help()` return a string containing all available options.
8119 p = args2params(args, keys, self.ctx)
8120 Z3_optimize_set_params(self.ctx.ref(), self.optimize, p.params)
8123 """Display a string describing all available options."""
8124 print(Z3_optimize_get_help(self.ctx.ref(), self.optimize))
8126 def param_descrs(self):
8127 """Return the parameter description set."""
8128 return ParamDescrsRef(Z3_optimize_get_param_descrs(self.ctx.ref(), self.optimize), self.ctx)
8130 def assert_exprs(self, *args):
8131 """Assert constraints as background axioms for the optimize solver."""
8132 args = _get_args(args)
8133 s = BoolSort(self.ctx)
8135 if isinstance(arg, Goal) or isinstance(arg, AstVector):
8137 Z3_optimize_assert(self.ctx.ref(), self.optimize, f.as_ast())
8140 Z3_optimize_assert(self.ctx.ref(), self.optimize, arg.as_ast())
8142 def add(self, *args):
8143 """Assert constraints as background axioms for the optimize solver. Alias for assert_expr."""
8144 self.assert_exprs(*args)
8146 def __iadd__(self, fml):
8150 def assert_and_track(self, a, p):
8151 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
8153 If `p` is a string, it will be automatically converted into a Boolean constant.
8158 >>> s.assert_and_track(x > 0, 'p1')
8159 >>> s.assert_and_track(x != 1, 'p2')
8160 >>> s.assert_and_track(x < 0, p3)
8161 >>> print(s.check())
8163 >>> c = s.unsat_core()
8173 if isinstance(p, str):
8174 p = Bool(p, self.ctx)
8175 _z3_assert(isinstance(a, BoolRef), "Boolean expression expected")
8176 _z3_assert(isinstance(p, BoolRef) and is_const(p), "Boolean expression expected")
8177 Z3_optimize_assert_and_track(self.ctx.ref(), self.optimize, a.as_ast(), p.as_ast())
8179 def add_soft(self, arg, weight="1", id=None):
8180 """Add soft constraint with optional weight and optional identifier.
8181 If no weight is supplied, then the penalty for violating the soft constraint
8183 Soft constraints are grouped by identifiers. Soft constraints that are
8184 added without identifiers are grouped by default.
8187 weight = "%d" % weight
8188 elif isinstance(weight, float):
8189 weight = "%f" % weight
8190 if not isinstance(weight, str):
8191 raise Z3Exception("weight should be a string or an integer")
8194 id = to_symbol(id, self.ctx)
8197 v = Z3_optimize_assert_soft(self.ctx.ref(), self.optimize, a.as_ast(), weight, id)
8198 return OptimizeObjective(self, v, False)
8199 if sys.version_info.major >= 3 and isinstance(arg, Iterable):
8200 return [asoft(a) for a in arg]
8203 def set_initial_value(self, var, value):
8204 """initialize the solver's state by setting the initial value of var to value
8207 value = s.cast(value)
8208 Z3_optimize_set_initial_value(self.ctx.ref(), self.optimize, var.ast, value.ast)
8210 def maximize(self, arg):
8211 """Add objective function to maximize."""
8212 return OptimizeObjective(
8214 Z3_optimize_maximize(self.ctx.ref(), self.optimize, arg.as_ast()),
8218 def minimize(self, arg):
8219 """Add objective function to minimize."""
8220 return OptimizeObjective(
8222 Z3_optimize_minimize(self.ctx.ref(), self.optimize, arg.as_ast()),
8227 """create a backtracking point for added rules, facts and assertions"""
8228 Z3_optimize_push(self.ctx.ref(), self.optimize)
8231 """restore to previously created backtracking point"""
8232 Z3_optimize_pop(self.ctx.ref(), self.optimize)
8234 def check(self, *assumptions):
8235 """Check consistency and produce optimal values."""
8236 assumptions = _get_args(assumptions)
8237 num = len(assumptions)
8238 _assumptions = (Ast * num)()
8239 for i in range(num):
8240 _assumptions[i] = assumptions[i].as_ast()
8241 return CheckSatResult(Z3_optimize_check(self.ctx.ref(), self.optimize, num, _assumptions))
8243 def reason_unknown(self):
8244 """Return a string that describes why the last `check()` returned `unknown`."""
8245 return Z3_optimize_get_reason_unknown(self.ctx.ref(), self.optimize)
8248 """Return a model for the last check()."""
8250 return ModelRef(Z3_optimize_get_model(self.ctx.ref(), self.optimize), self.ctx)
8252 raise Z3Exception("model is not available")
8254 def unsat_core(self):
8255 return AstVector(Z3_optimize_get_unsat_core(self.ctx.ref(), self.optimize), self.ctx)
8257 def lower(self, obj):
8258 if not isinstance(obj, OptimizeObjective):
8259 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8262 def upper(self, obj):
8263 if not isinstance(obj, OptimizeObjective):
8264 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8267 def lower_values(self, obj):
8268 if not isinstance(obj, OptimizeObjective):
8269 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8270 return obj.lower_values()
8272 def upper_values(self, obj):
8273 if not isinstance(obj, OptimizeObjective):
8274 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8275 return obj.upper_values()
8277 def from_file(self, filename):
8278 """Parse assertions and objectives from a file"""
8279 Z3_optimize_from_file(self.ctx.ref(), self.optimize, filename)
8281 def from_string(self, s):
8282 """Parse assertions and objectives from a string"""
8283 Z3_optimize_from_string(self.ctx.ref(), self.optimize, s)
8285 def assertions(self):
8286 """Return an AST vector containing all added constraints."""
8287 return AstVector(Z3_optimize_get_assertions(self.ctx.ref(), self.optimize), self.ctx)
8289 def objectives(self):
8290 """returns set of objective functions"""
8291 return AstVector(Z3_optimize_get_objectives(self.ctx.ref(), self.optimize), self.ctx)
8294 """Return a formatted string with all added rules and constraints."""
8298 """Return a formatted string (in Lisp-like format) with all added constraints.
8299 We say the string is in s-expression format.
8301 return Z3_optimize_to_string(self.ctx.ref(), self.optimize)
8303 def statistics(self):
8304 """Return statistics for the last check`.
8306 return Statistics(Z3_optimize_get_statistics(self.ctx.ref(), self.optimize), self.ctx)
8308 def set_on_model(self, on_model):
8309 """Register a callback that is invoked with every incremental improvement to
8310 objective values. The callback takes a model as argument.
8311 The life-time of the model is limited to the callback so the
8312 model has to be (deep) copied if it is to be used after the callback
8314 id = len(_on_models) + 41
8315 mdl = Model(self.ctx)
8316 _on_models[id] = (on_model, mdl)
8317 self._on_models_id = id
8318 Z3_optimize_register_model_eh(
8319 self.ctx.ref(), self.optimize, mdl.model, ctypes.c_void_p(id), _on_model_eh,
8323#########################################
8327#########################################
8328class ApplyResult(Z3PPObject):
8329 """An ApplyResult object contains the subgoals produced by a tactic when applied to a goal.
8330 It also contains model and proof converters.
8333 def __init__(self, result, ctx):
8334 self.result = result
8336 Z3_apply_result_inc_ref(self.ctx.ref(), self.result)
8338 def __deepcopy__(self, memo={}):
8339 return ApplyResult(self.result, self.ctx)
8342 if self.ctx.ref() is not None and Z3_apply_result_dec_ref is not None:
8343 Z3_apply_result_dec_ref(self.ctx.ref(), self.result)
8346 """Return the number of subgoals in `self`.
8348 >>> a, b = Ints('a b')
8350 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8351 >>> t = Tactic('split-clause')
8355 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
8358 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
8362 return int(Z3_apply_result_get_num_subgoals(self.ctx.ref(), self.result))
8364 def __getitem__(self, idx):
8365 """Return one of the subgoals stored in ApplyResult object `self`.
8367 >>> a, b = Ints('a b')
8369 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8370 >>> t = Tactic('split-clause')
8373 [a == 0, Or(b == 0, b == 1), a > b]
8375 [a == 1, Or(b == 0, b == 1), a > b]
8377 if idx >= len(self):
8379 return Goal(goal=Z3_apply_result_get_subgoal(self.ctx.ref(), self.result, idx), ctx=self.ctx)
8382 return obj_to_string(self)
8385 """Return a textual representation of the s-expression representing the set of subgoals in `self`."""
8386 return Z3_apply_result_to_string(self.ctx.ref(), self.result)
8389 """Return a Z3 expression consisting of all subgoals.
8394 >>> g.add(Or(x == 2, x == 3))
8395 >>> r = Tactic('simplify')(g)
8397 [[Not(x <= 1), Or(x == 2, x == 3)]]
8399 And(Not(x <= 1), Or(x == 2, x == 3))
8400 >>> r = Tactic('split-clause')(g)
8402 [[x > 1, x == 2], [x > 1, x == 3]]
8404 Or(And(x > 1, x == 2), And(x > 1, x == 3))
8408 return BoolVal(False, self.ctx)
8410 return self[0].as_expr()
8412 return Or([self[i].as_expr() for i in range(len(self))])
8414#########################################
8418#########################################
8421 """Simplifiers act as pre-processing utilities for solvers.
8422 Build a custom simplifier and add it to a solve
r"""
8424 def __init__(self, simplifier, ctx=None):
8425 self.ctx = _get_ctx(ctx)
8426 self.simplifier = None
8427 if isinstance(simplifier, SimplifierObj):
8428 self.simplifier = simplifier
8429 elif isinstance(simplifier, list):
8430 simps = [Simplifier(s, ctx) for s in simplifier]
8431 self.simplifier = simps[0].simplifier
8432 for i in range(1, len(simps)):
8433 self.simplifier = Z3_simplifier_and_then(self.ctx.ref(), self.simplifier, simps[i].simplifier)
8434 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8438 _z3_assert(isinstance(simplifier, str), "simplifier name expected")
8440 self.simplifier = Z3_mk_simplifier(self.ctx.ref(), str(simplifier))
8442 raise Z3Exception("unknown simplifier '%s'" % simplifier)
8443 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8445 def __deepcopy__(self, memo={}):
8446 return Simplifier(self.simplifier, self.ctx)
8449 if self.simplifier is not None and self.ctx.ref() is not None and Z3_simplifier_dec_ref is not None:
8450 Z3_simplifier_dec_ref(self.ctx.ref(), self.simplifier)
8452 def using_params(self, *args, **keys):
8453 """Return a simplifier that uses the given configuration options"""
8454 p = args2params(args, keys, self.ctx)
8455 return Simplifier(Z3_simplifier_using_params(self.ctx.ref(), self.simplifier, p.params), self.ctx)
8457 def add(self, solver):
8458 """Return a solver that applies the simplification pre-processing specified by the simplifie
r"""
8459 return Solver(Z3_solver_add_simplifier(self.ctx.ref(), solver.solver, self.simplifier), self.ctx)
8462 """Display a string containing a description of the available options for the `self` simplifier."""
8463 print(Z3_simplifier_get_help(self.ctx.ref(), self.simplifier))
8465 def param_descrs(self):
8466 """Return the parameter description set."""
8467 return ParamDescrsRef(Z3_simplifier_get_param_descrs(self.ctx.ref(), self.simplifier), self.ctx)
8470#########################################
8474#########################################
8478 """Tactics transform, solver and/or simplify sets of constraints (Goal).
8479 A Tactic can be converted into a Solver using the method solver().
8481 Several combinators are available for creating new tactics using the built-in ones:
8482 Then(), OrElse(), FailIf(), Repeat(), When(), Cond().
8485 def __init__(self, tactic, ctx=None):
8486 self.ctx = _get_ctx(ctx)
8488 if isinstance(tactic, TacticObj):
8489 self.tactic = tactic
8492 _z3_assert(isinstance(tactic, str), "tactic name expected")
8494 self.tactic = Z3_mk_tactic(self.ctx.ref(), str(tactic))
8496 raise Z3Exception("unknown tactic '%s'" % tactic)
8497 Z3_tactic_inc_ref(self.ctx.ref(), self.tactic)
8499 def __deepcopy__(self, memo={}):
8500 return Tactic(self.tactic, self.ctx)
8503 if self.tactic is not None and self.ctx.ref() is not None and Z3_tactic_dec_ref is not None:
8504 Z3_tactic_dec_ref(self.ctx.ref(), self.tactic)
8506 def solver(self, logFile=None):
8507 """Create a solver using the tactic `self`.
8509 The solver supports the methods `push()` and `pop()`, but it
8510 will always solve each `check()` from scratch.
8512 >>> t = Then('simplify', 'nlsat')
8515 >>> s.add(x**2 == 2, x > 0)
8521 return Solver(Z3_mk_solver_from_tactic(self.ctx.ref(), self.tactic), self.ctx, logFile)
8523 def apply(self, goal, *arguments, **keywords):
8524 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8526 >>> x, y = Ints('x y')
8527 >>> t = Tactic('solve-eqs')
8528 >>> t.apply(And(x == 0, y >= x + 1))
8532 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expressions expected")
8533 goal = _to_goal(goal)
8534 if len(arguments) > 0 or len(keywords) > 0:
8535 p = args2params(arguments, keywords, self.ctx)
8536 return ApplyResult(Z3_tactic_apply_ex(self.ctx.ref(), self.tactic, goal.goal, p.params), self.ctx)
8538 return ApplyResult(Z3_tactic_apply(self.ctx.ref(), self.tactic, goal.goal), self.ctx)
8540 def __call__(self, goal, *arguments, **keywords):
8541 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8543 >>> x, y = Ints('x y')
8544 >>> t = Tactic('solve-eqs')
8545 >>> t(And(x == 0, y >= x + 1))
8548 return self.apply(goal, *arguments, **keywords)
8551 """Display a string containing a description of the available options for the `self` tactic."""
8552 print(Z3_tactic_get_help(self.ctx.ref(), self.tactic))
8554 def param_descrs(self):
8555 """Return the parameter description set."""
8556 return ParamDescrsRef(Z3_tactic_get_param_descrs(self.ctx.ref(), self.tactic), self.ctx)
8560 if isinstance(a, BoolRef):
8561 goal = Goal(ctx=a.ctx)
8568def _to_tactic(t, ctx=None):
8569 if isinstance(t, Tactic):
8572 return Tactic(t, ctx)
8575def _and_then(t1, t2, ctx=None):
8576 t1 = _to_tactic(t1, ctx)
8577 t2 = _to_tactic(t2, ctx)
8579 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8580 return Tactic(Z3_tactic_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8583def _or_else(t1, t2, ctx=None):
8584 t1 = _to_tactic(t1, ctx)
8585 t2 = _to_tactic(t2, ctx)
8587 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8588 return Tactic(Z3_tactic_or_else(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8591def AndThen(*ts, **ks):
8592 """Return a tactic that applies the tactics in `*ts` in sequence.
8594 >>> x, y = Ints('x y')
8595 >>> t = AndThen(Tactic('simplify'), Tactic('solve-eqs'))
8596 >>> t(And(x == 0, y > x + 1))
8598 >>> t(And(x == 0, y > x + 1)).as_expr()
8602 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8603 ctx = ks.get("ctx", None)
8606 for i in range(num - 1):
8607 r = _and_then(r, ts[i + 1], ctx)
8612 """Return a tactic that applies the tactics in `*ts` in sequence. Shorthand for AndThen(*ts, **ks).
8614 >>> x, y = Ints('x y')
8615 >>> t = Then(Tactic('simplify'), Tactic('solve-eqs'))
8616 >>> t(And(x == 0, y > x + 1))
8618 >>> t(And(x == 0, y > x + 1)).as_expr()
8621 return AndThen(*ts, **ks)
8624def OrElse(*ts, **ks):
8625 """Return a tactic that applies the tactics in `*ts` until one of them succeeds (it doesn't fail).
8628 >>> t = OrElse(Tactic('split-clause'), Tactic('skip'))
8629 >>> # Tactic split-clause fails if there is no clause in the given goal.
8632 >>> t(Or(x == 0, x == 1))
8633 [[x == 0], [x == 1]]
8636 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8637 ctx = ks.get("ctx", None)
8640 for i in range(num - 1):
8641 r = _or_else(r, ts[i + 1], ctx)
8645def ParOr(*ts, **ks):
8646 """Return a tactic that applies the tactics in `*ts` in parallel until one of them succeeds (it doesn't fail).
8649 >>> t = ParOr(Tactic('simplify'), Tactic('fail'))
8654 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8655 ctx = _get_ctx(ks.get("ctx", None))
8656 ts = [_to_tactic(t, ctx) for t in ts]
8658 _args = (TacticObj * sz)()
8660 _args[i] = ts[i].tactic
8661 return Tactic(Z3_tactic_par_or(ctx.ref(), sz, _args), ctx)
8664def ParThen(t1, t2, ctx=None):
8665 """Return a tactic that applies t1 and then t2 to every subgoal produced by t1.
8666 The subgoals are processed in parallel.
8668 >>> x, y = Ints('x y')
8669 >>> t = ParThen(Tactic('split-clause'), Tactic('propagate-values'))
8670 >>> t(And(Or(x == 1, x == 2), y == x + 1))
8671 [[x == 1, y == 2], [x == 2, y == 3]]
8673 t1 = _to_tactic(t1, ctx)
8674 t2 = _to_tactic(t2, ctx)
8676 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8677 return Tactic(Z3_tactic_par_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8680def ParAndThen(t1, t2, ctx=None):
8681 """Alias for ParThen(t1, t2, ctx)."""
8682 return ParThen(t1, t2, ctx)
8685def With(t, *args, **keys):
8686 """Return a tactic that applies tactic `t` using the given configuration options.
8688 >>> x, y = Ints('x y')
8689 >>> t = With(Tactic('simplify'), som=True)
8690 >>> t((x + 1)*(y + 2) == 0)
8691 [[2*x + y + x*y == -2]]
8693 ctx = keys.pop("ctx", None)
8694 t = _to_tactic(t, ctx)
8695 p = args2params(args, keys, t.ctx)
8696 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8699def WithParams(t, p):
8700 """Return a tactic that applies tactic `t` using the given configuration options.
8702 >>> x, y = Ints('x y')
8704 >>> p.set("som", True)
8705 >>> t = WithParams(Tactic('simplify'), p)
8706 >>> t((x + 1)*(y + 2) == 0)
8707 [[2*x + y + x*y == -2]]
8709 t = _to_tactic(t, None)
8710 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8713def Repeat(t, max=4294967295, ctx=None):
8714 """Return a tactic that keeps applying `t` until the goal is not modified anymore
8715 or the maximum number of iterations `max` is reached.
8717 >>> x, y = Ints('x y')
8718 >>> c = And(Or(x == 0, x == 1), Or(y == 0, y == 1), x > y)
8719 >>> t = Repeat(OrElse(Tactic('split-clause'), Tactic('skip')))
8721 >>> for subgoal in r: print(subgoal)
8722 [x == 0, y == 0, x > y]
8723 [x == 0, y == 1, x > y]
8724 [x == 1, y == 0, x > y]
8725 [x == 1, y == 1, x > y]
8726 >>> t = Then(t, Tactic('propagate-values'))
8730 t = _to_tactic(t, ctx)
8731 return Tactic(Z3_tactic_repeat(t.ctx.ref(), t.tactic, max), t.ctx)
8734def TryFor(t, ms, ctx=None):
8735 """Return a tactic that applies `t` to a given goal for `ms` milliseconds.
8737 If `t` does not terminate in `ms` milliseconds, then it fails.
8739 t = _to_tactic(t, ctx)
8740 return Tactic(Z3_tactic_try_for(t.ctx.ref(), t.tactic, ms), t.ctx)
8743def tactics(ctx=None):
8744 """Return a list of all available tactics in Z3.
8747 >>> l.count('simplify') == 1
8751 return [Z3_get_tactic_name(ctx.ref(), i) for i in range(Z3_get_num_tactics(ctx.ref()))]
8754def tactic_description(name, ctx=None):
8755 """Return a short description for the tactic named `name`.
8757 >>> d = tactic_description('simplify')
8760 return Z3_tactic_get_descr(ctx.ref(), name)
8763def describe_tactics():
8764 """Display a (tabular) description of all available tactics in Z3."""
8767 print('<table border="1" cellpadding="2" cellspacing="0">')
8770 print('<tr style="background-color:#CFCFCF">')
8775 print("<td>%s</td><td>%s</td></tr>" % (t, insert_line_breaks(tactic_description(t), 40)))
8779 print("%s : %s" % (t, tactic_description(t)))
8783 """Probes are used to inspect a goal (aka problem) and collect information that may be used
8784 to decide which solver and/or preprocessing step will be used.
8787 def __init__(self, probe, ctx=None):
8788 self.ctx = _get_ctx(ctx)
8790 if isinstance(probe, ProbeObj):
8792 elif isinstance(probe, float):
8793 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8794 elif _is_int(probe):
8795 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8796 elif isinstance(probe, bool):
8798 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8800 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8803 _z3_assert(isinstance(probe, str), "probe name expected")
8805 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8807 raise Z3Exception("unknown probe '%s'" % probe)
8808 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8810 def __deepcopy__(self, memo={}):
8811 return Probe(self.probe, self.ctx)
8814 if self.probe is not None and self.ctx.ref() is not None and Z3_probe_dec_ref is not None:
8815 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8817 def __lt__(self, other):
8818 """Return a probe that evaluates to "true" when the value returned by `self`
8819 is less than the value returned by `other`.
8821 >>> p = Probe('size') < 10
8829 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8831 def __gt__(self, other):
8832 """Return a probe that evaluates to "true" when the value returned by `self`
8833 is greater than the value returned by `other`.
8835 >>> p = Probe('size') > 10
8843 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8845 def __le__(self, other):
8846 """Return a probe that evaluates to "true" when the value returned by `self`
8847 is less than or equal to the value returned by `other`.
8849 >>> p = Probe('size') <= 2
8857 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8859 def __ge__(self, other):
8860 """Return a probe that evaluates to "true" when the value returned by `self`
8861 is greater than or equal to the value returned by `other`.
8863 >>> p = Probe('size') >= 2
8871 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8873 def __eq__(self, other):
8874 """Return a probe that evaluates to "true" when the value returned by `self`
8875 is equal to the value returned by `other`.
8877 >>> p = Probe('size') == 2
8885 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8887 def __ne__(self, other):
8888 """Return a probe that evaluates to "true" when the value returned by `self`
8889 is not equal to the value returned by `other`.
8891 >>> p = Probe('size') != 2
8899 p = self.__eq__(other)
8900 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8902 def __call__(self, goal):
8903 """Evaluate the probe `self` in the given goal.
8905 >>> p = Probe('size')
8915 >>> p = Probe('num-consts')
8918 >>> p = Probe('is-propositional')
8921 >>> p = Probe('is-qflia')
8926 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
8927 goal = _to_goal(goal)
8928 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8932 """Return `True` if `p` is a Z3 probe.
8934 >>> is_probe(Int('x'))
8936 >>> is_probe(Probe('memory'))
8939 return isinstance(p, Probe)
8942def _to_probe(p, ctx=None):
8946 return Probe(p, ctx)
8949def probes(ctx=None):
8950 """Return a list of all available probes in Z3.
8953 >>> l.count('memory') == 1
8957 return [Z3_get_probe_name(ctx.ref(), i) for i in range(Z3_get_num_probes(ctx.ref()))]
8960def probe_description(name, ctx=None):
8961 """Return a short description for the probe named `name`.
8963 >>> d = probe_description('memory')
8966 return Z3_probe_get_descr(ctx.ref(), name)
8969def describe_probes():
8970 """Display a (tabular) description of all available probes in Z3."""
8973 print('<table border="1" cellpadding="2" cellspacing="0">')
8976 print('<tr style="background-color:#CFCFCF">')
8981 print("<td>%s</td><td>%s</td></tr>" % (p, insert_line_breaks(probe_description(p), 40)))
8985 print("%s : %s" % (p, probe_description(p)))
8988def _probe_nary(f, args, ctx):
8990 _z3_assert(len(args) > 0, "At least one argument expected")
8992 r = _to_probe(args[0], ctx)
8993 for i in range(num - 1):
8994 r = Probe(f(ctx.ref(), r.probe, _to_probe(args[i + 1], ctx).probe), ctx)
8998def _probe_and(args, ctx):
8999 return _probe_nary(Z3_probe_and, args, ctx)
9002def _probe_or(args, ctx):
9003 return _probe_nary(Z3_probe_or, args, ctx)
9006def FailIf(p, ctx=None):
9007 """Return a tactic that fails if the probe `p` evaluates to true.
9008 Otherwise, it returns the input goal unmodified.
9010 In the following example, the tactic applies 'simplify' if and only if there are
9011 more than 2 constraints in the goal.
9013 >>> t = OrElse(FailIf(Probe('size') > 2), Tactic('simplify'))
9014 >>> x, y = Ints('x y')
9020 >>> g.add(x == y + 1)
9022 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9024 p = _to_probe(p, ctx)
9025 return Tactic(Z3_tactic_fail_if(p.ctx.ref(), p.probe), p.ctx)
9028def When(p, t, ctx=None):
9029 """Return a tactic that applies tactic `t` only if probe `p` evaluates to true.
9030 Otherwise, it returns the input goal unmodified.
9032 >>> t = When(Probe('size') > 2, Tactic('simplify'))
9033 >>> x, y = Ints('x y')
9039 >>> g.add(x == y + 1)
9041 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9043 p = _to_probe(p, ctx)
9044 t = _to_tactic(t, ctx)
9045 return Tactic(Z3_tactic_when(t.ctx.ref(), p.probe, t.tactic), t.ctx)
9048def Cond(p, t1, t2, ctx=None):
9049 """Return a tactic that applies tactic `t1` to a goal if probe `p` evaluates to true, and `t2` otherwise.
9051 >>> t = Cond(Probe('is-qfnra'), Tactic('qfnra'), Tactic('smt'))
9053 p = _to_probe(p, ctx)
9054 t1 = _to_tactic(t1, ctx)
9055 t2 = _to_tactic(t2, ctx)
9056 return Tactic(Z3_tactic_cond(t1.ctx.ref(), p.probe, t1.tactic, t2.tactic), t1.ctx)
9058#########################################
9062#########################################
9065def simplify(a, *arguments, **keywords):
9066 """Simplify the expression `a` using the given options.
9068 This function has many options. Use `help_simplify` to obtain the complete list.
9072 >>> simplify(x + 1 + y + x + 1)
9074 >>> simplify((x + 1)*(y + 1), som=True)
9076 >>> simplify(Distinct(x, y, 1), blast_distinct=True)
9077 And(Not(x == y), Not(x == 1), Not(y == 1))
9078 >>> simplify(And(x == 0, y == 1), elim_and=True)
9079 Not(Or(Not(x == 0), Not(y == 1)))
9082 _z3_assert(is_expr(a), "Z3 expression expected")
9083 if len(arguments) > 0 or len(keywords) > 0:
9084 p = args2params(arguments, keywords, a.ctx)
9085 return _to_expr_ref(Z3_simplify_ex(a.ctx_ref(), a.as_ast(), p.params), a.ctx)
9087 return _to_expr_ref(Z3_simplify(a.ctx_ref(), a.as_ast()), a.ctx)
9091 """Return a string describing all options available for Z3 `simplify` procedure."""
9092 print(Z3_simplify_get_help(main_ctx().ref()))
9095def simplify_param_descrs():
9096 """Return the set of parameter descriptions for Z3 `simplify` procedure."""
9097 return ParamDescrsRef(Z3_simplify_get_param_descrs(main_ctx().ref()), main_ctx())
9100def substitute(t, *m):
9101 """Apply substitution m on t, m is a list of pairs of the form (from, to).
9102 Every occurrence in t of from is replaced with to.
9106 >>> substitute(x + 1, (x, y + 1))
9108 >>> f = Function('f', IntSort(), IntSort())
9109 >>> substitute(f(x) + f(y), (f(x), IntVal(1)), (f(y), IntVal(1)))
9112 if isinstance(m, tuple):
9114 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9117 _z3_assert(is_expr(t), "Z3 expression expected")
9119 all([isinstance(p, tuple) and is_expr(p[0]) and is_expr(p[1]) for p in m]),
9120 "Z3 invalid substitution, expression pairs expected.")
9122 all([p[0].sort().eq(p[1].sort()) for p in m]),
9123 'Z3 invalid substitution, mismatching "from" and "to" sorts.')
9125 _from = (Ast * num)()
9127 for i in range(num):
9128 _from[i] = m[i][0].as_ast()
9129 _to[i] = m[i][1].as_ast()
9130 return _to_expr_ref(Z3_substitute(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9133def substitute_vars(t, *m):
9134 """Substitute the free variables in t with the expression in m.
9136 >>> v0 = Var(0, IntSort())
9137 >>> v1 = Var(1, IntSort())
9139 >>> f = Function('f', IntSort(), IntSort(), IntSort())
9140 >>> # replace v0 with x+1 and v1 with x
9141 >>> substitute_vars(f(v0, v1), x + 1, x)
9145 _z3_assert(is_expr(t), "Z3 expression expected")
9146 _z3_assert(all([is_expr(n) for n in m]), "Z3 invalid substitution, list of expressions expected.")
9149 for i in range(num):
9150 _to[i] = m[i].as_ast()
9151 return _to_expr_ref(Z3_substitute_vars(t.ctx.ref(), t.as_ast(), num, _to), t.ctx)
9153def substitute_funs(t, *m):
9154 """Apply substitution m on t, m is a list of pairs of a function and expression (from, to)
9155 Every occurrence in to of the function from is replaced with the expression to.
9156 The expression to can have free variables, that refer to the arguments of from.
9159 if isinstance(m, tuple):
9161 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9164 _z3_assert(is_expr(t), "Z3 expression expected")
9165 _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.")
9167 _from = (FuncDecl * num)()
9169 for i in range(num):
9170 _from[i] = m[i][0].as_func_decl()
9171 _to[i] = m[i][1].as_ast()
9172 return _to_expr_ref(Z3_substitute_funs(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9176 """Create the sum of the Z3 expressions.
9178 >>> a, b, c = Ints('a b c')
9183 >>> A = IntVector('a', 5)
9185 a__0 + a__1 + a__2 + a__3 + a__4
9187 args = _get_args(args)
9190 ctx = _ctx_from_ast_arg_list(args)
9192 return _reduce(lambda a, b: a + b, args, 0)
9193 args = _coerce_expr_list(args, ctx)
9195 return _reduce(lambda a, b: a + b, args, 0)
9197 _args, sz = _to_ast_array(args)
9198 return ArithRef(Z3_mk_add(ctx.ref(), sz, _args), ctx)
9202 """Create the product of the Z3 expressions.
9204 >>> a, b, c = Ints('a b c')
9205 >>> Product(a, b, c)
9207 >>> Product([a, b, c])
9209 >>> A = IntVector('a', 5)
9211 a__0*a__1*a__2*a__3*a__4
9213 args = _get_args(args)
9216 ctx = _ctx_from_ast_arg_list(args)
9218 return _reduce(lambda a, b: a * b, args, 1)
9219 args = _coerce_expr_list(args, ctx)
9221 return _reduce(lambda a, b: a * b, args, 1)
9223 _args, sz = _to_ast_array(args)
9224 return ArithRef(Z3_mk_mul(ctx.ref(), sz, _args), ctx)
9227 """Create the absolute value of an arithmetic expression"""
9228 return If(arg > 0, arg, -arg)
9232 """Create an at-most Pseudo-Boolean k constraint.
9234 >>> a, b, c = Bools('a b c')
9235 >>> f = AtMost(a, b, c, 2)
9237 args = _get_args(args)
9239 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9240 ctx = _ctx_from_ast_arg_list(args)
9242 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9243 args1 = _coerce_expr_list(args[:-1], ctx)
9245 _args, sz = _to_ast_array(args1)
9246 return BoolRef(Z3_mk_atmost(ctx.ref(), sz, _args, k), ctx)
9250 """Create an at-least Pseudo-Boolean k constraint.
9252 >>> a, b, c = Bools('a b c')
9253 >>> f = AtLeast(a, b, c, 2)
9255 args = _get_args(args)
9257 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9258 ctx = _ctx_from_ast_arg_list(args)
9260 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9261 args1 = _coerce_expr_list(args[:-1], ctx)
9263 _args, sz = _to_ast_array(args1)
9264 return BoolRef(Z3_mk_atleast(ctx.ref(), sz, _args, k), ctx)
9267def _reorder_pb_arg(arg):
9269 if not _is_int(b) and _is_int(a):
9274def _pb_args_coeffs(args, default_ctx=None):
9275 args = _get_args_ast_list(args)
9277 return _get_ctx(default_ctx), 0, (Ast * 0)(), (ctypes.c_int * 0)()
9278 args = [_reorder_pb_arg(arg) for arg in args]
9279 args, coeffs = zip(*args)
9281 _z3_assert(len(args) > 0, "Non empty list of arguments expected")
9282 ctx = _ctx_from_ast_arg_list(args)
9284 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9285 args = _coerce_expr_list(args, ctx)
9286 _args, sz = _to_ast_array(args)
9287 _coeffs = (ctypes.c_int * len(coeffs))()
9288 for i in range(len(coeffs)):
9289 _z3_check_cint_overflow(coeffs[i], "coefficient")
9290 _coeffs[i] = coeffs[i]
9291 return ctx, sz, _args, _coeffs, args
9295 """Create a Pseudo-Boolean inequality k constraint.
9297 >>> a, b, c = Bools('a b c')
9298 >>> f = PbLe(((a,1),(b,3),(c,2)), 3)
9300 _z3_check_cint_overflow(k, "k")
9301 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9302 return BoolRef(Z3_mk_pble(ctx.ref(), sz, _args, _coeffs, k), ctx)
9306 """Create a Pseudo-Boolean inequality k constraint.
9308 >>> a, b, c = Bools('a b c')
9309 >>> f = PbGe(((a,1),(b,3),(c,2)), 3)
9311 _z3_check_cint_overflow(k, "k")
9312 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9313 return BoolRef(Z3_mk_pbge(ctx.ref(), sz, _args, _coeffs, k), ctx)
9316def PbEq(args, k, ctx=None):
9317 """Create a Pseudo-Boolean equality k constraint.
9319 >>> a, b, c = Bools('a b c')
9320 >>> f = PbEq(((a,1),(b,3),(c,2)), 3)
9322 _z3_check_cint_overflow(k, "k")
9323 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9324 return BoolRef(Z3_mk_pbeq(ctx.ref(), sz, _args, _coeffs, k), ctx)
9327def solve(*args, **keywords):
9328 """Solve the constraints `*args`.
9330 This is a simple function for creating demonstrations. It creates a solver,
9331 configure it using the options in `keywords`, adds the constraints
9332 in `args`, and invokes check.
9335 >>> solve(a > 0, a < 2)
9338 show = keywords.pop("show", False)
9346 print("no solution")
9348 print("failed to solve")
9357def solve_using(s, *args, **keywords):
9358 """Solve the constraints `*args` using solver `s`.
9360 This is a simple function for creating demonstrations. It is similar to `solve`,
9361 but it uses the given solver `s`.
9362 It configures solver `s` using the options in `keywords`, adds the constraints
9363 in `args`, and invokes check.
9365 show = keywords.pop("show", False)
9367 _z3_assert(isinstance(s, Solver), "Solver object expected")
9375 print("no solution")
9377 print("failed to solve")
9388def prove(claim, show=False, **keywords):
9389 """Try to prove the given claim.
9391 This is a simple function for creating demonstrations. It tries to prove
9392 `claim` by showing the negation is unsatisfiable.
9394 >>> p, q = Bools('p q')
9395 >>> prove(Not(And(p, q)) == Or(Not(p), Not(q)))
9399 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9409 print("failed to prove")
9412 print("counterexample")
9416def _solve_html(*args, **keywords):
9417 """Version of function `solve` that renders HTML output."""
9418 show = keywords.pop("show", False)
9423 print("<b>Problem:</b>")
9427 print("<b>no solution</b>")
9429 print("<b>failed to solve</b>")
9436 print("<b>Solution:</b>")
9440def _solve_using_html(s, *args, **keywords):
9441 """Version of function `solve_using` that renders HTML."""
9442 show = keywords.pop("show", False)
9444 _z3_assert(isinstance(s, Solver), "Solver object expected")
9448 print("<b>Problem:</b>")
9452 print("<b>no solution</b>")
9454 print("<b>failed to solve</b>")
9461 print("<b>Solution:</b>")
9465def _prove_html(claim, show=False, **keywords):
9466 """Version of function `prove` that renders HTML."""
9468 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9476 print("<b>proved</b>")
9478 print("<b>failed to prove</b>")
9481 print("<b>counterexample</b>")
9485def _dict2sarray(sorts, ctx):
9487 _names = (Symbol * sz)()
9488 _sorts = (Sort * sz)()
9493 _z3_assert(isinstance(k, str), "String expected")
9494 _z3_assert(is_sort(v), "Z3 sort expected")
9495 _names[i] = to_symbol(k, ctx)
9498 return sz, _names, _sorts
9501def _dict2darray(decls, ctx):
9503 _names = (Symbol * sz)()
9504 _decls = (FuncDecl * sz)()
9509 _z3_assert(isinstance(k, str), "String expected")
9510 _z3_assert(is_func_decl(v) or is_const(v), "Z3 declaration or constant expected")
9511 _names[i] = to_symbol(k, ctx)
9513 _decls[i] = v.decl().ast
9517 return sz, _names, _decls
9520 def __init__(self, ctx= None):
9521 self.ctx = _get_ctx(ctx)
9522 self.pctx = Z3_mk_parser_context(self.ctx.ref())
9523 Z3_parser_context_inc_ref(self.ctx.ref(), self.pctx)
9526 if self.ctx.ref() is not None and self.pctx is not None and Z3_parser_context_dec_ref is not None:
9527 Z3_parser_context_dec_ref(self.ctx.ref(), self.pctx)
9530 def add_sort(self, sort):
9531 Z3_parser_context_add_sort(self.ctx.ref(), self.pctx, sort.as_ast())
9533 def add_decl(self, decl):
9534 Z3_parser_context_add_decl(self.ctx.ref(), self.pctx, decl.as_ast())
9536 def from_string(self, s):
9537 return AstVector(Z3_parser_context_from_string(self.ctx.ref(), self.pctx, s), self.ctx)
9539def parse_smt2_string(s, sorts={}, decls={}, ctx=None):
9540 """Parse a string in SMT 2.0 format using the given sorts and decls.
9542 The arguments sorts and decls are Python dictionaries used to initialize
9543 the symbol table used for the SMT 2.0 parser.
9545 >>> parse_smt2_string('(declare-const x Int) (assert (> x 0)) (assert (< x 10))')
9547 >>> x, y = Ints('x y')
9548 >>> f = Function('f', IntSort(), IntSort())
9549 >>> parse_smt2_string('(assert (> (+ foo (g bar)) 0))', decls={ 'foo' : x, 'bar' : y, 'g' : f})
9551 >>> parse_smt2_string('(declare-const a U) (assert (> a 0))', sorts={ 'U' : IntSort() })
9555 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9556 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9557 return AstVector(Z3_parse_smtlib2_string(ctx.ref(), s, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9560def parse_smt2_file(f, sorts={}, decls={}, ctx=None):
9561 """Parse a file in SMT 2.0 format using the given sorts and decls.
9563 This function is similar to parse_smt2_string().
9566 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9567 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9568 return AstVector(Z3_parse_smtlib2_file(ctx.ref(), f, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9571#########################################
9573# Floating-Point Arithmetic
9575#########################################
9578# Global default rounding mode
9579_dflt_rounding_mode = Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN
9580_dflt_fpsort_ebits = 11
9581_dflt_fpsort_sbits = 53
9584def get_default_rounding_mode(ctx=None):
9585 """Retrieves the global default rounding mode."""
9586 global _dflt_rounding_mode
9587 if _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_ZERO:
9589 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_NEGATIVE:
9591 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_POSITIVE:
9593 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN:
9595 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY:
9599_ROUNDING_MODES = frozenset({
9600 Z3_OP_FPA_RM_TOWARD_ZERO,
9601 Z3_OP_FPA_RM_TOWARD_NEGATIVE,
9602 Z3_OP_FPA_RM_TOWARD_POSITIVE,
9603 Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN,
9604 Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY
9608def set_default_rounding_mode(rm, ctx=None):
9609 global _dflt_rounding_mode
9610 if is_fprm_value(rm):
9611 _dflt_rounding_mode = rm.kind()
9613 _z3_assert(_dflt_rounding_mode in _ROUNDING_MODES, "illegal rounding mode")
9614 _dflt_rounding_mode = rm
9617def get_default_fp_sort(ctx=None):
9618 return FPSort(_dflt_fpsort_ebits, _dflt_fpsort_sbits, ctx)
9621def set_default_fp_sort(ebits, sbits, ctx=None):
9622 global _dflt_fpsort_ebits
9623 global _dflt_fpsort_sbits
9624 _dflt_fpsort_ebits = ebits
9625 _dflt_fpsort_sbits = sbits
9628def _dflt_rm(ctx=None):
9629 return get_default_rounding_mode(ctx)
9632def _dflt_fps(ctx=None):
9633 return get_default_fp_sort(ctx)
9636def _coerce_fp_expr_list(alist, ctx):
9637 first_fp_sort = None
9640 if first_fp_sort is None:
9641 first_fp_sort = a.sort()
9642 elif first_fp_sort == a.sort():
9643 pass # OK, same as before
9645 # we saw at least 2 different float sorts; something will
9646 # throw a sort mismatch later, for now assume None.
9647 first_fp_sort = None
9651 for i in range(len(alist)):
9653 is_repr = isinstance(a, str) and a.contains("2**(") and a.endswith(")")
9654 if is_repr or _is_int(a) or isinstance(a, (float, bool)):
9655 r.append(FPVal(a, None, first_fp_sort, ctx))
9658 return _coerce_expr_list(r, ctx)
9663class FPSortRef(SortRef):
9664 """Floating-point sort."""
9667 """Retrieves the number of bits reserved for the exponent in the FloatingPoint sort `self`.
9668 >>> b = FPSort(8, 24)
9672 return int(Z3_fpa_get_ebits(self.ctx_ref(), self.ast))
9675 """Retrieves the number of bits reserved for the significand in the FloatingPoint sort `self`.
9676 >>> b = FPSort(8, 24)
9680 return int(Z3_fpa_get_sbits(self.ctx_ref(), self.ast))
9682 def cast(self, val):
9683 """Try to cast `val` as a floating-point expression.
9684 >>> b = FPSort(8, 24)
9687 >>> b.cast(1.0).sexpr()
9688 '(fp #b0 #x7f #b00000000000000000000000)'
9692 _z3_assert(self.ctx == val.ctx, "Context mismatch")
9695 return FPVal(val, None, self, self.ctx)
9698def Float16(ctx=None):
9699 """Floating-point 16-bit (half) sort."""
9701 return FPSortRef(Z3_mk_fpa_sort_16(ctx.ref()), ctx)
9704def FloatHalf(ctx=None):
9705 """Floating-point 16-bit (half) sort."""
9707 return FPSortRef(Z3_mk_fpa_sort_half(ctx.ref()), ctx)
9710def Float32(ctx=None):
9711 """Floating-point 32-bit (single) sort."""
9713 return FPSortRef(Z3_mk_fpa_sort_32(ctx.ref()), ctx)
9716def FloatSingle(ctx=None):
9717 """Floating-point 32-bit (single) sort."""
9719 return FPSortRef(Z3_mk_fpa_sort_single(ctx.ref()), ctx)
9722def Float64(ctx=None):
9723 """Floating-point 64-bit (double) sort."""
9725 return FPSortRef(Z3_mk_fpa_sort_64(ctx.ref()), ctx)
9728def FloatDouble(ctx=None):
9729 """Floating-point 64-bit (double) sort."""
9731 return FPSortRef(Z3_mk_fpa_sort_double(ctx.ref()), ctx)
9734def Float128(ctx=None):
9735 """Floating-point 128-bit (quadruple) sort."""
9737 return FPSortRef(Z3_mk_fpa_sort_128(ctx.ref()), ctx)
9740def FloatQuadruple(ctx=None):
9741 """Floating-point 128-bit (quadruple) sort."""
9743 return FPSortRef(Z3_mk_fpa_sort_quadruple(ctx.ref()), ctx)
9746class FPRMSortRef(SortRef):
9747 """"Floating-point rounding mode sort."""
9751 """Return True if `s` is a Z3 floating-point sort.
9753 >>> is_fp_sort(FPSort(8, 24))
9755 >>> is_fp_sort(IntSort())
9758 return isinstance(s, FPSortRef)
9762 """Return True if `s` is a Z3 floating-point rounding mode sort.
9764 >>> is_fprm_sort(FPSort(8, 24))
9766 >>> is_fprm_sort(RNE().sort())
9769 return isinstance(s, FPRMSortRef)
9774class FPRef(ExprRef):
9775 """Floating-point expressions."""
9778 """Return the sort of the floating-point expression `self`.
9780 >>> x = FP('1.0', FPSort(8, 24))
9783 >>> x.sort() == FPSort(8, 24)
9786 return FPSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
9789 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9790 >>> b = FPSort(8, 24)
9794 return self.sort().ebits()
9797 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9798 >>> b = FPSort(8, 24)
9802 return self.sort().sbits()
9804 def as_string(self):
9805 """Return a Z3 floating point expression as a Python string."""
9806 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
9808 def __le__(self, other):
9809 return fpLEQ(self, other, self.ctx)
9811 def __lt__(self, other):
9812 return fpLT(self, other, self.ctx)
9814 def __ge__(self, other):
9815 return fpGEQ(self, other, self.ctx)
9817 def __gt__(self, other):
9818 return fpGT(self, other, self.ctx)
9820 def __add__(self, other):
9821 """Create the Z3 expression `self + other`.
9823 >>> x = FP('x', FPSort(8, 24))
9824 >>> y = FP('y', FPSort(8, 24))
9830 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9831 return fpAdd(_dflt_rm(), a, b, self.ctx)
9833 def __radd__(self, other):
9834 """Create the Z3 expression `other + self`.
9836 >>> x = FP('x', FPSort(8, 24))
9840 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9841 return fpAdd(_dflt_rm(), a, b, self.ctx)
9843 def __sub__(self, other):
9844 """Create the Z3 expression `self - other`.
9846 >>> x = FP('x', FPSort(8, 24))
9847 >>> y = FP('y', FPSort(8, 24))
9853 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9854 return fpSub(_dflt_rm(), a, b, self.ctx)
9856 def __rsub__(self, other):
9857 """Create the Z3 expression `other - self`.
9859 >>> x = FP('x', FPSort(8, 24))
9863 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9864 return fpSub(_dflt_rm(), a, b, self.ctx)
9866 def __mul__(self, other):
9867 """Create the Z3 expression `self * other`.
9869 >>> x = FP('x', FPSort(8, 24))
9870 >>> y = FP('y', FPSort(8, 24))
9878 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9879 return fpMul(_dflt_rm(), a, b, self.ctx)
9881 def __rmul__(self, other):
9882 """Create the Z3 expression `other * self`.
9884 >>> x = FP('x', FPSort(8, 24))
9885 >>> y = FP('y', FPSort(8, 24))
9891 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9892 return fpMul(_dflt_rm(), a, b, self.ctx)
9895 """Create the Z3 expression `+self`."""
9899 """Create the Z3 expression `-self`.
9901 >>> x = FP('x', Float32())
9907 def __div__(self, other):
9908 """Create the Z3 expression `self / other`.
9910 >>> x = FP('x', FPSort(8, 24))
9911 >>> y = FP('y', FPSort(8, 24))
9919 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9920 return fpDiv(_dflt_rm(), a, b, self.ctx)
9922 def __rdiv__(self, other):
9923 """Create the Z3 expression `other / self`.
9925 >>> x = FP('x', FPSort(8, 24))
9926 >>> y = FP('y', FPSort(8, 24))
9932 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9933 return fpDiv(_dflt_rm(), a, b, self.ctx)
9935 def __truediv__(self, other):
9936 """Create the Z3 expression division `self / other`."""
9937 return self.__div__(other)
9939 def __rtruediv__(self, other):
9940 """Create the Z3 expression division `other / self`."""
9941 return self.__rdiv__(other)
9943 def __mod__(self, other):
9944 """Create the Z3 expression mod `self % other`."""
9945 return fpRem(self, other)
9947 def __rmod__(self, other):
9948 """Create the Z3 expression mod `other % self`."""
9949 return fpRem(other, self)
9952class FPRMRef(ExprRef):
9953 """Floating-point rounding mode expressions"""
9955 def as_string(self):
9956 """Return a Z3 floating point expression as a Python string."""
9957 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
9960def RoundNearestTiesToEven(ctx=None):
9962 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
9967 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
9970def RoundNearestTiesToAway(ctx=None):
9972 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
9977 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
9980def RoundTowardPositive(ctx=None):
9982 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
9987 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
9990def RoundTowardNegative(ctx=None):
9992 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
9997 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
10000def RoundTowardZero(ctx=None):
10001 ctx = _get_ctx(ctx)
10002 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
10006 ctx = _get_ctx(ctx)
10007 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
10011 """Return `True` if `a` is a Z3 floating-point rounding mode expression.
10020 return isinstance(a, FPRMRef)
10023def is_fprm_value(a):
10024 """Return `True` if `a` is a Z3 floating-point rounding mode numeral value."""
10025 return is_fprm(a) and _is_numeral(a.ctx, a.ast)
10030class FPNumRef(FPRef):
10031 """The sign of the numeral.
10033 >>> x = FPVal(+1.0, FPSort(8, 24))
10036 >>> x = FPVal(-1.0, FPSort(8, 24))
10042 num = (ctypes.c_int)()
10043 nsign = Z3_fpa_get_numeral_sign(self.ctx.ref(), self.as_ast(), byref(num))
10045 raise Z3Exception("error retrieving the sign of a numeral.")
10046 return num.value != 0
10048 """The sign of a floating-point numeral as a bit-vector expression.
10050 Remark: NaN's are invalid arguments.
10053 def sign_as_bv(self):
10054 return BitVecNumRef(Z3_fpa_get_numeral_sign_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10056 """The significand of the numeral.
10058 >>> x = FPVal(2.5, FPSort(8, 24))
10059 >>> x.significand()
10063 def significand(self):
10064 return Z3_fpa_get_numeral_significand_string(self.ctx.ref(), self.as_ast())
10066 """The significand of the numeral as a long.
10068 >>> x = FPVal(2.5, FPSort(8, 24))
10069 >>> x.significand_as_long()
10073 def significand_as_long(self):
10074 ptr = (ctypes.c_ulonglong * 1)()
10075 if not Z3_fpa_get_numeral_significand_uint64(self.ctx.ref(), self.as_ast(), ptr):
10076 raise Z3Exception("error retrieving the significand of a numeral.")
10079 """The significand of the numeral as a bit-vector expression.
10081 Remark: NaN are invalid arguments.
10084 def significand_as_bv(self):
10085 return BitVecNumRef(Z3_fpa_get_numeral_significand_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10087 """The exponent of the numeral.
10089 >>> x = FPVal(2.5, FPSort(8, 24))
10094 def exponent(self, biased=True):
10095 return Z3_fpa_get_numeral_exponent_string(self.ctx.ref(), self.as_ast(), biased)
10097 """The exponent of the numeral as a long.
10099 >>> x = FPVal(2.5, FPSort(8, 24))
10100 >>> x.exponent_as_long()
10104 def exponent_as_long(self, biased=True):
10105 ptr = (ctypes.c_longlong * 1)()
10106 if not Z3_fpa_get_numeral_exponent_int64(self.ctx.ref(), self.as_ast(), ptr, biased):
10107 raise Z3Exception("error retrieving the exponent of a numeral.")
10110 """The exponent of the numeral as a bit-vector expression.
10112 Remark: NaNs are invalid arguments.
10115 def exponent_as_bv(self, biased=True):
10116 return BitVecNumRef(Z3_fpa_get_numeral_exponent_bv(self.ctx.ref(), self.as_ast(), biased), self.ctx)
10118 """Indicates whether the numeral is a NaN."""
10121 return Z3_fpa_is_numeral_nan(self.ctx.ref(), self.as_ast())
10123 """Indicates whether the numeral is +oo or -oo."""
10126 return Z3_fpa_is_numeral_inf(self.ctx.ref(), self.as_ast())
10128 """Indicates whether the numeral is +zero or -zero."""
10131 return Z3_fpa_is_numeral_zero(self.ctx.ref(), self.as_ast())
10133 """Indicates whether the numeral is normal."""
10135 def isNormal(self):
10136 return Z3_fpa_is_numeral_normal(self.ctx.ref(), self.as_ast())
10138 """Indicates whether the numeral is subnormal."""
10140 def isSubnormal(self):
10141 return Z3_fpa_is_numeral_subnormal(self.ctx.ref(), self.as_ast())
10143 """Indicates whether the numeral is positive."""
10145 def isPositive(self):
10146 return Z3_fpa_is_numeral_positive(self.ctx.ref(), self.as_ast())
10148 """Indicates whether the numeral is negative."""
10150 def isNegative(self):
10151 return Z3_fpa_is_numeral_negative(self.ctx.ref(), self.as_ast())
10154 The string representation of the numeral.
10156 >>> x = FPVal(20, FPSort(8, 24))
10161 def as_string(self):
10162 s = Z3_get_numeral_string(self.ctx.ref(), self.as_ast())
10163 return ("FPVal(%s, %s)" % (s, self.sort()))
10165 def py_value(self):
10166 bv = simplify(fpToIEEEBV(self))
10167 binary = bv.py_value()
10168 if not isinstance(binary, int):
10170 # Decode the IEEE 754 binary representation
10172 bytes_rep = binary.to_bytes(8, byteorder='big')
10173 return struct.unpack('>d', bytes_rep)[0]
10177 """Return `True` if `a` is a Z3 floating-point expression.
10179 >>> b = FP('b', FPSort(8, 24))
10184 >>> is_fp(Int('x'))
10187 return isinstance(a, FPRef)
10191 """Return `True` if `a` is a Z3 floating-point numeral value.
10193 >>> b = FP('b', FPSort(8, 24))
10196 >>> b = FPVal(1.0, FPSort(8, 24))
10202 return is_fp(a) and _is_numeral(a.ctx, a.ast)
10205def FPSort(ebits, sbits, ctx=None):
10206 """Return a Z3 floating-point sort of the given sizes. If `ctx=None`, then the global context is used.
10208 >>> Single = FPSort(8, 24)
10209 >>> Double = FPSort(11, 53)
10212 >>> x = Const('x', Single)
10213 >>> eq(x, FP('x', FPSort(8, 24)))
10216 ctx = _get_ctx(ctx)
10217 return FPSortRef(Z3_mk_fpa_sort(ctx.ref(), ebits, sbits), ctx)
10220def _to_float_str(val, exp=0):
10221 if isinstance(val, float):
10222 if math.isnan(val):
10225 sone = math.copysign(1.0, val)
10230 elif val == float("+inf"):
10232 elif val == float("-inf"):
10235 v = val.as_integer_ratio()
10238 rvs = str(num) + "/" + str(den)
10239 res = rvs + "p" + _to_int_str(exp)
10240 elif isinstance(val, bool):
10247 elif isinstance(val, str):
10248 inx = val.find("*(2**")
10251 elif val[-1] == ")":
10253 exp = str(int(val[inx + 5:-1]) + int(exp))
10255 _z3_assert(False, "String does not have floating-point numeral form.")
10257 _z3_assert(False, "Python value cannot be used to create floating-point numerals.")
10261 return res + "p" + exp
10265 """Create a Z3 floating-point NaN term.
10267 >>> s = FPSort(8, 24)
10268 >>> set_fpa_pretty(True)
10271 >>> pb = get_fpa_pretty()
10272 >>> set_fpa_pretty(False)
10274 fpNaN(FPSort(8, 24))
10275 >>> set_fpa_pretty(pb)
10277 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10278 return FPNumRef(Z3_mk_fpa_nan(s.ctx_ref(), s.ast), s.ctx)
10281def fpPlusInfinity(s):
10282 """Create a Z3 floating-point +oo term.
10284 >>> s = FPSort(8, 24)
10285 >>> pb = get_fpa_pretty()
10286 >>> set_fpa_pretty(True)
10287 >>> fpPlusInfinity(s)
10289 >>> set_fpa_pretty(False)
10290 >>> fpPlusInfinity(s)
10291 fpPlusInfinity(FPSort(8, 24))
10292 >>> set_fpa_pretty(pb)
10294 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10295 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, False), s.ctx)
10298def fpMinusInfinity(s):
10299 """Create a Z3 floating-point -oo term."""
10300 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10301 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, True), s.ctx)
10304def fpInfinity(s, negative):
10305 """Create a Z3 floating-point +oo or -oo term."""
10306 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10307 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10308 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, negative), s.ctx)
10312 """Create a Z3 floating-point +0.0 term."""
10313 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10314 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, False), s.ctx)
10318 """Create a Z3 floating-point -0.0 term."""
10319 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10320 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, True), s.ctx)
10323def fpZero(s, negative):
10324 """Create a Z3 floating-point +0.0 or -0.0 term."""
10325 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10326 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10327 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, negative), s.ctx)
10330def FPVal(sig, exp=None, fps=None, ctx=None):
10331 """Return a floating-point value of value `val` and sort `fps`.
10332 If `ctx=None`, then the global context is used.
10334 >>> v = FPVal(20.0, FPSort(8, 24))
10337 >>> print("0x%.8x" % v.exponent_as_long(False))
10339 >>> v = FPVal(2.25, FPSort(8, 24))
10342 >>> v = FPVal(-2.25, FPSort(8, 24))
10345 >>> FPVal(-0.0, FPSort(8, 24))
10347 >>> FPVal(0.0, FPSort(8, 24))
10349 >>> FPVal(+0.0, FPSort(8, 24))
10352 ctx = _get_ctx(ctx)
10353 if is_fp_sort(exp):
10357 fps = _dflt_fps(ctx)
10358 _z3_assert(is_fp_sort(fps), "sort mismatch")
10361 val = _to_float_str(sig)
10362 if val == "NaN" or val == "nan":
10364 elif val == "-0.0":
10365 return fpMinusZero(fps)
10366 elif val == "0.0" or val == "+0.0":
10367 return fpPlusZero(fps)
10368 elif val == "+oo" or val == "+inf" or val == "+Inf":
10369 return fpPlusInfinity(fps)
10370 elif val == "-oo" or val == "-inf" or val == "-Inf":
10371 return fpMinusInfinity(fps)
10373 return FPNumRef(Z3_mk_numeral(ctx.ref(), val, fps.ast), ctx)
10376def FP(name, fpsort, ctx=None):
10377 """Return a floating-point constant named `name`.
10378 `fpsort` is the floating-point sort.
10379 If `ctx=None`, then the global context is used.
10381 >>> x = FP('x', FPSort(8, 24))
10388 >>> word = FPSort(8, 24)
10389 >>> x2 = FP('x', word)
10393 if isinstance(fpsort, FPSortRef) and ctx is None:
10396 ctx = _get_ctx(ctx)
10397 return FPRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), fpsort.ast), ctx)
10400def FPs(names, fpsort, ctx=None):
10401 """Return an array of floating-point constants.
10403 >>> x, y, z = FPs('x y z', FPSort(8, 24))
10410 >>> fpMul(RNE(), fpAdd(RNE(), x, y), z)
10413 ctx = _get_ctx(ctx)
10414 if isinstance(names, str):
10415 names = names.split(" ")
10416 return [FP(name, fpsort, ctx) for name in names]
10419def fpAbs(a, ctx=None):
10420 """Create a Z3 floating-point absolute value expression.
10422 >>> s = FPSort(8, 24)
10424 >>> x = FPVal(1.0, s)
10427 >>> y = FPVal(-20.0, s)
10431 fpAbs(-1.25*(2**4))
10432 >>> fpAbs(-1.25*(2**4))
10433 fpAbs(-1.25*(2**4))
10434 >>> fpAbs(x).sort()
10437 ctx = _get_ctx(ctx)
10438 [a] = _coerce_fp_expr_list([a], ctx)
10439 return FPRef(Z3_mk_fpa_abs(ctx.ref(), a.as_ast()), ctx)
10442def fpNeg(a, ctx=None):
10443 """Create a Z3 floating-point addition expression.
10445 >>> s = FPSort(8, 24)
10450 >>> fpNeg(x).sort()
10453 ctx = _get_ctx(ctx)
10454 [a] = _coerce_fp_expr_list([a], ctx)
10455 return FPRef(Z3_mk_fpa_neg(ctx.ref(), a.as_ast()), ctx)
10458def _mk_fp_unary(f, rm, a, ctx):
10459 ctx = _get_ctx(ctx)
10460 [a] = _coerce_fp_expr_list([a], ctx)
10462 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10463 _z3_assert(is_fp(a), "Second argument must be a Z3 floating-point expression")
10464 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast()), ctx)
10467def _mk_fp_unary_pred(f, a, ctx):
10468 ctx = _get_ctx(ctx)
10469 [a] = _coerce_fp_expr_list([a], ctx)
10471 _z3_assert(is_fp(a), "First argument must be a Z3 floating-point expression")
10472 return BoolRef(f(ctx.ref(), a.as_ast()), ctx)
10475def _mk_fp_bin(f, rm, a, b, ctx):
10476 ctx = _get_ctx(ctx)
10477 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10479 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10480 _z3_assert(is_fp(a) or is_fp(b), "Second or third argument must be a Z3 floating-point expression")
10481 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast()), ctx)
10484def _mk_fp_bin_norm(f, a, b, ctx):
10485 ctx = _get_ctx(ctx)
10486 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10488 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10489 return FPRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10492def _mk_fp_bin_pred(f, a, b, ctx):
10493 ctx = _get_ctx(ctx)
10494 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10496 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10497 return BoolRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10500def _mk_fp_tern(f, rm, a, b, c, ctx):
10501 ctx = _get_ctx(ctx)
10502 [a, b, c] = _coerce_fp_expr_list([a, b, c], ctx)
10504 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10505 _z3_assert(is_fp(a) or is_fp(b) or is_fp(
10506 c), "Second, third or fourth argument must be a Z3 floating-point expression")
10507 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast(), c.as_ast()), ctx)
10510def fpAdd(rm, a, b, ctx=None):
10511 """Create a Z3 floating-point addition expression.
10513 >>> s = FPSort(8, 24)
10517 >>> fpAdd(rm, x, y)
10519 >>> fpAdd(RTZ(), x, y) # default rounding mode is RTZ
10521 >>> fpAdd(rm, x, y).sort()
10524 return _mk_fp_bin(Z3_mk_fpa_add, rm, a, b, ctx)
10527def fpSub(rm, a, b, ctx=None):
10528 """Create a Z3 floating-point subtraction expression.
10530 >>> s = FPSort(8, 24)
10534 >>> fpSub(rm, x, y)
10536 >>> fpSub(rm, x, y).sort()
10539 return _mk_fp_bin(Z3_mk_fpa_sub, rm, a, b, ctx)
10542def fpMul(rm, a, b, ctx=None):
10543 """Create a Z3 floating-point multiplication expression.
10545 >>> s = FPSort(8, 24)
10549 >>> fpMul(rm, x, y)
10551 >>> fpMul(rm, x, y).sort()
10554 return _mk_fp_bin(Z3_mk_fpa_mul, rm, a, b, ctx)
10557def fpDiv(rm, a, b, ctx=None):
10558 """Create a Z3 floating-point division expression.
10560 >>> s = FPSort(8, 24)
10564 >>> fpDiv(rm, x, y)
10566 >>> fpDiv(rm, x, y).sort()
10569 return _mk_fp_bin(Z3_mk_fpa_div, rm, a, b, ctx)
10572def fpRem(a, b, ctx=None):
10573 """Create a Z3 floating-point remainder expression.
10575 >>> s = FPSort(8, 24)
10580 >>> fpRem(x, y).sort()
10583 return _mk_fp_bin_norm(Z3_mk_fpa_rem, a, b, ctx)
10586def fpMin(a, b, ctx=None):
10587 """Create a Z3 floating-point minimum expression.
10589 >>> s = FPSort(8, 24)
10595 >>> fpMin(x, y).sort()
10598 return _mk_fp_bin_norm(Z3_mk_fpa_min, a, b, ctx)
10601def fpMax(a, b, ctx=None):
10602 """Create a Z3 floating-point maximum expression.
10604 >>> s = FPSort(8, 24)
10610 >>> fpMax(x, y).sort()
10613 return _mk_fp_bin_norm(Z3_mk_fpa_max, a, b, ctx)
10616def fpFMA(rm, a, b, c, ctx=None):
10617 """Create a Z3 floating-point fused multiply-add expression.
10619 return _mk_fp_tern(Z3_mk_fpa_fma, rm, a, b, c, ctx)
10622def fpSqrt(rm, a, ctx=None):
10623 """Create a Z3 floating-point square root expression.
10625 return _mk_fp_unary(Z3_mk_fpa_sqrt, rm, a, ctx)
10628def fpRoundToIntegral(rm, a, ctx=None):
10629 """Create a Z3 floating-point roundToIntegral expression.
10631 return _mk_fp_unary(Z3_mk_fpa_round_to_integral, rm, a, ctx)
10634def fpIsNaN(a, ctx=None):
10635 """Create a Z3 floating-point isNaN expression.
10637 >>> s = FPSort(8, 24)
10643 return _mk_fp_unary_pred(Z3_mk_fpa_is_nan, a, ctx)
10646def fpIsInf(a, ctx=None):
10647 """Create a Z3 floating-point isInfinite expression.
10649 >>> s = FPSort(8, 24)
10654 return _mk_fp_unary_pred(Z3_mk_fpa_is_infinite, a, ctx)
10657def fpIsZero(a, ctx=None):
10658 """Create a Z3 floating-point isZero expression.
10660 return _mk_fp_unary_pred(Z3_mk_fpa_is_zero, a, ctx)
10663def fpIsNormal(a, ctx=None):
10664 """Create a Z3 floating-point isNormal expression.
10666 return _mk_fp_unary_pred(Z3_mk_fpa_is_normal, a, ctx)
10669def fpIsSubnormal(a, ctx=None):
10670 """Create a Z3 floating-point isSubnormal expression.
10672 return _mk_fp_unary_pred(Z3_mk_fpa_is_subnormal, a, ctx)
10675def fpIsNegative(a, ctx=None):
10676 """Create a Z3 floating-point isNegative expression.
10678 return _mk_fp_unary_pred(Z3_mk_fpa_is_negative, a, ctx)
10681def fpIsPositive(a, ctx=None):
10682 """Create a Z3 floating-point isPositive expression.
10684 return _mk_fp_unary_pred(Z3_mk_fpa_is_positive, a, ctx)
10687def _check_fp_args(a, b):
10689 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10692def fpLT(a, b, ctx=None):
10693 """Create the Z3 floating-point expression `other < self`.
10695 >>> x, y = FPs('x y', FPSort(8, 24))
10698 >>> (x < y).sexpr()
10701 return _mk_fp_bin_pred(Z3_mk_fpa_lt, a, b, ctx)
10704def fpLEQ(a, b, ctx=None):
10705 """Create the Z3 floating-point expression `other <= self`.
10707 >>> x, y = FPs('x y', FPSort(8, 24))
10710 >>> (x <= y).sexpr()
10713 return _mk_fp_bin_pred(Z3_mk_fpa_leq, a, b, ctx)
10716def fpGT(a, b, ctx=None):
10717 """Create the Z3 floating-point expression `other > self`.
10719 >>> x, y = FPs('x y', FPSort(8, 24))
10722 >>> (x > y).sexpr()
10725 return _mk_fp_bin_pred(Z3_mk_fpa_gt, a, b, ctx)
10728def fpGEQ(a, b, ctx=None):
10729 """Create the Z3 floating-point expression `other >= self`.
10731 >>> x, y = FPs('x y', FPSort(8, 24))
10734 >>> (x >= y).sexpr()
10737 return _mk_fp_bin_pred(Z3_mk_fpa_geq, a, b, ctx)
10740def fpEQ(a, b, ctx=None):
10741 """Create the Z3 floating-point expression `fpEQ(other, self)`.
10743 >>> x, y = FPs('x y', FPSort(8, 24))
10746 >>> fpEQ(x, y).sexpr()
10749 return _mk_fp_bin_pred(Z3_mk_fpa_eq, a, b, ctx)
10752def fpNEQ(a, b, ctx=None):
10753 """Create the Z3 floating-point expression `Not(fpEQ(other, self))`.
10755 >>> x, y = FPs('x y', FPSort(8, 24))
10758 >>> (x != y).sexpr()
10761 return Not(fpEQ(a, b, ctx))
10764def fpFP(sgn, exp, sig, ctx=None):
10765 """Create the Z3 floating-point value `fpFP(sgn, sig, exp)` from the three bit-vectors sgn, sig, and exp.
10767 >>> s = FPSort(8, 24)
10768 >>> x = fpFP(BitVecVal(1, 1), BitVecVal(2**7-1, 8), BitVecVal(2**22, 23))
10770 fpFP(1, 127, 4194304)
10771 >>> xv = FPVal(-1.5, s)
10774 >>> slvr = Solver()
10775 >>> slvr.add(fpEQ(x, xv))
10778 >>> xv = FPVal(+1.5, s)
10781 >>> slvr = Solver()
10782 >>> slvr.add(fpEQ(x, xv))
10786 _z3_assert(is_bv(sgn) and is_bv(exp) and is_bv(sig), "sort mismatch")
10787 _z3_assert(sgn.sort().size() == 1, "sort mismatch")
10788 ctx = _get_ctx(ctx)
10789 _z3_assert(ctx == sgn.ctx == exp.ctx == sig.ctx, "context mismatch")
10790 return FPRef(Z3_mk_fpa_fp(ctx.ref(), sgn.ast, exp.ast, sig.ast), ctx)
10793def fpToFP(a1, a2=None, a3=None, ctx=None):
10794 """Create a Z3 floating-point conversion expression from other term sorts
10797 From a bit-vector term in IEEE 754-2008 format:
10798 >>> x = FPVal(1.0, Float32())
10799 >>> x_bv = fpToIEEEBV(x)
10800 >>> simplify(fpToFP(x_bv, Float32()))
10803 From a floating-point term with different precision:
10804 >>> x = FPVal(1.0, Float32())
10805 >>> x_db = fpToFP(RNE(), x, Float64())
10810 >>> x_r = RealVal(1.5)
10811 >>> simplify(fpToFP(RNE(), x_r, Float32()))
10814 From a signed bit-vector term:
10815 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10816 >>> simplify(fpToFP(RNE(), x_signed, Float32()))
10819 ctx = _get_ctx(ctx)
10820 if is_bv(a1) and is_fp_sort(a2):
10821 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), a1.ast, a2.ast), ctx)
10822 elif is_fprm(a1) and is_fp(a2) and is_fp_sort(a3):
10823 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10824 elif is_fprm(a1) and is_real(a2) and is_fp_sort(a3):
10825 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10826 elif is_fprm(a1) and is_bv(a2) and is_fp_sort(a3):
10827 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10829 raise Z3Exception("Unsupported combination of arguments for conversion to floating-point term.")
10832def fpBVToFP(v, sort, ctx=None):
10833 """Create a Z3 floating-point conversion expression that represents the
10834 conversion from a bit-vector term to a floating-point term.
10836 >>> x_bv = BitVecVal(0x3F800000, 32)
10837 >>> x_fp = fpBVToFP(x_bv, Float32())
10843 _z3_assert(is_bv(v), "First argument must be a Z3 bit-vector expression")
10844 _z3_assert(is_fp_sort(sort), "Second argument must be a Z3 floating-point sort.")
10845 ctx = _get_ctx(ctx)
10846 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), v.ast, sort.ast), ctx)
10849def fpFPToFP(rm, v, sort, ctx=None):
10850 """Create a Z3 floating-point conversion expression that represents the
10851 conversion from a floating-point term to a floating-point term of different precision.
10853 >>> x_sgl = FPVal(1.0, Float32())
10854 >>> x_dbl = fpFPToFP(RNE(), x_sgl, Float64())
10857 >>> simplify(x_dbl)
10862 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10863 _z3_assert(is_fp(v), "Second argument must be a Z3 floating-point expression.")
10864 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10865 ctx = _get_ctx(ctx)
10866 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10869def fpRealToFP(rm, v, sort, ctx=None):
10870 """Create a Z3 floating-point conversion expression that represents the
10871 conversion from a real term to a floating-point term.
10873 >>> x_r = RealVal(1.5)
10874 >>> x_fp = fpRealToFP(RNE(), x_r, Float32())
10880 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10881 _z3_assert(is_real(v), "Second argument must be a Z3 expression or real sort.")
10882 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10883 ctx = _get_ctx(ctx)
10884 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10887def fpSignedToFP(rm, v, sort, ctx=None):
10888 """Create a Z3 floating-point conversion expression that represents the
10889 conversion from a signed bit-vector term (encoding an integer) to a floating-point term.
10891 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10892 >>> x_fp = fpSignedToFP(RNE(), x_signed, Float32())
10894 fpToFP(RNE(), 4294967291)
10898 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10899 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
10900 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10901 ctx = _get_ctx(ctx)
10902 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10905def fpUnsignedToFP(rm, v, sort, ctx=None):
10906 """Create a Z3 floating-point conversion expression that represents the
10907 conversion from an unsigned bit-vector term (encoding an integer) to a floating-point term.
10909 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10910 >>> x_fp = fpUnsignedToFP(RNE(), x_signed, Float32())
10912 fpToFPUnsigned(RNE(), 4294967291)
10916 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10917 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
10918 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10919 ctx = _get_ctx(ctx)
10920 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10923def fpToFPUnsigned(rm, x, s, ctx=None):
10924 """Create a Z3 floating-point conversion expression, from unsigned bit-vector to floating-point expression."""
10926 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10927 _z3_assert(is_bv(x), "Second argument must be a Z3 bit-vector expression")
10928 _z3_assert(is_fp_sort(s), "Third argument must be Z3 floating-point sort")
10929 ctx = _get_ctx(ctx)
10930 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, x.ast, s.ast), ctx)
10933def fpToSBV(rm, x, s, ctx=None):
10934 """Create a Z3 floating-point conversion expression, from floating-point expression to signed bit-vector.
10936 >>> x = FP('x', FPSort(8, 24))
10937 >>> y = fpToSBV(RTZ(), x, BitVecSort(32))
10938 >>> print(is_fp(x))
10940 >>> print(is_bv(y))
10942 >>> print(is_fp(y))
10944 >>> print(is_bv(x))
10948 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10949 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
10950 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
10951 ctx = _get_ctx(ctx)
10952 return BitVecRef(Z3_mk_fpa_to_sbv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
10955def fpToUBV(rm, x, s, ctx=None):
10956 """Create a Z3 floating-point conversion expression, from floating-point expression to unsigned bit-vector.
10958 >>> x = FP('x', FPSort(8, 24))
10959 >>> y = fpToUBV(RTZ(), x, BitVecSort(32))
10960 >>> print(is_fp(x))
10962 >>> print(is_bv(y))
10964 >>> print(is_fp(y))
10966 >>> print(is_bv(x))
10970 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10971 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
10972 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
10973 ctx = _get_ctx(ctx)
10974 return BitVecRef(Z3_mk_fpa_to_ubv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
10977def fpToReal(x, ctx=None):
10978 """Create a Z3 floating-point conversion expression, from floating-point expression to real.
10980 >>> x = FP('x', FPSort(8, 24))
10981 >>> y = fpToReal(x)
10982 >>> print(is_fp(x))
10984 >>> print(is_real(y))
10986 >>> print(is_fp(y))
10988 >>> print(is_real(x))
10992 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
10993 ctx = _get_ctx(ctx)
10994 return ArithRef(Z3_mk_fpa_to_real(ctx.ref(), x.ast), ctx)
10997def fpToIEEEBV(x, ctx=None):
10998 """\brief Conversion of a floating-point term into a bit-vector term in IEEE 754-2008 format.
11000 The size of the resulting bit-vector is automatically determined.
11002 Note that IEEE 754-2008 allows multiple different representations of NaN. This conversion
11003 knows only one NaN and it will always produce the same bit-vector representation of
11006 >>> x = FP('x', FPSort(8, 24))
11007 >>> y = fpToIEEEBV(x)
11008 >>> print(is_fp(x))
11010 >>> print(is_bv(y))
11012 >>> print(is_fp(y))
11014 >>> print(is_bv(x))
11018 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
11019 ctx = _get_ctx(ctx)
11020 return BitVecRef(Z3_mk_fpa_to_ieee_bv(ctx.ref(), x.ast), ctx)
11023#########################################
11025# Strings, Sequences and Regular expressions
11027#########################################
11029class SeqSortRef(SortRef):
11030 """Sequence sort."""
11032 def is_string(self):
11033 """Determine if sort is a string
11034 >>> s = StringSort()
11037 >>> s = SeqSort(IntSort())
11041 return Z3_is_string_sort(self.ctx_ref(), self.ast)
11044 return _to_sort_ref(Z3_get_seq_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11046class CharSortRef(SortRef):
11047 """Character sort."""
11050def StringSort(ctx=None):
11051 """Create a string sort
11052 >>> s = StringSort()
11056 ctx = _get_ctx(ctx)
11057 return SeqSortRef(Z3_mk_string_sort(ctx.ref()), ctx)
11059def CharSort(ctx=None):
11060 """Create a character sort
11061 >>> ch = CharSort()
11065 ctx = _get_ctx(ctx)
11066 return CharSortRef(Z3_mk_char_sort(ctx.ref()), ctx)
11070 """Create a sequence sort over elements provided in the argument
11071 >>> s = SeqSort(IntSort())
11072 >>> s == Unit(IntVal(1)).sort()
11075 return SeqSortRef(Z3_mk_seq_sort(s.ctx_ref(), s.ast), s.ctx)
11078class SeqRef(ExprRef):
11079 """Sequence expression."""
11082 return SeqSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
11084 def __add__(self, other):
11085 return Concat(self, other)
11087 def __radd__(self, other):
11088 return Concat(other, self)
11090 def __getitem__(self, i):
11092 i = IntVal(i, self.ctx)
11093 return _to_expr_ref(Z3_mk_seq_nth(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11097 i = IntVal(i, self.ctx)
11098 return SeqRef(Z3_mk_seq_at(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11100 def is_string(self):
11101 return Z3_is_string_sort(self.ctx_ref(), Z3_get_sort(self.ctx_ref(), self.as_ast()))
11103 def is_string_value(self):
11104 return Z3_is_string(self.ctx_ref(), self.as_ast())
11106 def as_string(self):
11107 """Return a string representation of sequence expression."""
11108 if self.is_string_value():
11109 string_length = ctypes.c_uint()
11110 chars = Z3_get_lstring(self.ctx_ref(), self.as_ast(), byref(string_length))
11111 return string_at(chars, size=string_length.value).decode("latin-1")
11112 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
11114 def py_value(self):
11115 return self.as_string()
11117 def __le__(self, other):
11118 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11120 def __lt__(self, other):
11121 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11123 def __ge__(self, other):
11124 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11126 def __gt__(self, other):
11127 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11130def _coerce_char(ch, ctx=None):
11131 if isinstance(ch, str):
11132 ctx = _get_ctx(ctx)
11133 ch = CharVal(ch, ctx)
11134 if not is_expr(ch):
11135 raise Z3Exception("Character expression expected")
11138class CharRef(ExprRef):
11139 """Character expression."""
11141 def __le__(self, other):
11142 other = _coerce_char(other, self.ctx)
11143 return _to_expr_ref(Z3_mk_char_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11146 return _to_expr_ref(Z3_mk_char_to_int(self.ctx_ref(), self.as_ast()), self.ctx)
11149 return _to_expr_ref(Z3_mk_char_to_bv(self.ctx_ref(), self.as_ast()), self.ctx)
11151 def is_digit(self):
11152 return _to_expr_ref(Z3_mk_char_is_digit(self.ctx_ref(), self.as_ast()), self.ctx)
11155def CharVal(ch, ctx=None):
11156 ctx = _get_ctx(ctx)
11157 if isinstance(ch, str):
11159 if not isinstance(ch, int):
11160 raise Z3Exception("character value should be an ordinal")
11161 return _to_expr_ref(Z3_mk_char(ctx.ref(), ch), ctx)
11164 if not is_expr(bv):
11165 raise Z3Exception("Bit-vector expression needed")
11166 return _to_expr_ref(Z3_mk_char_from_bv(bv.ctx_ref(), bv.as_ast()), bv.ctx)
11168def CharToBv(ch, ctx=None):
11169 ch = _coerce_char(ch, ctx)
11172def CharToInt(ch, ctx=None):
11173 ch = _coerce_char(ch, ctx)
11176def CharIsDigit(ch, ctx=None):
11177 ch = _coerce_char(ch, ctx)
11178 return ch.is_digit()
11180def _coerce_seq(s, ctx=None):
11181 if isinstance(s, str):
11182 ctx = _get_ctx(ctx)
11183 s = StringVal(s, ctx)
11185 raise Z3Exception("Non-expression passed as a sequence")
11187 raise Z3Exception("Non-sequence passed as a sequence")
11191def _get_ctx2(a, b, ctx=None):
11202 """Return `True` if `a` is a Z3 sequence expression.
11203 >>> print (is_seq(Unit(IntVal(0))))
11205 >>> print (is_seq(StringVal("abc")))
11208 return isinstance(a, SeqRef)
11211def is_string(a: Any) -> bool:
11212 """Return `True` if `a` is a Z3 string expression.
11213 >>> print (is_string(StringVal("ab")))
11216 return isinstance(a, SeqRef) and a.is_string()
11219def is_string_value(a: Any) -> bool:
11220 """return 'True' if 'a' is a Z3 string constant expression.
11221 >>> print (is_string_value(StringVal("a")))
11223 >>> print (is_string_value(StringVal("a") + StringVal("b")))
11226 return isinstance(a, SeqRef) and a.is_string_value()
11228def StringVal(s, ctx=None):
11229 """create a string expression"""
11230 s = "".join(str(ch) if 32 <= ord(ch) and ord(ch) < 127 else "\\u{%x}" % (ord(ch)) for ch in s)
11231 ctx = _get_ctx(ctx)
11232 return SeqRef(Z3_mk_string(ctx.ref(), s), ctx)
11235def String(name, ctx=None):
11236 """Return a string constant named `name`. If `ctx=None`, then the global context is used.
11238 >>> x = String('x')
11240 ctx = _get_ctx(ctx)
11241 return SeqRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), StringSort(ctx).ast), ctx)
11244def Strings(names, ctx=None):
11245 """Return a tuple of String constants. """
11246 ctx = _get_ctx(ctx)
11247 if isinstance(names, str):
11248 names = names.split(" ")
11249 return [String(name, ctx) for name in names]
11252def SubString(s, offset, length):
11253 """Extract substring or subsequence starting at offset.
11255 This is a convenience function that redirects to Extract(s, offset, length).
11257 >>> s = StringVal("hello world")
11258 >>> SubString(s, 6, 5) # Extract "world"
11259 str.substr("hello world", 6, 5)
11260 >>> simplify(SubString(StringVal("hello"), 1, 3))
11263 return Extract(s, offset, length)
11266def SubSeq(s, offset, length):
11267 """Extract substring or subsequence starting at offset.
11269 This is a convenience function that redirects to Extract(s, offset, length).
11271 >>> s = StringVal("hello world")
11272 >>> SubSeq(s, 0, 5) # Extract "hello"
11273 str.substr("hello world", 0, 5)
11274 >>> simplify(SubSeq(StringVal("testing"), 2, 4))
11277 return Extract(s, offset, length)
11281 """Create the empty sequence of the given sort
11282 >>> e = Empty(StringSort())
11283 >>> e2 = StringVal("")
11284 >>> print(e.eq(e2))
11286 >>> e3 = Empty(SeqSort(IntSort()))
11289 >>> e4 = Empty(ReSort(SeqSort(IntSort())))
11291 Empty(ReSort(Seq(Int)))
11293 if isinstance(s, SeqSortRef):
11294 return SeqRef(Z3_mk_seq_empty(s.ctx_ref(), s.ast), s.ctx)
11295 if isinstance(s, ReSortRef):
11296 return ReRef(Z3_mk_re_empty(s.ctx_ref(), s.ast), s.ctx)
11297 raise Z3Exception("Non-sequence, non-regular expression sort passed to Empty")
11301 """Create the regular expression that accepts the universal language
11302 >>> e = Full(ReSort(SeqSort(IntSort())))
11304 Full(ReSort(Seq(Int)))
11305 >>> e1 = Full(ReSort(StringSort()))
11307 Full(ReSort(String))
11309 if isinstance(s, ReSortRef):
11310 return ReRef(Z3_mk_re_full(s.ctx_ref(), s.ast), s.ctx)
11311 raise Z3Exception("Non-sequence, non-regular expression sort passed to Full")
11316 """Create a singleton sequence"""
11317 return SeqRef(Z3_mk_seq_unit(a.ctx_ref(), a.as_ast()), a.ctx)
11321 """Check if 'a' is a prefix of 'b'
11322 >>> s1 = PrefixOf("ab", "abc")
11325 >>> s2 = PrefixOf("bc", "abc")
11329 ctx = _get_ctx2(a, b)
11330 a = _coerce_seq(a, ctx)
11331 b = _coerce_seq(b, ctx)
11332 return BoolRef(Z3_mk_seq_prefix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11336 """Check if 'a' is a suffix of 'b'
11337 >>> s1 = SuffixOf("ab", "abc")
11340 >>> s2 = SuffixOf("bc", "abc")
11344 ctx = _get_ctx2(a, b)
11345 a = _coerce_seq(a, ctx)
11346 b = _coerce_seq(b, ctx)
11347 return BoolRef(Z3_mk_seq_suffix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11351 """Check if 'a' contains 'b'
11352 >>> s1 = Contains("abc", "ab")
11355 >>> s2 = Contains("abc", "bc")
11358 >>> x, y, z = Strings('x y z')
11359 >>> s3 = Contains(Concat(x,y,z), y)
11363 ctx = _get_ctx2(a, b)
11364 a = _coerce_seq(a, ctx)
11365 b = _coerce_seq(b, ctx)
11366 return BoolRef(Z3_mk_seq_contains(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11369def Replace(s, src, dst):
11370 """Replace the first occurrence of 'src' by 'dst' in 's'
11371 >>> r = Replace("aaa", "a", "b")
11375 ctx = _get_ctx2(dst, s)
11376 if ctx is None and is_expr(src):
11378 src = _coerce_seq(src, ctx)
11379 dst = _coerce_seq(dst, ctx)
11380 s = _coerce_seq(s, ctx)
11381 return SeqRef(Z3_mk_seq_replace(src.ctx_ref(), s.as_ast(), src.as_ast(), dst.as_ast()), s.ctx)
11384def IndexOf(s, substr, offset=None):
11385 """Retrieve the index of substring within a string starting at a specified offset.
11386 >>> simplify(IndexOf("abcabc", "bc", 0))
11388 >>> simplify(IndexOf("abcabc", "bc", 2))
11394 if is_expr(offset):
11396 ctx = _get_ctx2(s, substr, ctx)
11397 s = _coerce_seq(s, ctx)
11398 substr = _coerce_seq(substr, ctx)
11399 if _is_int(offset):
11400 offset = IntVal(offset, ctx)
11401 return ArithRef(Z3_mk_seq_index(s.ctx_ref(), s.as_ast(), substr.as_ast(), offset.as_ast()), s.ctx)
11404def LastIndexOf(s, substr):
11405 """Retrieve the last index of substring within a string"""
11407 ctx = _get_ctx2(s, substr, ctx)
11408 s = _coerce_seq(s, ctx)
11409 substr = _coerce_seq(substr, ctx)
11410 return ArithRef(Z3_mk_seq_last_index(s.ctx_ref(), s.as_ast(), substr.as_ast()), s.ctx)
11414 """Obtain the length of a sequence 's'
11415 >>> l = Length(StringVal("abc"))
11420 return ArithRef(Z3_mk_seq_length(s.ctx_ref(), s.as_ast()), s.ctx)
11423 """Map function 'f' over sequence 's'"""
11424 ctx = _get_ctx2(f, s)
11425 s = _coerce_seq(s, ctx)
11426 return _to_expr_ref(Z3_mk_seq_map(s.ctx_ref(), f.as_ast(), s.as_ast()), ctx)
11428def SeqMapI(f, i, s):
11429 """Map function 'f' over sequence 's' at index 'i'"""
11430 ctx = _get_ctx2(f, s)
11431 s = _coerce_seq(s, ctx)
11434 return _to_expr_ref(Z3_mk_seq_mapi(s.ctx_ref(), f.as_ast(), i.as_ast(), s.as_ast()), ctx)
11436def SeqFoldLeft(f, a, s):
11437 ctx = _get_ctx2(f, s)
11438 s = _coerce_seq(s, ctx)
11440 return _to_expr_ref(Z3_mk_seq_foldl(s.ctx_ref(), f.as_ast(), a.as_ast(), s.as_ast()), ctx)
11442def SeqFoldLeftI(f, i, a, s):
11443 ctx = _get_ctx2(f, s)
11444 s = _coerce_seq(s, ctx)
11447 return _to_expr_ref(Z3_mk_seq_foldli(s.ctx_ref(), f.as_ast(), i.as_ast(), a.as_ast(), s.as_ast()), ctx)
11450 """Convert string expression to integer
11451 >>> a = StrToInt("1")
11452 >>> simplify(1 == a)
11454 >>> b = StrToInt("2")
11455 >>> simplify(1 == b)
11457 >>> c = StrToInt(IntToStr(2))
11458 >>> simplify(1 == c)
11462 return ArithRef(Z3_mk_str_to_int(s.ctx_ref(), s.as_ast()), s.ctx)
11466 """Convert integer expression to string"""
11469 return SeqRef(Z3_mk_int_to_str(s.ctx_ref(), s.as_ast()), s.ctx)
11473 """Convert a unit length string to integer code"""
11476 return ArithRef(Z3_mk_string_to_code(s.ctx_ref(), s.as_ast()), s.ctx)
11479 """Convert code to a string"""
11482 return SeqRef(Z3_mk_string_from_code(c.ctx_ref(), c.as_ast()), c.ctx)
11484def Re(s, ctx=None):
11485 """The regular expression that accepts sequence 's'
11487 >>> s2 = Re(StringVal("ab"))
11488 >>> s3 = Re(Unit(BoolVal(True)))
11490 s = _coerce_seq(s, ctx)
11491 return ReRef(Z3_mk_seq_to_re(s.ctx_ref(), s.as_ast()), s.ctx)
11494# Regular expressions
11496class ReSortRef(SortRef):
11497 """Regular expression sort."""
11500 return _to_sort_ref(Z3_get_re_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11505 return ReSortRef(Z3_mk_re_sort(s.ctx.ref(), s.ast), s.ctx)
11506 if s is None or isinstance(s, Context):
11508 return ReSortRef(Z3_mk_re_sort(ctx.ref(), Z3_mk_string_sort(ctx.ref())), s.ctx)
11509 raise Z3Exception("Regular expression sort constructor expects either a string or a context or no argument")
11512class ReRef(ExprRef):
11513 """Regular expressions."""
11515 def __add__(self, other):
11516 return Union(self, other)
11520 return isinstance(s, ReRef)
11524 """Create regular expression membership test
11525 >>> re = Union(Re("a"),Re("b"))
11526 >>> print (simplify(InRe("a", re)))
11528 >>> print (simplify(InRe("b", re)))
11530 >>> print (simplify(InRe("c", re)))
11533 s = _coerce_seq(s, re.ctx)
11534 return BoolRef(Z3_mk_seq_in_re(s.ctx_ref(), s.as_ast(), re.as_ast()), s.ctx)
11538 """Create union of regular expressions.
11539 >>> re = Union(Re("a"), Re("b"), Re("c"))
11540 >>> print (simplify(InRe("d", re)))
11543 args = _get_args(args)
11546 _z3_assert(sz > 0, "At least one argument expected.")
11547 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11552 for i in range(sz):
11553 v[i] = args[i].as_ast()
11554 return ReRef(Z3_mk_re_union(ctx.ref(), sz, v), ctx)
11557def Intersect(*args):
11558 """Create intersection of regular expressions.
11559 >>> re = Intersect(Re("a"), Re("b"), Re("c"))
11561 args = _get_args(args)
11564 _z3_assert(sz > 0, "At least one argument expected.")
11565 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11570 for i in range(sz):
11571 v[i] = args[i].as_ast()
11572 return ReRef(Z3_mk_re_intersect(ctx.ref(), sz, v), ctx)
11576 """Create the regular expression accepting one or more repetitions of argument.
11577 >>> re = Plus(Re("a"))
11578 >>> print(simplify(InRe("aa", re)))
11580 >>> print(simplify(InRe("ab", re)))
11582 >>> print(simplify(InRe("", re)))
11586 _z3_assert(is_expr(re), "expression expected")
11587 return ReRef(Z3_mk_re_plus(re.ctx_ref(), re.as_ast()), re.ctx)
11591 """Create the regular expression that optionally accepts the argument.
11592 >>> re = Option(Re("a"))
11593 >>> print(simplify(InRe("a", re)))
11595 >>> print(simplify(InRe("", re)))
11597 >>> print(simplify(InRe("aa", re)))
11601 _z3_assert(is_expr(re), "expression expected")
11602 return ReRef(Z3_mk_re_option(re.ctx_ref(), re.as_ast()), re.ctx)
11606 """Create the complement regular expression."""
11607 return ReRef(Z3_mk_re_complement(re.ctx_ref(), re.as_ast()), re.ctx)
11611 """Create the regular expression accepting zero or more repetitions of argument.
11612 >>> re = Star(Re("a"))
11613 >>> print(simplify(InRe("aa", re)))
11615 >>> print(simplify(InRe("ab", re)))
11617 >>> print(simplify(InRe("", re)))
11621 _z3_assert(is_expr(re), "expression expected")
11622 return ReRef(Z3_mk_re_star(re.ctx_ref(), re.as_ast()), re.ctx)
11625def Loop(re, lo, hi=0):
11626 """Create the regular expression accepting between a lower and upper bound repetitions
11627 >>> re = Loop(Re("a"), 1, 3)
11628 >>> print(simplify(InRe("aa", re)))
11630 >>> print(simplify(InRe("aaaa", re)))
11632 >>> print(simplify(InRe("", re)))
11636 _z3_assert(is_expr(re), "expression expected")
11637 return ReRef(Z3_mk_re_loop(re.ctx_ref(), re.as_ast(), lo, hi), re.ctx)
11640def Range(lo, hi, ctx=None):
11641 """Create the range regular expression over two sequences of length 1
11642 >>> range = Range("a","z")
11643 >>> print(simplify(InRe("b", range)))
11645 >>> print(simplify(InRe("bb", range)))
11648 lo = _coerce_seq(lo, ctx)
11649 hi = _coerce_seq(hi, ctx)
11651 _z3_assert(is_expr(lo), "expression expected")
11652 _z3_assert(is_expr(hi), "expression expected")
11653 return ReRef(Z3_mk_re_range(lo.ctx_ref(), lo.ast, hi.ast), lo.ctx)
11655def Diff(a, b, ctx=None):
11656 """Create the difference regular expression
11659 _z3_assert(is_expr(a), "expression expected")
11660 _z3_assert(is_expr(b), "expression expected")
11661 return ReRef(Z3_mk_re_diff(a.ctx_ref(), a.ast, b.ast), a.ctx)
11663def AllChar(regex_sort, ctx=None):
11664 """Create a regular expression that accepts all single character strings
11666 return ReRef(Z3_mk_re_allchar(regex_sort.ctx_ref(), regex_sort.ast), regex_sort.ctx)
11671def PartialOrder(a, index):
11672 return FuncDeclRef(Z3_mk_partial_order(a.ctx_ref(), a.ast, index), a.ctx)
11675def LinearOrder(a, index):
11676 return FuncDeclRef(Z3_mk_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11679def TreeOrder(a, index):
11680 return FuncDeclRef(Z3_mk_tree_order(a.ctx_ref(), a.ast, index), a.ctx)
11683def PiecewiseLinearOrder(a, index):
11684 return FuncDeclRef(Z3_mk_piecewise_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11687def TransitiveClosure(f):
11688 """Given a binary relation R, such that the two arguments have the same sort
11689 create the transitive closure relation R+.
11690 The transitive closure R+ is a new relation.
11692 return FuncDeclRef(Z3_mk_transitive_closure(f.ctx_ref(), f.ast), f.ctx)
11696 super(ctypes.c_void_p, ast).__init__(ptr)
11699def to_ContextObj(ptr,):
11700 ctx = ContextObj(ptr)
11701 super(ctypes.c_void_p, ctx).__init__(ptr)
11704def to_AstVectorObj(ptr,):
11705 v = AstVectorObj(ptr)
11706 super(ctypes.c_void_p, v).__init__(ptr)
11709# NB. my-hacky-class only works for a single instance of OnClause
11710# it should be replaced with a proper correlation between OnClause
11711# and object references that can be passed over the FFI.
11712# for UserPropagator we use a global dictionary, which isn't great code.
11714_my_hacky_class = None
11715def on_clause_eh(ctx, p, n, dep, clause):
11716 onc = _my_hacky_class
11717 p = _to_expr_ref(to_Ast(p), onc.ctx)
11718 clause = AstVector(to_AstVectorObj(clause), onc.ctx)
11719 deps = [dep[i] for i in range(n)]
11720 onc.on_clause(p, deps, clause)
11722_on_clause_eh = Z3_on_clause_eh(on_clause_eh)
11725 def __init__(self, s, on_clause):
11728 self.on_clause = on_clause
11730 global _my_hacky_class
11731 _my_hacky_class = self
11732 Z3_solver_register_on_clause(self.ctx.ref(), self.s.solver, self.idx, _on_clause_eh)
11736 def __init__(self):
11740 def set_threaded(self):
11741 if self.lock is None:
11743 self.lock = threading.Lock()
11745 def get(self, ctx):
11748 r = self.bases[ctx]
11750 r = self.bases[ctx]
11753 def set(self, ctx, r):
11756 self.bases[ctx] = r
11758 self.bases[ctx] = r
11760 def insert(self, r):
11763 id = len(self.bases) + 3
11766 id = len(self.bases) + 3
11771_prop_closures = None
11774def ensure_prop_closures():
11775 global _prop_closures
11776 if _prop_closures is None:
11777 _prop_closures = PropClosures()
11780def user_prop_push(ctx, cb):
11781 prop = _prop_closures.get(ctx)
11786def user_prop_pop(ctx, cb, num_scopes):
11787 prop = _prop_closures.get(ctx)
11789 prop.pop(num_scopes)
11792def user_prop_fresh(ctx, _new_ctx):
11793 _prop_closures.set_threaded()
11794 prop = _prop_closures.get(ctx)
11796 Z3_del_context(nctx.ctx)
11797 new_ctx = to_ContextObj(_new_ctx)
11799 nctx.eh = Z3_set_error_handler(new_ctx, z3_error_handler)
11801 new_prop = prop.fresh(nctx)
11802 _prop_closures.set(new_prop.id, new_prop)
11806def user_prop_fixed(ctx, cb, id, value):
11807 prop = _prop_closures.get(ctx)
11810 id = _to_expr_ref(to_Ast(id), prop.ctx())
11811 value = _to_expr_ref(to_Ast(value), prop.ctx())
11812 prop.fixed(id, value)
11815def user_prop_created(ctx, cb, id):
11816 prop = _prop_closures.get(ctx)
11819 id = _to_expr_ref(to_Ast(id), prop.ctx())
11824def user_prop_final(ctx, cb):
11825 prop = _prop_closures.get(ctx)
11831def user_prop_eq(ctx, cb, x, y):
11832 prop = _prop_closures.get(ctx)
11835 x = _to_expr_ref(to_Ast(x), prop.ctx())
11836 y = _to_expr_ref(to_Ast(y), prop.ctx())
11840def user_prop_diseq(ctx, cb, x, y):
11841 prop = _prop_closures.get(ctx)
11844 x = _to_expr_ref(to_Ast(x), prop.ctx())
11845 y = _to_expr_ref(to_Ast(y), prop.ctx())
11849def user_prop_decide(ctx, cb, t_ref, idx, phase):
11850 prop = _prop_closures.get(ctx)
11853 t = _to_expr_ref(to_Ast(t_ref), prop.ctx())
11854 prop.decide(t, idx, phase)
11857def user_prop_binding(ctx, cb, q_ref, inst_ref):
11858 prop = _prop_closures.get(ctx)
11861 q = _to_expr_ref(to_Ast(q_ref), prop.ctx())
11862 inst = _to_expr_ref(to_Ast(inst_ref), prop.ctx())
11863 r = prop.binding(q, inst)
11868_user_prop_push = Z3_push_eh(user_prop_push)
11869_user_prop_pop = Z3_pop_eh(user_prop_pop)
11870_user_prop_fresh = Z3_fresh_eh(user_prop_fresh)
11871_user_prop_fixed = Z3_fixed_eh(user_prop_fixed)
11872_user_prop_created = Z3_created_eh(user_prop_created)
11873_user_prop_final = Z3_final_eh(user_prop_final)
11874_user_prop_eq = Z3_eq_eh(user_prop_eq)
11875_user_prop_diseq = Z3_eq_eh(user_prop_diseq)
11876_user_prop_decide = Z3_decide_eh(user_prop_decide)
11877_user_prop_binding = Z3_on_binding_eh(user_prop_binding)
11880def PropagateFunction(name, *sig):
11881 """Create a function that gets tracked by user propagator.
11882 Every term headed by this function symbol is tracked.
11883 If a term is fixed and the fixed callback is registered a
11884 callback is invoked that the term headed by this function is fixed.
11886 sig = _get_args(sig)
11888 _z3_assert(len(sig) > 0, "At least two arguments expected")
11889 arity = len(sig) - 1
11892 _z3_assert(is_sort(rng), "Z3 sort expected")
11893 dom = (Sort * arity)()
11894 for i in range(arity):
11896 _z3_assert(is_sort(sig[i]), "Z3 sort expected")
11897 dom[i] = sig[i].ast
11899 return FuncDeclRef(Z3_solver_propagate_declare(ctx.ref(), to_symbol(name, ctx), arity, dom, rng.ast), ctx)
11903class UserPropagateBase:
11906 # Either solver is set or ctx is set.
11907 # Propagators that are created through callbacks
11908 # to "fresh" inherit the context of that is supplied
11909 # as argument to the callback.
11910 # This context should not be deleted. It is owned by the solver.
11912 def __init__(self, s, ctx=None):
11913 assert s is None or ctx is None
11914 ensure_prop_closures()
11917 self.fresh_ctx = None
11919 self.id = _prop_closures.insert(self)
11925 self.created = None
11926 self.binding = None
11928 self.fresh_ctx = ctx
11930 Z3_solver_propagate_init(self.ctx_ref(),
11932 ctypes.c_void_p(self.id),
11939 self._ctx.ctx = None
11943 return self.fresh_ctx
11945 return self.solver.ctx
11948 return self.ctx().ref()
11950 def add_fixed(self, fixed):
11951 assert not self.fixed
11952 assert not self._ctx
11954 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
11957 def add_created(self, created):
11958 assert not self.created
11959 assert not self._ctx
11961 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
11962 self.created = created
11964 def add_final(self, final):
11965 assert not self.final
11966 assert not self._ctx
11968 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
11971 def add_eq(self, eq):
11973 assert not self._ctx
11975 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
11978 def add_diseq(self, diseq):
11979 assert not self.diseq
11980 assert not self._ctx
11982 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
11985 def add_decide(self, decide):
11986 assert not self.decide
11987 assert not self._ctx
11989 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
11990 self.decide = decide
11992 def add_on_binding(self, binding):
11993 assert not self.binding
11994 assert not self._ctx
11996 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
11997 self.binding = binding
12000 raise Z3Exception("push needs to be overwritten")
12002 def pop(self, num_scopes):
12003 raise Z3Exception("pop needs to be overwritten")
12005 def fresh(self, new_ctx):
12006 raise Z3Exception("fresh needs to be overwritten")
12009 assert not self._ctx
12011 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
12013 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
12016 # Tell the solver to perform the next split on a given term
12017 # If the term is a bit-vector the index idx specifies the index of the Boolean variable being
12018 # split on. A phase of true = 1/false = -1/undef = 0 = let solver decide is the last argument.
12020 def next_split(self, t, idx, phase):
12021 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
12024 # Propagation can only be invoked as during a fixed or final callback.
12026 def propagate(self, e, ids, eqs=[]):
12027 _ids, num_fixed = _to_ast_array(ids)
12029 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
12030 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
12031 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
12032 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
12034 def conflict(self, deps = [], eqs = []):
12035 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={})
__init__(self, *args, **kws)
__deepcopy__(self, memo={})
__init__(self, name, ctx=None)
declare(self, name, *args)
declare_core(self, name, rec_name, *args)
__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 ...
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_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_set_has_size(Z3_context c, Z3_ast set, Z3_ast k)
Create predicate that holds if Boolean array set has k elements set to true.
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=[])