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")
1253 if isinstance(a, str)
and isinstance(b, SeqRef):
1255 if isinstance(b, str)
and isinstance(a, SeqRef):
1257 if isinstance(a, float)
and isinstance(b, ArithRef):
1259 if isinstance(b, float)
and isinstance(a, ArithRef):
1272 for element
in sequence:
1273 result = func(result, element)
1284 alist = [
_py2expr(a, ctx)
for a
in alist]
1285 s =
_reduce(_coerce_expr_merge, alist,
None)
1286 return [s.cast(a)
for a
in alist]
1290 """Return `True` if `a` is a Z3 expression.
1297 >>> is_expr(IntSort())
1301 >>> is_expr(IntVal(1))
1304 >>> is_expr(ForAll(x, x >= 0))
1306 >>> is_expr(FPVal(1.0))
1309 return isinstance(a, ExprRef)
1313 """Return `True` if `a` is a Z3 function application.
1315 Note that, constants are function applications with 0 arguments.
1322 >>> is_app(IntSort())
1326 >>> is_app(IntVal(1))
1329 >>> is_app(ForAll(x, x >= 0))
1332 if not isinstance(a, ExprRef):
1335 return k == Z3_NUMERAL_AST
or k == Z3_APP_AST
1339 """Return `True` if `a` is Z3 constant/variable expression.
1348 >>> is_const(IntVal(1))
1351 >>> is_const(ForAll(x, x >= 0))
1354 return is_app(a)
and a.num_args() == 0
1358 """Return `True` if `a` is variable.
1360 Z3 uses de-Bruijn indices for representing bound variables in
1368 >>> f = Function('f', IntSort(), IntSort())
1369 >>> # Z3 replaces x with bound variables when ForAll is executed.
1370 >>> q = ForAll(x, f(x) == x)
1376 >>> is_var(b.arg(1))
1383 """Return the de-Bruijn index of the Z3 bounded variable `a`.
1391 >>> f = Function('f', IntSort(), IntSort(), IntSort())
1392 >>> # Z3 replaces x and y with bound variables when ForAll is executed.
1393 >>> q = ForAll([x, y], f(x, y) == x + y)
1395 f(Var(1), Var(0)) == Var(1) + Var(0)
1399 >>> v1 = b.arg(0).arg(0)
1400 >>> v2 = b.arg(0).arg(1)
1405 >>> get_var_index(v1)
1407 >>> get_var_index(v2)
1416 """Return `True` if `a` is an application of the given kind `k`.
1420 >>> is_app_of(n, Z3_OP_ADD)
1422 >>> is_app_of(n, Z3_OP_MUL)
1425 return is_app(a)
and a.kind() == k
1428def If(a, b, c, ctx=None):
1429 """Create a Z3 if-then-else expression.
1433 >>> max = If(x > y, x, y)
1439 if isinstance(a, Probe)
or isinstance(b, Tactic)
or isinstance(c, Tactic):
1440 return Cond(a, b, c, ctx)
1447 _z3_assert(a.ctx == b.ctx,
"Context mismatch")
1452 """Create a Z3 distinct expression.
1459 >>> Distinct(x, y, z)
1461 >>> simplify(Distinct(x, y, z))
1463 >>> simplify(Distinct(x, y, z), blast_distinct=True)
1464 And(Not(x == y), Not(x == z), Not(y == z))
1469 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression")
1478 _z3_assert(a.ctx == b.ctx,
"Context mismatch")
1479 args[0] = a.as_ast()
1480 args[1] = b.as_ast()
1481 return f(a.ctx.ref(), 2, args)
1485 """Create a constant of the given sort.
1487 >>> Const('x', IntSort())
1491 _z3_assert(isinstance(sort, SortRef),
"Z3 sort expected")
1497 """Create several constants of the given sort.
1499 `names` is a string containing the names of all constants to be created.
1500 Blank spaces separate the names of different constants.
1502 >>> x, y, z = Consts('x y z', IntSort())
1506 if isinstance(names, str):
1507 names = names.split(
" ")
1508 return [
Const(name, sort)
for name
in names]
1512 """Create a fresh constant of a specified sort"""
1519def Var(idx : int, s : SortRef) -> ExprRef:
1520 """Create a Z3 free variable. Free variables are used to create quantified formulas.
1521 A free variable with index n is bound when it occurs within the scope of n+1 quantified
1524 >>> Var(0, IntSort())
1526 >>> eq(Var(0, IntSort()), Var(0, BoolSort()))
1536 Create a real free variable. Free variables are used to create quantified formulas.
1537 They are also used to create polynomials.
1546 Create a list of Real free variables.
1547 The variables have ids: 0, 1, ..., n-1
1549 >>> x0, x1, x2, x3 = RealVarVector(4)
1553 return [
RealVar(i, ctx)
for i
in range(n)]
1566 """Try to cast `val` as a Boolean.
1568 >>> x = BoolSort().cast(True)
1578 if isinstance(val, bool):
1582 msg =
"True, False or Z3 Boolean expression expected. Received %s of type %s"
1584 if not self.
eq(val.sort()):
1585 _z3_assert(self.
eq(val.sort()),
"Value cannot be converted into a Z3 Boolean value")
1589 return isinstance(other, ArithSortRef)
1599 """All Boolean expressions are instances of this class."""
1605 if isinstance(other, BoolRef):
1606 other =
If(other, 1, 0)
1607 return If(self, 1, 0) + other
1616 """Create the Z3 expression `self * other`.
1618 if isinstance(other, int)
and other == 1:
1619 return If(self, 1, 0)
1620 if isinstance(other, int)
and other == 0:
1622 if isinstance(other, BoolRef):
1623 other =
If(other, 1, 0)
1624 return If(self, other, 0)
1627 return And(self, other)
1630 return Or(self, other)
1633 return Xor(self, other)
1649 """Return `True` if `a` is a Z3 Boolean expression.
1655 >>> is_bool(And(p, q))
1663 return isinstance(a, BoolRef)
1667 """Return `True` if `a` is the Z3 true expression.
1672 >>> is_true(simplify(p == p))
1677 >>> # True is a Python Boolean expression
1685 """Return `True` if `a` is the Z3 false expression.
1692 >>> is_false(BoolVal(False))
1699 """Return `True` if `a` is a Z3 and expression.
1701 >>> p, q = Bools('p q')
1702 >>> is_and(And(p, q))
1704 >>> is_and(Or(p, q))
1711 """Return `True` if `a` is a Z3 or expression.
1713 >>> p, q = Bools('p q')
1716 >>> is_or(And(p, q))
1723 """Return `True` if `a` is a Z3 implication expression.
1725 >>> p, q = Bools('p q')
1726 >>> is_implies(Implies(p, q))
1728 >>> is_implies(And(p, q))
1735 """Return `True` if `a` is a Z3 not expression.
1747 """Return `True` if `a` is a Z3 equality expression.
1749 >>> x, y = Ints('x y')
1757 """Return `True` if `a` is a Z3 distinct expression.
1759 >>> x, y, z = Ints('x y z')
1760 >>> is_distinct(x == y)
1762 >>> is_distinct(Distinct(x, y, z))
1769 """Return the Boolean Z3 sort. If `ctx=None`, then the global context is used.
1773 >>> p = Const('p', BoolSort())
1776 >>> r = Function('r', IntSort(), IntSort(), BoolSort())
1779 >>> is_bool(r(0, 1))
1787 """Return the Boolean value `True` or `False`. If `ctx=None`, then the global context is used.
1791 >>> is_true(BoolVal(True))
1795 >>> is_false(BoolVal(False))
1806 """Return a Boolean constant named `name`. If `ctx=None`, then the global context is used.
1818 """Return a tuple of Boolean constants.
1820 `names` is a single string containing all names separated by blank spaces.
1821 If `ctx=None`, then the global context is used.
1823 >>> p, q, r = Bools('p q r')
1824 >>> And(p, Or(q, r))
1828 if isinstance(names, str):
1829 names = names.split(
" ")
1830 return [
Bool(name, ctx)
for name
in names]
1834 """Return a list of Boolean constants of size `sz`.
1836 The constants are named using the given prefix.
1837 If `ctx=None`, then the global context is used.
1839 >>> P = BoolVector('p', 3)
1843 And(p__0, p__1, p__2)
1845 return [
Bool(
"%s__%s" % (prefix, i))
for i
in range(sz)]
1849 """Return a fresh Boolean constant in the given context using the given prefix.
1851 If `ctx=None`, then the global context is used.
1853 >>> b1 = FreshBool()
1854 >>> b2 = FreshBool()
1863 """Create a Z3 implies expression.
1865 >>> p, q = Bools('p q')
1877 """Create a Z3 Xor expression.
1879 >>> p, q = Bools('p q')
1882 >>> simplify(Xor(p, q))
1893 """Create a Z3 not expression or probe.
1898 >>> simplify(Not(Not(p)))
1919 """Return `True` if one of the elements of the given collection is a Z3 probe."""
1927 """Create a Z3 and-expression or and-probe.
1929 >>> p, q, r = Bools('p q r')
1932 >>> P = BoolVector('p', 5)
1934 And(p__0, p__1, p__2, p__3, p__4)
1938 last_arg = args[len(args) - 1]
1939 if isinstance(last_arg, Context):
1940 ctx = args[len(args) - 1]
1941 args = args[:len(args) - 1]
1942 elif len(args) == 1
and isinstance(args[0], AstVector):
1944 args = [a
for a
in args[0]]
1950 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression or probe")
1960 """Create a Z3 or-expression or or-probe.
1962 >>> p, q, r = Bools('p q r')
1965 >>> P = BoolVector('p', 5)
1967 Or(p__0, p__1, p__2, p__3, p__4)
1971 last_arg = args[len(args) - 1]
1972 if isinstance(last_arg, Context):
1973 ctx = args[len(args) - 1]
1974 args = args[:len(args) - 1]
1975 elif len(args) == 1
and isinstance(args[0], AstVector):
1977 args = [a
for a
in args[0]]
1983 _z3_assert(ctx
is not None,
"At least one of the arguments must be a Z3 expression or probe")
1999 """Patterns are hints for quantifier instantiation.
2011 """Return `True` if `a` is a Z3 pattern (hint for quantifier instantiation.
2013 >>> f = Function('f', IntSort(), IntSort())
2015 >>> q = ForAll(x, f(x) == 0, patterns = [ f(x) ])
2017 ForAll(x, f(x) == 0)
2018 >>> q.num_patterns()
2020 >>> is_pattern(q.pattern(0))
2025 return isinstance(a, PatternRef)
2029 """Create a Z3 multi-pattern using the given expressions `*args`
2031 >>> f = Function('f', IntSort(), IntSort())
2032 >>> g = Function('g', IntSort(), IntSort())
2034 >>> q = ForAll(x, f(x) != g(x), patterns = [ MultiPattern(f(x), g(x)) ])
2036 ForAll(x, f(x) != g(x))
2037 >>> q.num_patterns()
2039 >>> is_pattern(q.pattern(0))
2042 MultiPattern(f(Var(0)), g(Var(0)))
2045 _z3_assert(len(args) > 0,
"At least one argument expected")
2066 """Universally and Existentially quantified formulas."""
2075 """Return the Boolean sort or sort of Lambda."""
2081 """Return `True` if `self` is a universal quantifier.
2083 >>> f = Function('f', IntSort(), IntSort())
2085 >>> q = ForAll(x, f(x) == 0)
2088 >>> q = Exists(x, f(x) != 0)
2095 """Return `True` if `self` is an existential quantifier.
2097 >>> f = Function('f', IntSort(), IntSort())
2099 >>> q = ForAll(x, f(x) == 0)
2102 >>> q = Exists(x, f(x) != 0)
2109 """Return `True` if `self` is a lambda expression.
2111 >>> f = Function('f', IntSort(), IntSort())
2113 >>> q = Lambda(x, f(x))
2116 >>> q = Exists(x, f(x) != 0)
2123 """Return the Z3 expression `self[arg]`.
2130 """Return the weight annotation of `self`.
2132 >>> f = Function('f', IntSort(), IntSort())
2134 >>> q = ForAll(x, f(x) == 0)
2137 >>> q = ForAll(x, f(x) == 0, weight=10)
2144 """Return the skolem id of `self`.
2149 """Return the quantifier id of `self`.
2154 """Return the number of patterns (i.e., quantifier instantiation hints) in `self`.
2156 >>> f = Function('f', IntSort(), IntSort())
2157 >>> g = Function('g', IntSort(), IntSort())
2159 >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2160 >>> q.num_patterns()
2166 """Return a pattern (i.e., quantifier instantiation hints) in `self`.
2168 >>> f = Function('f', IntSort(), IntSort())
2169 >>> g = Function('g', IntSort(), IntSort())
2171 >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2172 >>> q.num_patterns()
2184 """Return the number of no-patterns."""
2188 """Return a no-pattern."""
2194 """Return the expression being quantified.
2196 >>> f = Function('f', IntSort(), IntSort())
2198 >>> q = ForAll(x, f(x) == 0)
2205 """Return the number of variables bounded by this quantifier.
2207 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2210 >>> q = ForAll([x, y], f(x, y) >= x)
2217 """Return a string representing a name used when displaying the quantifier.
2219 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2222 >>> q = ForAll([x, y], f(x, y) >= x)
2233 """Return the sort of a bound variable.
2235 >>> f = Function('f', IntSort(), RealSort(), IntSort())
2238 >>> q = ForAll([x, y], f(x, y) >= x)
2249 """Return a list containing a single element self.body()
2251 >>> f = Function('f', IntSort(), IntSort())
2253 >>> q = ForAll(x, f(x) == 0)
2257 return [self.
body()]
2261 """Return `True` if `a` is a Z3 quantifier.
2263 >>> f = Function('f', IntSort(), IntSort())
2265 >>> q = ForAll(x, f(x) == 0)
2266 >>> is_quantifier(q)
2268 >>> is_quantifier(f(x))
2271 return isinstance(a, QuantifierRef)
2274def _mk_quantifier(is_forall, vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2279 _z3_assert(all([
is_expr(p)
for p
in no_patterns]),
"no patterns are Z3 expressions")
2290 _vs = (Ast * num_vars)()
2291 for i
in range(num_vars):
2293 _vs[i] = vs[i].as_ast()
2295 num_pats = len(patterns)
2296 _pats = (Pattern * num_pats)()
2297 for i
in range(num_pats):
2298 _pats[i] = patterns[i].ast
2305 num_no_pats, _no_pats,
2306 body.as_ast()), ctx)
2309def ForAll(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2310 """Create a Z3 forall formula.
2312 The parameters `weight`, `qid`, `skid`, `patterns` and `no_patterns` are optional annotations.
2314 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2317 >>> ForAll([x, y], f(x, y) >= x)
2318 ForAll([x, y], f(x, y) >= x)
2319 >>> ForAll([x, y], f(x, y) >= x, patterns=[ f(x, y) ])
2320 ForAll([x, y], f(x, y) >= x)
2321 >>> ForAll([x, y], f(x, y) >= x, weight=10)
2322 ForAll([x, y], f(x, y) >= x)
2324 return _mk_quantifier(
True, vs, body, weight, qid, skid, patterns, no_patterns)
2327def Exists(vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[]):
2328 """Create a Z3 exists formula.
2330 The parameters `weight`, `qif`, `skid`, `patterns` and `no_patterns` are optional annotations.
2333 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2336 >>> q = Exists([x, y], f(x, y) >= x, skid="foo")
2338 Exists([x, y], f(x, y) >= x)
2339 >>> is_quantifier(q)
2341 >>> r = Tactic('nnf')(q).as_expr()
2342 >>> is_quantifier(r)
2345 return _mk_quantifier(
False, vs, body, weight, qid, skid, patterns, no_patterns)
2349 """Create a Z3 lambda expression.
2351 >>> f = Function('f', IntSort(), IntSort(), IntSort())
2352 >>> mem0 = Array('mem0', IntSort(), IntSort())
2353 >>> lo, hi, e, i = Ints('lo hi e i')
2354 >>> mem1 = Lambda([i], If(And(lo <= i, i <= hi), e, mem0[i]))
2356 Lambda(i, If(And(lo <= i, i <= hi), e, mem0[i]))
2362 _vs = (Ast * num_vars)()
2363 for i
in range(num_vars):
2365 _vs[i] = vs[i].as_ast()
2376 """Real and Integer sorts."""
2379 """Return `True` if `self` is of the sort Real.
2384 >>> (x + 1).is_real()
2390 return self.
kind() == Z3_REAL_SORT
2393 """Return `True` if `self` is of the sort Integer.
2398 >>> (x + 1).is_int()
2404 return self.
kind() == Z3_INT_SORT
2410 """Return `True` if `self` is a subsort of `other`."""
2414 """Try to cast `val` as an Integer or Real.
2416 >>> IntSort().cast(10)
2418 >>> is_int(IntSort().cast(10))
2422 >>> RealSort().cast(10)
2424 >>> is_real(RealSort().cast(10))
2433 if val_s.is_int()
and self.
is_real():
2435 if val_s.is_bool()
and self.
is_int():
2436 return If(val, 1, 0)
2437 if val_s.is_bool()
and self.
is_real():
2440 _z3_assert(
False,
"Z3 Integer/Real expression expected")
2447 msg =
"int, long, float, string (numeral), or Z3 Integer/Real expression expected. Got %s"
2452 """Return `True` if s is an arithmetical sort (type).
2454 >>> is_arith_sort(IntSort())
2456 >>> is_arith_sort(RealSort())
2458 >>> is_arith_sort(BoolSort())
2460 >>> n = Int('x') + 1
2461 >>> is_arith_sort(n.sort())
2464 return isinstance(s, ArithSortRef)
2468 """Integer and Real expressions."""
2471 """Return the sort (type) of the arithmetical expression `self`.
2475 >>> (Real('x') + 1).sort()
2481 """Return `True` if `self` is an integer expression.
2486 >>> (x + 1).is_int()
2489 >>> (x + y).is_int()
2495 """Return `True` if `self` is an real expression.
2500 >>> (x + 1).is_real()
2506 """Create the Z3 expression `self + other`.
2519 """Create the Z3 expression `other + self`.
2529 """Create the Z3 expression `self * other`.
2538 if isinstance(other, BoolRef):
2539 return If(other, self, 0)
2544 """Create the Z3 expression `other * self`.
2554 """Create the Z3 expression `self - other`.
2567 """Create the Z3 expression `other - self`.
2577 """Create the Z3 expression `self**other` (** is the power operator).
2584 >>> simplify(IntVal(2)**8)
2591 """Create the Z3 expression `other**self` (** is the power operator).
2598 >>> simplify(2**IntVal(8))
2605 """Create the Z3 expression `other/self`.
2628 """Create the Z3 expression `other/self`."""
2632 """Create the Z3 expression `other/self`.
2649 """Create the Z3 expression `other/self`."""
2653 """Create the Z3 expression `other%self`.
2659 >>> simplify(IntVal(10) % IntVal(3))
2664 _z3_assert(a.is_int(),
"Z3 integer expression expected")
2668 """Create the Z3 expression `other%self`.
2676 _z3_assert(a.is_int(),
"Z3 integer expression expected")
2680 """Return an expression representing `-self`.
2700 """Create the Z3 expression `other <= self`.
2702 >>> x, y = Ints('x y')
2713 """Create the Z3 expression `other < self`.
2715 >>> x, y = Ints('x y')
2726 """Create the Z3 expression `other > self`.
2728 >>> x, y = Ints('x y')
2739 """Create the Z3 expression `other >= self`.
2741 >>> x, y = Ints('x y')
2753 """Return `True` if `a` is an arithmetical expression.
2762 >>> is_arith(IntVal(1))
2770 return isinstance(a, ArithRef)
2774 """Return `True` if `a` is an integer expression.
2781 >>> is_int(IntVal(1))
2793 """Return `True` if `a` is a real expression.
2805 >>> is_real(RealVal(1))
2820 """Return `True` if `a` is an integer value of sort Int.
2822 >>> is_int_value(IntVal(1))
2826 >>> is_int_value(Int('x'))
2828 >>> n = Int('x') + 1
2833 >>> is_int_value(n.arg(1))
2835 >>> is_int_value(RealVal("1/3"))
2837 >>> is_int_value(RealVal(1))
2844 """Return `True` if `a` is rational value of sort Real.
2846 >>> is_rational_value(RealVal(1))
2848 >>> is_rational_value(RealVal("3/5"))
2850 >>> is_rational_value(IntVal(1))
2852 >>> is_rational_value(1)
2854 >>> n = Real('x') + 1
2857 >>> is_rational_value(n.arg(1))
2859 >>> is_rational_value(Real('x'))
2866 """Return `True` if `a` is an algebraic value of sort Real.
2868 >>> is_algebraic_value(RealVal("3/5"))
2870 >>> n = simplify(Sqrt(2))
2873 >>> is_algebraic_value(n)
2880 """Return `True` if `a` is an expression of the form b + c.
2882 >>> x, y = Ints('x y')
2892 """Return `True` if `a` is an expression of the form b * c.
2894 >>> x, y = Ints('x y')
2904 """Return `True` if `a` is an expression of the form b - c.
2906 >>> x, y = Ints('x y')
2916 """Return `True` if `a` is an expression of the form b / c.
2918 >>> x, y = Reals('x y')
2923 >>> x, y = Ints('x y')
2933 """Return `True` if `a` is an expression of the form b div c.
2935 >>> x, y = Ints('x y')
2945 """Return `True` if `a` is an expression of the form b % c.
2947 >>> x, y = Ints('x y')
2957 """Return `True` if `a` is an expression of the form b <= c.
2959 >>> x, y = Ints('x y')
2969 """Return `True` if `a` is an expression of the form b < c.
2971 >>> x, y = Ints('x y')
2981 """Return `True` if `a` is an expression of the form b >= c.
2983 >>> x, y = Ints('x y')
2993 """Return `True` if `a` is an expression of the form b > c.
2995 >>> x, y = Ints('x y')
3005 """Return `True` if `a` is an expression of the form IsInt(b).
3008 >>> is_is_int(IsInt(x))
3017 """Return `True` if `a` is an expression of the form ToReal(b).
3032 """Return `True` if `a` is an expression of the form ToInt(b).
3047 """Integer values."""
3050 """Return a Z3 integer numeral as a Python long (bignum) numeral.
3063 """Return a Z3 integer numeral as a Python string.
3071 """Return a Z3 integer numeral as a Python binary string.
3073 >>> v.as_binary_string()
3083 """Rational values."""
3086 """ Return the numerator of a Z3 rational numeral.
3088 >>> is_rational_value(RealVal("3/5"))
3090 >>> n = RealVal("3/5")
3093 >>> is_rational_value(Q(3,5))
3095 >>> Q(3,5).numerator()
3101 """ Return the denominator of a Z3 rational numeral.
3103 >>> is_rational_value(Q(3,5))
3112 """ Return the numerator as a Python long.
3114 >>> v = RealVal(10000000000)
3119 >>> v.numerator_as_long() + 1 == 10000000001
3125 """ Return the denominator as a Python long.
3127 >>> v = RealVal("1/3")
3130 >>> v.denominator_as_long()
3149 """ Return a Z3 rational value as a string in decimal notation using at most `prec` decimal places.
3151 >>> v = RealVal("1/5")
3154 >>> v = RealVal("1/3")
3161 """Return a Z3 rational numeral as a Python string.
3170 """Return a Z3 rational as a Python Fraction object.
3172 >>> v = RealVal("1/5")
3183 """Algebraic irrational values."""
3186 """Return a Z3 rational number that approximates the algebraic number `self`.
3187 The result `r` is such that |r - self| <= 1/10^precision
3189 >>> x = simplify(Sqrt(2))
3191 6838717160008073720548335/4835703278458516698824704
3198 """Return a string representation of the algebraic number `self` in decimal notation
3199 using `prec` decimal places.
3201 >>> x = simplify(Sqrt(2))
3202 >>> x.as_decimal(10)
3204 >>> x.as_decimal(20)
3205 '1.41421356237309504880?'
3217 if isinstance(a, bool):
3221 if isinstance(a, float):
3223 if isinstance(a, str):
3228 _z3_assert(
False,
"Python bool, int, long or float expected")
3232 """Return the integer sort in the given context. If `ctx=None`, then the global context is used.
3236 >>> x = Const('x', IntSort())
3239 >>> x.sort() == IntSort()
3241 >>> x.sort() == BoolSort()
3249 """Return the real sort in the given context. If `ctx=None`, then the global context is used.
3253 >>> x = Const('x', RealSort())
3258 >>> x.sort() == RealSort()
3266 if isinstance(val, float):
3267 return str(int(val))
3268 elif isinstance(val, bool):
3278 """Return a Z3 integer value. If `ctx=None`, then the global context is used.
3290 """Return a Z3 real value.
3292 `val` may be a Python int, long, float or string representing a number in decimal or rational notation.
3293 If `ctx=None`, then the global context is used.
3297 >>> RealVal(1).sort()
3309 """Return a Z3 rational a/b.
3311 If `ctx=None`, then the global context is used.
3315 >>> RatVal(3,5).sort()
3319 _z3_assert(
_is_int(a)
or isinstance(a, str),
"First argument cannot be converted into an integer")
3320 _z3_assert(
_is_int(b)
or isinstance(b, str),
"Second argument cannot be converted into an integer")
3324def Q(a, b, ctx=None):
3325 """Return a Z3 rational a/b.
3327 If `ctx=None`, then the global context is used.
3338 """Return an integer constant named `name`. If `ctx=None`, then the global context is used.
3351 """Return a tuple of Integer constants.
3353 >>> x, y, z = Ints('x y z')
3358 if isinstance(names, str):
3359 names = names.split(
" ")
3360 return [
Int(name, ctx)
for name
in names]
3364 """Return a list of integer constants of size `sz`.
3366 >>> X = IntVector('x', 3)
3373 return [
Int(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3377 """Return a fresh integer constant in the given context using the given prefix.
3391 """Return a real constant named `name`. If `ctx=None`, then the global context is used.
3404 """Return a tuple of real constants.
3406 >>> x, y, z = Reals('x y z')
3409 >>> Sum(x, y, z).sort()
3413 if isinstance(names, str):
3414 names = names.split(
" ")
3415 return [
Real(name, ctx)
for name
in names]
3419 """Return a list of real constants of size `sz`.
3421 >>> X = RealVector('x', 3)
3430 return [
Real(
"%s__%s" % (prefix, i), ctx)
for i
in range(sz)]
3434 """Return a fresh real constant in the given context using the given prefix.
3448 """ Return the Z3 expression ToReal(a).
3460 if isinstance(a, BoolRef):
3463 _z3_assert(a.is_int(),
"Z3 integer expression expected.")
3468 """ Return the Z3 expression ToInt(a).
3480 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3486 """ Return the Z3 predicate IsInt(a).
3489 >>> IsInt(x + "1/2")
3491 >>> solve(IsInt(x + "1/2"), x > 0, x < 1)
3493 >>> solve(IsInt(x + "1/2"), x > 0, x < 1, x != "1/2")
3497 _z3_assert(a.is_real(),
"Z3 real expression expected.")
3503 """ Return a Z3 expression which represents the square root of a.
3516 """ Return a Z3 expression which represents the cubic root of a.
3535 """Bit-vector sort."""
3538 """Return the size (number of bits) of the bit-vector sort `self`.
3540 >>> b = BitVecSort(32)
3550 """Try to cast `val` as a Bit-Vector.
3552 >>> b = BitVecSort(32)
3555 >>> b.cast(10).sexpr()
3568 """Return True if `s` is a Z3 bit-vector sort.
3570 >>> is_bv_sort(BitVecSort(32))
3572 >>> is_bv_sort(IntSort())
3575 return isinstance(s, BitVecSortRef)
3579 """Bit-vector expressions."""
3582 """Return the sort of the bit-vector expression `self`.
3584 >>> x = BitVec('x', 32)
3587 >>> x.sort() == BitVecSort(32)
3593 """Return the number of bits of the bit-vector expression `self`.
3595 >>> x = BitVec('x', 32)
3598 >>> Concat(x, x).size()
3604 """Create the Z3 expression `self + other`.
3606 >>> x = BitVec('x', 32)
3607 >>> y = BitVec('y', 32)
3617 """Create the Z3 expression `other + self`.
3619 >>> x = BitVec('x', 32)
3627 """Create the Z3 expression `self * other`.
3629 >>> x = BitVec('x', 32)
3630 >>> y = BitVec('y', 32)
3640 """Create the Z3 expression `other * self`.
3642 >>> x = BitVec('x', 32)
3650 """Create the Z3 expression `self - other`.
3652 >>> x = BitVec('x', 32)
3653 >>> y = BitVec('y', 32)
3663 """Create the Z3 expression `other - self`.
3665 >>> x = BitVec('x', 32)
3673 """Create the Z3 expression bitwise-or `self | other`.
3675 >>> x = BitVec('x', 32)
3676 >>> y = BitVec('y', 32)
3686 """Create the Z3 expression bitwise-or `other | self`.
3688 >>> x = BitVec('x', 32)
3696 """Create the Z3 expression bitwise-and `self & other`.
3698 >>> x = BitVec('x', 32)
3699 >>> y = BitVec('y', 32)
3709 """Create the Z3 expression bitwise-or `other & self`.
3711 >>> x = BitVec('x', 32)
3719 """Create the Z3 expression bitwise-xor `self ^ other`.
3721 >>> x = BitVec('x', 32)
3722 >>> y = BitVec('y', 32)
3732 """Create the Z3 expression bitwise-xor `other ^ self`.
3734 >>> x = BitVec('x', 32)
3744 >>> x = BitVec('x', 32)
3751 """Return an expression representing `-self`.
3753 >>> x = BitVec('x', 32)
3762 """Create the Z3 expression bitwise-not `~self`.
3764 >>> x = BitVec('x', 32)
3773 """Create the Z3 expression (signed) division `self / other`.
3775 Use the function UDiv() for unsigned division.
3777 >>> x = BitVec('x', 32)
3778 >>> y = BitVec('y', 32)
3785 >>> UDiv(x, y).sexpr()
3792 """Create the Z3 expression (signed) division `self / other`."""
3796 """Create the Z3 expression (signed) division `other / self`.
3798 Use the function UDiv() for unsigned division.
3800 >>> x = BitVec('x', 32)
3803 >>> (10 / x).sexpr()
3804 '(bvsdiv #x0000000a x)'
3805 >>> UDiv(10, x).sexpr()
3806 '(bvudiv #x0000000a x)'
3812 """Create the Z3 expression (signed) division `other / self`."""
3816 """Create the Z3 expression (signed) mod `self % other`.
3818 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3820 >>> x = BitVec('x', 32)
3821 >>> y = BitVec('y', 32)
3828 >>> URem(x, y).sexpr()
3830 >>> SRem(x, y).sexpr()
3837 """Create the Z3 expression (signed) mod `other % self`.
3839 Use the function URem() for unsigned remainder, and SRem() for signed remainder.
3841 >>> x = BitVec('x', 32)
3844 >>> (10 % x).sexpr()
3845 '(bvsmod #x0000000a x)'
3846 >>> URem(10, x).sexpr()
3847 '(bvurem #x0000000a x)'
3848 >>> SRem(10, x).sexpr()
3849 '(bvsrem #x0000000a x)'
3855 """Create the Z3 expression (signed) `other <= self`.
3857 Use the function ULE() for unsigned less than or equal to.
3859 >>> x, y = BitVecs('x y', 32)
3862 >>> (x <= y).sexpr()
3864 >>> ULE(x, y).sexpr()
3871 """Create the Z3 expression (signed) `other < self`.
3873 Use the function ULT() for unsigned less than.
3875 >>> x, y = BitVecs('x y', 32)
3880 >>> ULT(x, y).sexpr()
3887 """Create the Z3 expression (signed) `other > self`.
3889 Use the function UGT() for unsigned greater than.
3891 >>> x, y = BitVecs('x y', 32)
3896 >>> UGT(x, y).sexpr()
3903 """Create the Z3 expression (signed) `other >= self`.
3905 Use the function UGE() for unsigned greater than or equal to.
3907 >>> x, y = BitVecs('x y', 32)
3910 >>> (x >= y).sexpr()
3912 >>> UGE(x, y).sexpr()
3919 """Create the Z3 expression (arithmetical) right shift `self >> other`
3921 Use the function LShR() for the right logical shift
3923 >>> x, y = BitVecs('x y', 32)
3926 >>> (x >> y).sexpr()
3928 >>> LShR(x, y).sexpr()
3932 >>> BitVecVal(4, 3).as_signed_long()
3934 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
3936 >>> simplify(BitVecVal(4, 3) >> 1)
3938 >>> simplify(LShR(BitVecVal(4, 3), 1))
3940 >>> simplify(BitVecVal(2, 3) >> 1)
3942 >>> simplify(LShR(BitVecVal(2, 3), 1))
3949 """Create the Z3 expression left shift `self << other`
3951 >>> x, y = BitVecs('x y', 32)
3954 >>> (x << y).sexpr()
3956 >>> simplify(BitVecVal(2, 3) << 1)
3963 """Create the Z3 expression (arithmetical) right shift `other` >> `self`.
3965 Use the function LShR() for the right logical shift
3967 >>> x = BitVec('x', 32)
3970 >>> (10 >> x).sexpr()
3971 '(bvashr #x0000000a x)'
3977 """Create the Z3 expression left shift `other << self`.
3979 Use the function LShR() for the right logical shift
3981 >>> x = BitVec('x', 32)
3984 >>> (10 << x).sexpr()
3985 '(bvshl #x0000000a x)'
3992 """Bit-vector values."""
3995 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
3997 >>> v = BitVecVal(0xbadc0de, 32)
4000 >>> print("0x%.8x" % v.as_long())
4006 """Return a Z3 bit-vector numeral as a Python long (bignum) numeral.
4007 The most significant bit is assumed to be the sign.
4009 >>> BitVecVal(4, 3).as_signed_long()
4011 >>> BitVecVal(7, 3).as_signed_long()
4013 >>> BitVecVal(3, 3).as_signed_long()
4015 >>> BitVecVal(2**32 - 1, 32).as_signed_long()
4017 >>> BitVecVal(2**64 - 1, 64).as_signed_long()
4022 if val >= 2**(sz - 1):
4024 if val < -2**(sz - 1):
4035 """Return the Python value of a Z3 bit-vector numeral."""
4041 """Return `True` if `a` is a Z3 bit-vector expression.
4043 >>> b = BitVec('b', 32)
4051 return isinstance(a, BitVecRef)
4055 """Return `True` if `a` is a Z3 bit-vector numeral value.
4057 >>> b = BitVec('b', 32)
4060 >>> b = BitVecVal(10, 32)
4070 """Return the Z3 expression BV2Int(a).
4072 >>> b = BitVec('b', 3)
4073 >>> BV2Int(b).sort()
4078 >>> x > BV2Int(b, is_signed=False)
4080 >>> x > BV2Int(b, is_signed=True)
4081 x > If(b < 0, BV2Int(b) - 8, BV2Int(b))
4082 >>> solve(x > BV2Int(b), b == 1, x < 3)
4086 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4093 """Return the z3 expression Int2BV(a, num_bits).
4094 It is a bit-vector of width num_bits and represents the
4095 modulo of a by 2^num_bits
4102 """Return a Z3 bit-vector sort of the given size. If `ctx=None`, then the global context is used.
4104 >>> Byte = BitVecSort(8)
4105 >>> Word = BitVecSort(16)
4108 >>> x = Const('x', Byte)
4109 >>> eq(x, BitVec('x', 8))
4117 """Return a bit-vector value with the given number of bits. If `ctx=None`, then the global context is used.
4119 >>> v = BitVecVal(10, 32)
4122 >>> print("0x%.8x" % v.as_long())
4134 """Return a bit-vector constant named `name`. `bv` may be the number of bits of a bit-vector sort.
4135 If `ctx=None`, then the global context is used.
4137 >>> x = BitVec('x', 16)
4144 >>> word = BitVecSort(16)
4145 >>> x2 = BitVec('x', word)
4149 if isinstance(bv, BitVecSortRef):
4158 """Return a tuple of bit-vector constants of size bv.
4160 >>> x, y, z = BitVecs('x y z', 16)
4167 >>> Product(x, y, z)
4169 >>> simplify(Product(x, y, z))
4173 if isinstance(names, str):
4174 names = names.split(
" ")
4175 return [
BitVec(name, bv, ctx)
for name
in names]
4179 """Create a Z3 bit-vector concatenation expression.
4181 >>> v = BitVecVal(1, 4)
4182 >>> Concat(v, v+1, v)
4183 Concat(Concat(1, 1 + 1), 1)
4184 >>> simplify(Concat(v, v+1, v))
4186 >>> print("%.3x" % simplify(Concat(v, v+1, v)).as_long())
4192 _z3_assert(sz >= 2,
"At least two arguments expected.")
4199 if is_seq(args[0])
or isinstance(args[0], str):
4202 _z3_assert(all([
is_seq(a)
for a
in args]),
"All arguments must be sequence expressions.")
4205 v[i] = args[i].as_ast()
4210 _z3_assert(all([
is_re(a)
for a
in args]),
"All arguments must be regular expressions.")
4213 v[i] = args[i].as_ast()
4217 _z3_assert(all([
is_bv(a)
for a
in args]),
"All arguments must be Z3 bit-vector expressions.")
4219 for i
in range(sz - 1):
4225 """Create a Z3 bit-vector extraction expression or sequence extraction expression.
4227 Extract is overloaded to work with both bit-vectors and sequences:
4229 **Bit-vector extraction**: Extract(high, low, bitvector)
4230 Extracts bits from position `high` down to position `low` (both inclusive).
4231 - high: int - the highest bit position to extract (0-indexed from right)
4232 - low: int - the lowest bit position to extract (0-indexed from right)
4233 - bitvector: BitVecRef - the bit-vector to extract from
4234 Returns a new bit-vector containing bits [high:low]
4236 **Sequence extraction**: Extract(sequence, offset, length)
4237 Extracts a subsequence starting at the given offset with the specified length.
4238 The functions SubString and SubSeq are redirected to this form of Extract.
4239 - sequence: SeqRef or str - the sequence to extract from
4240 - offset: int - the starting position (0-indexed)
4241 - length: int - the number of elements to extract
4242 Returns a new sequence containing the extracted subsequence
4244 >>> # Bit-vector extraction examples
4245 >>> x = BitVec('x', 8)
4246 >>> Extract(6, 2, x) # Extract bits 6 down to 2 (5 bits total)
4248 >>> Extract(6, 2, x).sort() # Result is a 5-bit vector
4250 >>> Extract(7, 0, x) # Extract all 8 bits
4252 >>> Extract(3, 3, x) # Extract single bit at position 3
4255 >>> # Sequence extraction examples
4256 >>> s = StringVal("hello")
4257 >>> Extract(s, 1, 3) # Extract 3 characters starting at position 1
4258 str.substr("hello", 1, 3)
4259 >>> simplify(Extract(StringVal("abcd"), 2, 1)) # Extract 1 character at position 2
4261 >>> simplify(Extract(StringVal("abcd"), 0, 2)) # Extract first 2 characters
4264 if isinstance(high, str):
4271 _z3_assert(low <= high,
"First argument must be greater than or equal to second argument")
4273 "First and second arguments must be non negative integers")
4274 _z3_assert(
is_bv(a),
"Third argument must be a Z3 bit-vector expression")
4280 _z3_assert(
is_bv(a)
or is_bv(b),
"First or second argument must be a Z3 bit-vector expression")
4284 """Create the Z3 expression (unsigned) `other <= self`.
4286 Use the operator <= for signed less than or equal to.
4288 >>> x, y = BitVecs('x y', 32)
4291 >>> (x <= y).sexpr()
4293 >>> ULE(x, y).sexpr()
4302 """Create the Z3 expression (unsigned) `other < self`.
4304 Use the operator < for signed less than.
4306 >>> x, y = BitVecs('x y', 32)
4311 >>> ULT(x, y).sexpr()
4320 """Create the Z3 expression (unsigned) `other >= self`.
4322 Use the operator >= for signed greater than or equal to.
4324 >>> x, y = BitVecs('x y', 32)
4327 >>> (x >= y).sexpr()
4329 >>> UGE(x, y).sexpr()
4338 """Create the Z3 expression (unsigned) `other > self`.
4340 Use the operator > for signed greater than.
4342 >>> x, y = BitVecs('x y', 32)
4347 >>> UGT(x, y).sexpr()
4356 """Create the Z3 expression (unsigned) division `self / other`.
4358 Use the operator / for signed division.
4360 >>> x = BitVec('x', 32)
4361 >>> y = BitVec('y', 32)
4364 >>> UDiv(x, y).sort()
4368 >>> UDiv(x, y).sexpr()
4377 """Create the Z3 expression (unsigned) remainder `self % other`.
4379 Use the operator % for signed modulus, and SRem() for signed remainder.
4381 >>> x = BitVec('x', 32)
4382 >>> y = BitVec('y', 32)
4385 >>> URem(x, y).sort()
4389 >>> URem(x, y).sexpr()
4398 """Create the Z3 expression signed remainder.
4400 Use the operator % for signed modulus, and URem() for unsigned remainder.
4402 >>> x = BitVec('x', 32)
4403 >>> y = BitVec('y', 32)
4406 >>> SRem(x, y).sort()
4410 >>> SRem(x, y).sexpr()
4419 """Create the Z3 expression logical right shift.
4421 Use the operator >> for the arithmetical right shift.
4423 >>> x, y = BitVecs('x y', 32)
4426 >>> (x >> y).sexpr()
4428 >>> LShR(x, y).sexpr()
4432 >>> BitVecVal(4, 3).as_signed_long()
4434 >>> simplify(BitVecVal(4, 3) >> 1).as_signed_long()
4436 >>> simplify(BitVecVal(4, 3) >> 1)
4438 >>> simplify(LShR(BitVecVal(4, 3), 1))
4440 >>> simplify(BitVecVal(2, 3) >> 1)
4442 >>> simplify(LShR(BitVecVal(2, 3), 1))
4451 """Return an expression representing `a` rotated to the left `b` times.
4453 >>> a, b = BitVecs('a b', 16)
4454 >>> RotateLeft(a, b)
4456 >>> simplify(RotateLeft(a, 0))
4458 >>> simplify(RotateLeft(a, 16))
4467 """Return an expression representing `a` rotated to the right `b` times.
4469 >>> a, b = BitVecs('a b', 16)
4470 >>> RotateRight(a, b)
4472 >>> simplify(RotateRight(a, 0))
4474 >>> simplify(RotateRight(a, 16))
4483 """Return a bit-vector expression with `n` extra sign-bits.
4485 >>> x = BitVec('x', 16)
4486 >>> n = SignExt(8, x)
4493 >>> v0 = BitVecVal(2, 2)
4498 >>> v = simplify(SignExt(6, v0))
4503 >>> print("%.x" % v.as_long())
4508 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4513 """Return a bit-vector expression with `n` extra zero-bits.
4515 >>> x = BitVec('x', 16)
4516 >>> n = ZeroExt(8, x)
4523 >>> v0 = BitVecVal(2, 2)
4528 >>> v = simplify(ZeroExt(6, v0))
4536 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4541 """Return an expression representing `n` copies of `a`.
4543 >>> x = BitVec('x', 8)
4544 >>> n = RepeatBitVec(4, x)
4549 >>> v0 = BitVecVal(10, 4)
4550 >>> print("%.x" % v0.as_long())
4552 >>> v = simplify(RepeatBitVec(4, v0))
4555 >>> print("%.x" % v.as_long())
4560 _z3_assert(
is_bv(a),
"Second argument must be a Z3 bit-vector expression")
4565 """Return the reduction-and expression of `a`."""
4567 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4572 """Return the reduction-or expression of `a`."""
4574 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4579 """A predicate the determines that bit-vector addition does not overflow"""
4586 """A predicate the determines that signed bit-vector addition does not underflow"""
4593 """A predicate the determines that bit-vector subtraction does not overflow"""
4600 """A predicate the determines that bit-vector subtraction does not underflow"""
4607 """A predicate the determines that bit-vector signed division does not overflow"""
4614 """A predicate the determines that bit-vector unary negation does not overflow"""
4616 _z3_assert(
is_bv(a),
"First argument must be a Z3 bit-vector expression")
4621 """A predicate the determines that bit-vector multiplication does not overflow"""
4628 """A predicate the determines that bit-vector signed multiplication does not underflow"""
4644 """Return the domain of the array sort `self`.
4646 >>> A = ArraySort(IntSort(), BoolSort())
4653 """Return the domain of the array sort `self`.
4658 """Return the range of the array sort `self`.
4660 >>> A = ArraySort(IntSort(), BoolSort())
4668 """Array expressions. """
4671 """Return the array sort of the array expression `self`.
4673 >>> a = Array('a', IntSort(), BoolSort())
4680 """Shorthand for `self.sort().domain()`.
4682 >>> a = Array('a', IntSort(), BoolSort())
4689 """Shorthand for self.sort().domain_n(i)`."""
4693 """Shorthand for `self.sort().range()`.
4695 >>> a = Array('a', IntSort(), BoolSort())
4702 """Return the Z3 expression `self[arg]`.
4704 >>> a = Array('a', IntSort(), BoolSort())
4718 if isinstance(arg, tuple):
4719 args = [ar.sort().domain_n(i).cast(arg[i])
for i
in range(len(arg))]
4722 arg = ar.sort().domain().cast(arg)
4731 """Return `True` if `a` is a Z3 array expression.
4733 >>> a = Array('a', IntSort(), IntSort())
4736 >>> is_array(Store(a, 0, 1))
4741 return isinstance(a, ArrayRef)
4745 """Return `True` if `a` is a Z3 constant array.
4747 >>> a = K(IntSort(), 10)
4748 >>> is_const_array(a)
4750 >>> a = Array('a', IntSort(), IntSort())
4751 >>> is_const_array(a)
4758 """Return `True` if `a` is a Z3 constant array.
4760 >>> a = K(IntSort(), 10)
4763 >>> a = Array('a', IntSort(), IntSort())
4771 """Return `True` if `a` is a Z3 map array expression.
4773 >>> f = Function('f', IntSort(), IntSort())
4774 >>> b = Array('b', IntSort(), IntSort())
4787 """Return `True` if `a` is a Z3 default array expression.
4788 >>> d = Default(K(IntSort(), 10))
4792 return is_app_of(a, Z3_OP_ARRAY_DEFAULT)
4796 """Return the function declaration associated with a Z3 map array expression.
4798 >>> f = Function('f', IntSort(), IntSort())
4799 >>> b = Array('b', IntSort(), IntSort())
4801 >>> eq(f, get_map_func(a))
4805 >>> get_map_func(a)(0)
4820 """Return the Z3 array sort with the given domain and range sorts.
4822 >>> A = ArraySort(IntSort(), BoolSort())
4829 >>> AA = ArraySort(IntSort(), A)
4831 Array(Int, Array(Int, Bool))
4835 _z3_assert(len(sig) > 1,
"At least two arguments expected")
4836 arity = len(sig) - 1
4842 _z3_assert(s.ctx == r.ctx,
"Context mismatch")
4846 dom = (Sort * arity)()
4847 for i
in range(arity):
4853 """Return an array constant named `name` with the given domain and range sorts.
4855 >>> a = Array('a', IntSort(), IntSort())
4867 """Return a Z3 store array expression.
4869 >>> a = Array('a', IntSort(), IntSort())
4870 >>> i, v = Ints('i v')
4871 >>> s = Update(a, i, v)
4874 >>> prove(s[i] == v)
4877 >>> prove(Implies(i != j, s[j] == a[j]))
4885 raise Z3Exception(
"array update requires index and value arguments")
4889 i = a.sort().domain().cast(i)
4890 v = a.sort().range().cast(v)
4892 v = a.sort().range().cast(args[-1])
4893 idxs = [a.sort().domain_n(i).cast(args[i])
for i
in range(len(args)-1)]
4899 """ Return a default value for array expression.
4900 >>> b = K(IntSort(), 1)
4901 >>> prove(Default(b) == 1)
4910 """Return a Z3 store array expression.
4912 >>> a = Array('a', IntSort(), IntSort())
4913 >>> i, v = Ints('i v')
4914 >>> s = Store(a, i, v)
4917 >>> prove(s[i] == v)
4920 >>> prove(Implies(i != j, s[j] == a[j]))
4927 """Return a Z3 select array expression.
4929 >>> a = Array('a', IntSort(), IntSort())
4933 >>> eq(Select(a, i), a[i])
4943 """Return a Z3 map array expression.
4945 >>> f = Function('f', IntSort(), IntSort(), IntSort())
4946 >>> a1 = Array('a1', IntSort(), IntSort())
4947 >>> a2 = Array('a2', IntSort(), IntSort())
4948 >>> b = Map(f, a1, a2)
4951 >>> prove(b[0] == f(a1[0], a2[0]))
4956 _z3_assert(len(args) > 0,
"At least one Z3 array expression expected")
4959 _z3_assert(len(args) == f.arity(),
"Number of arguments mismatch")
4966 """Return a Z3 constant array expression.
4968 >>> a = K(IntSort(), 10)
4988 """Return extensionality index for one-dimensional arrays.
4989 >> a, b = Consts('a b', SetSort(IntSort()))
5006 """Return `True` if `a` is a Z3 array select application.
5008 >>> a = Array('a', IntSort(), IntSort())
5019 """Return `True` if `a` is a Z3 array store application.
5021 >>> a = Array('a', IntSort(), IntSort())
5024 >>> is_store(Store(a, 0, 1))
5037 """ Create a set sort over element sort s"""
5042 """Create the empty set
5043 >>> EmptySet(IntSort())
5051 """Create the full set
5052 >>> FullSet(IntSort())
5060 """ Take the union of sets
5061 >>> a = Const('a', SetSort(IntSort()))
5062 >>> b = Const('b', SetSort(IntSort()))
5073 """ Take the union of sets
5074 >>> a = Const('a', SetSort(IntSort()))
5075 >>> b = Const('b', SetSort(IntSort()))
5076 >>> SetIntersect(a, b)
5086 """ Add element e to set s
5087 >>> a = Const('a', SetSort(IntSort()))
5097 """ Remove element e to set s
5098 >>> a = Const('a', SetSort(IntSort()))
5108 """ The complement of set s
5109 >>> a = Const('a', SetSort(IntSort()))
5110 >>> SetComplement(a)
5118 """ The set difference of a and b
5119 >>> a = Const('a', SetSort(IntSort()))
5120 >>> b = Const('b', SetSort(IntSort()))
5121 >>> SetDifference(a, b)
5129 """ Check if e is a member of set s
5130 >>> a = Const('a', SetSort(IntSort()))
5140 """ Check if a is a subset of b
5141 >>> a = Const('a', SetSort(IntSort()))
5142 >>> b = Const('b', SetSort(IntSort()))
5157 """Return `True` if acc is pair of the form (String, Datatype or Sort). """
5158 if not isinstance(acc, tuple):
5162 return isinstance(acc[0], str)
and (isinstance(acc[1], Datatype)
or is_sort(acc[1]))
5166 """Helper class for declaring Z3 datatypes.
5168 >>> List = Datatype('List')
5169 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5170 >>> List.declare('nil')
5171 >>> List = List.create()
5172 >>> # List is now a Z3 declaration
5175 >>> List.cons(10, List.nil)
5177 >>> List.cons(10, List.nil).sort()
5179 >>> cons = List.cons
5183 >>> n = cons(1, cons(0, nil))
5185 cons(1, cons(0, nil))
5186 >>> simplify(cdr(n))
5188 >>> simplify(car(n))
5204 _z3_assert(isinstance(name, str),
"String expected")
5205 _z3_assert(isinstance(rec_name, str),
"String expected")
5208 "Valid list of accessors expected. An accessor is a pair of the form (String, Datatype|Sort)",
5213 """Declare constructor named `name` with the given accessors `args`.
5214 Each accessor is a pair `(name, sort)`, where `name` is a string and `sort` a Z3 sort
5215 or a reference to the datatypes being declared.
5217 In the following example `List.declare('cons', ('car', IntSort()), ('cdr', List))`
5218 declares the constructor named `cons` that builds a new List using an integer and a List.
5219 It also declares the accessors `car` and `cdr`. The accessor `car` extracts the integer
5220 of a `cons` cell, and `cdr` the list of a `cons` cell. After all constructors were declared,
5221 we use the method create() to create the actual datatype in Z3.
5223 >>> List = Datatype('List')
5224 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5225 >>> List.declare('nil')
5226 >>> List = List.create()
5229 _z3_assert(isinstance(name, str),
"String expected")
5230 _z3_assert(name !=
"",
"Constructor name cannot be empty")
5237 """Create a Z3 datatype based on the constructors declared using the method `declare()`.
5239 The function `CreateDatatypes()` must be used to define mutually recursive datatypes.
5241 >>> List = Datatype('List')
5242 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5243 >>> List.declare('nil')
5244 >>> List = List.create()
5247 >>> List.cons(10, List.nil)
5254 """Auxiliary object used to create Z3 datatypes."""
5261 if self.
ctx.ref()
is not None and Z3_del_constructor
is not None:
5266 """Auxiliary object used to create Z3 datatypes."""
5273 if self.
ctx.ref()
is not None and Z3_del_constructor_list
is not None:
5278 """Create mutually recursive Z3 datatypes using 1 or more Datatype helper objects.
5280 In the following example we define a Tree-List using two mutually recursive datatypes.
5282 >>> TreeList = Datatype('TreeList')
5283 >>> Tree = Datatype('Tree')
5284 >>> # Tree has two constructors: leaf and node
5285 >>> Tree.declare('leaf', ('val', IntSort()))
5286 >>> # a node contains a list of trees
5287 >>> Tree.declare('node', ('children', TreeList))
5288 >>> TreeList.declare('nil')
5289 >>> TreeList.declare('cons', ('car', Tree), ('cdr', TreeList))
5290 >>> Tree, TreeList = CreateDatatypes(Tree, TreeList)
5291 >>> Tree.val(Tree.leaf(10))
5293 >>> simplify(Tree.val(Tree.leaf(10)))
5295 >>> n1 = Tree.node(TreeList.cons(Tree.leaf(10), TreeList.cons(Tree.leaf(20), TreeList.nil)))
5297 node(cons(leaf(10), cons(leaf(20), nil)))
5298 >>> n2 = Tree.node(TreeList.cons(n1, TreeList.nil))
5299 >>> simplify(n2 == n1)
5301 >>> simplify(TreeList.car(Tree.children(n2)) == n1)
5306 _z3_assert(len(ds) > 0,
"At least one Datatype must be specified")
5307 _z3_assert(all([isinstance(d, Datatype)
for d
in ds]),
"Arguments must be Datatypes")
5308 _z3_assert(all([d.ctx == ds[0].ctx
for d
in ds]),
"Context mismatch")
5309 _z3_assert(all([d.constructors != []
for d
in ds]),
"Non-empty Datatypes expected")
5312 names = (Symbol * num)()
5313 out = (Sort * num)()
5314 clists = (ConstructorList * num)()
5316 for i
in range(num):
5319 num_cs = len(d.constructors)
5320 cs = (Constructor * num_cs)()
5321 for j
in range(num_cs):
5322 c = d.constructors[j]
5327 fnames = (Symbol * num_fs)()
5328 sorts = (Sort * num_fs)()
5329 refs = (ctypes.c_uint * num_fs)()
5330 for k
in range(num_fs):
5334 if isinstance(ftype, Datatype):
5337 ds.count(ftype) == 1,
5338 "One and only one occurrence of each datatype is expected",
5341 refs[k] = ds.index(ftype)
5345 sorts[k] = ftype.ast
5354 for i
in range(num):
5356 num_cs = dref.num_constructors()
5357 for j
in range(num_cs):
5358 cref = dref.constructor(j)
5359 cref_name = cref.name()
5360 cref_arity = cref.arity()
5361 if cref.arity() == 0:
5363 setattr(dref, cref_name, cref)
5364 rref = dref.recognizer(j)
5365 setattr(dref,
"is_" + cref_name, rref)
5366 for k
in range(cref_arity):
5367 aref = dref.accessor(j, k)
5368 setattr(dref, aref.name(), aref)
5370 return tuple(result)
5374 """Datatype sorts."""
5377 """Return the number of constructors in the given Z3 datatype.
5379 >>> List = Datatype('List')
5380 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5381 >>> List.declare('nil')
5382 >>> List = List.create()
5383 >>> # List is now a Z3 declaration
5384 >>> List.num_constructors()
5390 """Return a constructor of the datatype `self`.
5392 >>> List = Datatype('List')
5393 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5394 >>> List.declare('nil')
5395 >>> List = List.create()
5396 >>> # List is now a Z3 declaration
5397 >>> List.num_constructors()
5399 >>> List.constructor(0)
5401 >>> List.constructor(1)
5409 """In Z3, each constructor has an associated recognizer predicate.
5411 If the constructor is named `name`, then the recognizer `is_name`.
5413 >>> List = Datatype('List')
5414 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5415 >>> List.declare('nil')
5416 >>> List = List.create()
5417 >>> # List is now a Z3 declaration
5418 >>> List.num_constructors()
5420 >>> List.recognizer(0)
5422 >>> List.recognizer(1)
5424 >>> simplify(List.is_nil(List.cons(10, List.nil)))
5426 >>> simplify(List.is_cons(List.cons(10, List.nil)))
5428 >>> l = Const('l', List)
5429 >>> simplify(List.is_cons(l))
5437 """In Z3, each constructor has 0 or more accessor.
5438 The number of accessors is equal to the arity of the constructor.
5440 >>> List = Datatype('List')
5441 >>> List.declare('cons', ('car', IntSort()), ('cdr', List))
5442 >>> List.declare('nil')
5443 >>> List = List.create()
5444 >>> List.num_constructors()
5446 >>> List.constructor(0)
5448 >>> num_accs = List.constructor(0).arity()
5451 >>> List.accessor(0, 0)
5453 >>> List.accessor(0, 1)
5455 >>> List.constructor(1)
5457 >>> num_accs = List.constructor(1).arity()
5471 """Datatype expressions."""
5474 """Return the datatype sort of the datatype expression `self`."""
5478 """Create a reference to a sort that was declared, or will be declared, as a recursive datatype"""
5483 """Create a named tuple sort base on a set of underlying sorts
5485 >>> pair, mk_pair, (first, second) = TupleSort("pair", [IntSort(), StringSort()])
5488 projects = [(
"project%d" % i, sorts[i])
for i
in range(len(sorts))]
5489 tuple.declare(name, *projects)
5490 tuple = tuple.create()
5491 return tuple, tuple.constructor(0), [tuple.accessor(0, i)
for i
in range(len(sorts))]
5495 """Create a named tagged union sort base on a set of underlying sorts
5497 >>> sum, ((inject0, extract0), (inject1, extract1)) = DisjointSum("+", [IntSort(), StringSort()])
5500 for i
in range(len(sorts)):
5501 sum.declare(
"inject%d" % i, (
"project%d" % i, sorts[i]))
5503 return sum, [(sum.constructor(i), sum.accessor(i, 0))
for i
in range(len(sorts))]
5507 """Return a new enumeration sort named `name` containing the given values.
5509 The result is a pair (sort, list of constants).
5511 >>> Color, (red, green, blue) = EnumSort('Color', ['red', 'green', 'blue'])
5514 _z3_assert(isinstance(name, str),
"Name must be a string")
5515 _z3_assert(all([isinstance(v, str)
for v
in values]),
"Enumeration sort values must be strings")
5516 _z3_assert(len(values) > 0,
"At least one value expected")
5519 _val_names = (Symbol * num)()
5520 for i
in range(num):
5521 _val_names[i] =
to_symbol(values[i], ctx)
5522 _values = (FuncDecl * num)()
5523 _testers = (FuncDecl * num)()
5527 for i
in range(num):
5529 V = [a()
for a
in V]
5540 """Set of parameters used to configure Solvers, Tactics and Simplifiers in Z3.
5542 Consider using the function `args2params` to create instances of this object.
5557 if self.
ctx.ref()
is not None and Z3_params_dec_ref
is not None:
5561 """Set parameter name with value val."""
5563 _z3_assert(isinstance(name, str),
"parameter name must be a string")
5565 if isinstance(val, bool):
5569 elif isinstance(val, float):
5571 elif isinstance(val, str):
5581 _z3_assert(isinstance(ds, ParamDescrsRef),
"parameter description set expected")
5586 """Convert python arguments into a Z3_params object.
5587 A ':' is added to the keywords, and '_' is replaced with '-'
5589 >>> args2params(['model', True, 'relevancy', 2], {'elim_and' : True})
5590 (params model true relevancy 2 elim_and true)
5593 _z3_assert(len(arguments) % 2 == 0,
"Argument list must have an even number of elements.")
5609 """Set of parameter descriptions for Solvers, Tactics and Simplifiers in Z3.
5613 _z3_assert(isinstance(descr, ParamDescrs),
"parameter description object expected")
5619 return ParamsDescrsRef(self.
descr, self.
ctx)
5622 if self.
ctx.ref()
is not None and Z3_param_descrs_dec_ref
is not None:
5626 """Return the size of in the parameter description `self`.
5631 """Return the size of in the parameter description `self`.
5636 """Return the i-th parameter name in the parameter description `self`.
5641 """Return the kind of the parameter named `n`.
5646 """Return the documentation string of the parameter named `n`.
5667 """Goal is a collection of constraints we want to find a solution or show to be unsatisfiable (infeasible).
5669 Goals are processed using Tactics. A Tactic transforms a goal into a set of subgoals.
5670 A goal has a solution if one of its subgoals has a solution.
5671 A goal is unsatisfiable if all subgoals are unsatisfiable.
5674 def __init__(self, models=True, unsat_cores=False, proofs=False, ctx=None, goal=None):
5677 "If goal is different from None, then ctx must be also different from None")
5680 if self.
goal is None:
5685 if self.
goal is not None and self.
ctx.ref()
is not None and Z3_goal_dec_ref
is not None:
5689 """Return the depth of the goal `self`.
5690 The depth corresponds to the number of tactics applied to `self`.
5692 >>> x, y = Ints('x y')
5694 >>> g.add(x == 0, y >= x + 1)
5697 >>> r = Then('simplify', 'solve-eqs')(g)
5698 >>> # r has 1 subgoal
5707 """Return `True` if `self` contains the `False` constraints.
5709 >>> x, y = Ints('x y')
5711 >>> g.inconsistent()
5713 >>> g.add(x == 0, x == 1)
5716 >>> g.inconsistent()
5718 >>> g2 = Tactic('propagate-values')(g)[0]
5719 >>> g2.inconsistent()
5725 """Return the precision (under-approximation, over-approximation, or precise) of the goal `self`.
5728 >>> g.prec() == Z3_GOAL_PRECISE
5730 >>> x, y = Ints('x y')
5731 >>> g.add(x == y + 1)
5732 >>> g.prec() == Z3_GOAL_PRECISE
5734 >>> t = With(Tactic('add-bounds'), add_bound_lower=0, add_bound_upper=10)
5737 [x == y + 1, x <= 10, x >= 0, y <= 10, y >= 0]
5738 >>> g2.prec() == Z3_GOAL_PRECISE
5740 >>> g2.prec() == Z3_GOAL_UNDER
5746 """Alias for `prec()`.
5749 >>> g.precision() == Z3_GOAL_PRECISE
5755 """Return the number of constraints in the goal `self`.
5760 >>> x, y = Ints('x y')
5761 >>> g.add(x == 0, y > x)
5768 """Return the number of constraints in the goal `self`.
5773 >>> x, y = Ints('x y')
5774 >>> g.add(x == 0, y > x)
5781 """Return a constraint in the goal `self`.
5784 >>> x, y = Ints('x y')
5785 >>> g.add(x == 0, y > x)
5794 """Return a constraint in the goal `self`.
5797 >>> x, y = Ints('x y')
5798 >>> g.add(x == 0, y > x)
5804 if arg >= len(self):
5806 return self.
get(arg)
5809 """Assert constraints into the goal.
5813 >>> g.assert_exprs(x > 0, x < 2)
5828 >>> g.append(x > 0, x < 2)
5839 >>> g.insert(x > 0, x < 2)
5850 >>> g.add(x > 0, x < 2)
5857 """Retrieve model from a satisfiable goal
5858 >>> a, b = Ints('a b')
5860 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
5861 >>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
5864 [Or(b == 0, b == 1), Not(0 <= b)]
5866 [Or(b == 0, b == 1), Not(1 <= b)]
5867 >>> # Remark: the subgoal r[0] is unsatisfiable
5868 >>> # Creating a solver for solving the second subgoal
5875 >>> # Model s.model() does not assign a value to `a`
5876 >>> # It is a model for subgoal `r[1]`, but not for goal `g`
5877 >>> # The method convert_model creates a model for `g` from a model for `r[1]`.
5878 >>> r[1].convert_model(s.model())
5882 _z3_assert(isinstance(model, ModelRef),
"Z3 Model expected")
5886 return obj_to_string(self)
5889 """Return a textual representation of the s-expression representing the goal."""
5893 """Return a textual representation of the goal in DIMACS format."""
5897 """Copy goal `self` to context `target`.
5905 >>> g2 = g.translate(c2)
5908 >>> g.ctx == main_ctx()
5912 >>> g2.ctx == main_ctx()
5916 _z3_assert(isinstance(target, Context),
"target must be a context")
5926 """Return a new simplified goal.
5928 This method is essentially invoking the simplify tactic.
5932 >>> g.add(x + 1 >= 2)
5935 >>> g2 = g.simplify()
5938 >>> # g was not modified
5943 return t.apply(self, *arguments, **keywords)[0]
5946 """Return goal `self` as a single Z3 expression.
5965 return And([self.
get(i)
for i
in range(len(self))], self.
ctx)
5975 """A collection (vector) of ASTs."""
5984 assert ctx
is not None
5989 if self.
vector is not None and self.
ctx.ref()
is not None and Z3_ast_vector_dec_ref
is not None:
5993 """Return the size of the vector `self`.
5998 >>> A.push(Int('x'))
5999 >>> A.push(Int('x'))
6006 """Return the AST at position `i`.
6009 >>> A.push(Int('x') + 1)
6010 >>> A.push(Int('y'))
6017 if isinstance(i, int):
6025 elif isinstance(i, slice):
6027 for ii
in range(*i.indices(self.
__len__())):
6035 """Update AST at position `i`.
6038 >>> A.push(Int('x') + 1)
6039 >>> A.push(Int('y'))
6051 """Add `v` in the end of the vector.
6056 >>> A.push(Int('x'))
6063 """Resize the vector to `sz` elements.
6069 >>> for i in range(10): A[i] = Int('x')
6076 """Return `True` if the vector contains `item`.
6099 """Copy vector `self` to context `other_ctx`.
6105 >>> B = A.translate(c2)
6121 return obj_to_string(self)
6124 """Return a textual representation of the s-expression representing the vector."""
6135 """A mapping from ASTs to ASTs."""
6144 assert ctx
is not None
6152 if self.
map is not None and self.
ctx.ref()
is not None and Z3_ast_map_dec_ref
is not None:
6156 """Return the size of the map.
6162 >>> M[x] = IntVal(1)
6169 """Return `True` if the map contains key `key`.
6182 """Retrieve the value associated with key `key`.
6193 """Add/Update key `k` with value `v`.
6202 >>> M[x] = IntVal(1)
6212 """Remove the entry associated with key `k`.
6226 """Remove all entries from the map.
6231 >>> M[x+x] = IntVal(1)
6241 """Return an AstVector containing all keys in the map.
6246 >>> M[x+x] = IntVal(1)
6260 """Store the value of the interpretation of a function in a particular point."""
6271 if self.
ctx.ref()
is not None and Z3_func_entry_dec_ref
is not None:
6275 """Return the number of arguments in the given entry.
6277 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6279 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6284 >>> f_i.num_entries()
6286 >>> e = f_i.entry(0)
6293 """Return the value of argument `idx`.
6295 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6297 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6302 >>> f_i.num_entries()
6304 >>> e = f_i.entry(0)
6315 ... except IndexError:
6316 ... print("index error")
6324 """Return the value of the function at point `self`.
6326 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6328 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6333 >>> f_i.num_entries()
6335 >>> e = f_i.entry(0)
6346 """Return entry `self` as a Python list.
6347 >>> f = Function('f', IntSort(), IntSort(), IntSort())
6349 >>> s.add(f(0, 1) == 10, f(1, 2) == 20, f(1, 0) == 10)
6354 >>> f_i.num_entries()
6356 >>> e = f_i.entry(0)
6361 args.append(self.
value())
6369 """Stores the interpretation of a function in a Z3 model."""
6374 if self.
f is not None:
6378 if self.
f is not None and self.
ctx.ref()
is not None and Z3_func_interp_dec_ref
is not None:
6383 Return the `else` value for a function interpretation.
6384 Return None if Z3 did not specify the `else` value for
6387 >>> f = Function('f', IntSort(), IntSort())
6389 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6395 >>> m[f].else_value()
6405 """Return the number of entries/points in the function interpretation `self`.
6407 >>> f = Function('f', IntSort(), IntSort())
6409 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6415 >>> m[f].num_entries()
6421 """Return the number of arguments for each entry in the function interpretation `self`.
6423 >>> f = Function('f', IntSort(), IntSort())
6425 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6435 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6437 >>> f = Function('f', IntSort(), IntSort())
6439 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6445 >>> m[f].num_entries()
6455 """Copy model 'self' to context 'other_ctx'.
6466 """Return the function interpretation as a Python list.
6467 >>> f = Function('f', IntSort(), IntSort())
6469 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6483 return obj_to_string(self)
6487 """Model/Solution of a satisfiability problem (aka system of constraints)."""
6490 assert ctx
is not None
6496 if self.
ctx.ref()
is not None and Z3_model_dec_ref
is not None:
6500 return obj_to_string(self)
6503 """Return a textual representation of the s-expression representing the model."""
6506 def eval(self, t, model_completion=False):
6507 """Evaluate the expression `t` in the model `self`.
6508 If `model_completion` is enabled, then a default interpretation is automatically added
6509 for symbols that do not have an interpretation in the model `self`.
6513 >>> s.add(x > 0, x < 2)
6526 >>> m.eval(y, model_completion=True)
6528 >>> # Now, m contains an interpretation for y
6535 raise Z3Exception(
"failed to evaluate expression in the model")
6538 """Alias for `eval`.
6542 >>> s.add(x > 0, x < 2)
6546 >>> m.evaluate(x + 1)
6548 >>> m.evaluate(x == 1)
6551 >>> m.evaluate(y + x)
6555 >>> m.evaluate(y, model_completion=True)
6557 >>> # Now, m contains an interpretation for y
6558 >>> m.evaluate(y + x)
6561 return self.
eval(t, model_completion)
6564 """Return the number of constant and function declarations in the model `self`.
6566 >>> f = Function('f', IntSort(), IntSort())
6569 >>> s.add(x > 0, f(x) != x)
6578 return num_consts + num_funcs
6581 """Return the interpretation for a given declaration or constant.
6583 >>> f = Function('f', IntSort(), IntSort())
6586 >>> s.add(x > 0, x < 2, f(x) == 0)
6596 _z3_assert(isinstance(decl, FuncDeclRef)
or is_const(decl),
"Z3 declaration expected")
6600 if decl.arity() == 0:
6602 if _r.value
is None:
6618 sz = fi.num_entries()
6622 e =
Store(e, fe.arg_value(0), fe.value())
6633 """Return the number of uninterpreted sorts that contain an interpretation in the model `self`.
6635 >>> A = DeclareSort('A')
6636 >>> a, b = Consts('a b', A)
6648 """Return the uninterpreted sort at position `idx` < self.num_sorts().
6650 >>> A = DeclareSort('A')
6651 >>> B = DeclareSort('B')
6652 >>> a1, a2 = Consts('a1 a2', A)
6653 >>> b1, b2 = Consts('b1 b2', B)
6655 >>> s.add(a1 != a2, b1 != b2)
6671 """Return all uninterpreted sorts that have an interpretation in the model `self`.
6673 >>> A = DeclareSort('A')
6674 >>> B = DeclareSort('B')
6675 >>> a1, a2 = Consts('a1 a2', A)
6676 >>> b1, b2 = Consts('b1 b2', B)
6678 >>> s.add(a1 != a2, b1 != b2)
6688 """Return the interpretation for the uninterpreted sort `s` in the model `self`.
6690 >>> A = DeclareSort('A')
6691 >>> a, b = Consts('a b', A)
6697 >>> m.get_universe(A)
6701 _z3_assert(isinstance(s, SortRef),
"Z3 sort expected")
6708 """If `idx` is an integer, then the declaration at position `idx` in the model `self` is returned.
6709 If `idx` is a declaration, then the actual interpretation is returned.
6711 The elements can be retrieved using position or the actual declaration.
6713 >>> f = Function('f', IntSort(), IntSort())
6716 >>> s.add(x > 0, x < 2, f(x) == 0)
6730 >>> for d in m: print("%s -> %s" % (d, m[d]))
6735 if idx >= len(self):
6738 if (idx < num_consts):
6742 if isinstance(idx, FuncDeclRef):
6746 if isinstance(idx, SortRef):
6749 _z3_assert(
False,
"Integer, Z3 declaration, or Z3 constant expected")
6753 """Return a list with all symbols that have an interpretation in the model `self`.
6754 >>> f = Function('f', IntSort(), IntSort())
6757 >>> s.add(x > 0, x < 2, f(x) == 0)
6772 """Update the interpretation of a constant"""
6775 if is_func_decl(x)
and x.arity() != 0
and isinstance(value, FuncInterp):
6779 for i
in range(value.num_entries()):
6784 v.push(e.arg_value(j))
6789 raise Z3Exception(
"Expecting 0-ary function or constant expression")
6794 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
6797 _z3_assert(isinstance(target, Context),
"argument must be a Z3 context")
6802 """Perform model-based projection on fml with respect to vars.
6803 Assume that the model satisfies fml. Then compute a projection fml_p, such
6804 that vars do not occur free in fml_p, fml_p is true in the model and
6805 fml_p => exists vars . fml
6807 ctx = self.
ctx.ref()
6808 _vars = (Ast * len(vars))()
6809 for i
in range(len(vars)):
6810 _vars[i] = vars[i].as_ast()
6814 """Perform model-based projection, but also include realizer terms for the projected variables"""
6815 ctx = self.
ctx.ref()
6816 _vars = (Ast * len(vars))()
6817 for i
in range(len(vars)):
6818 _vars[i] = vars[i].as_ast()
6820 result = Z3_qe_model_project_with_witness(ctx, self.
model, len(vars), _vars, fml.ast, defs.map)
6835 for k, v
in eval.items():
6836 mdl.update_value(k, v)
6841 """Return true if n is a Z3 expression of the form (_ as-array f)."""
6842 return isinstance(n, ExprRef)
and Z3_is_as_array(n.ctx.ref(), n.as_ast())
6846 """Return the function declaration f associated with a Z3 expression of the form (_ as-array f)."""
6859 """Statistics for `Solver.check()`."""
6870 if self.
ctx.ref()
is not None and Z3_stats_dec_ref
is not None:
6877 out.write(u(
'<table border="1" cellpadding="2" cellspacing="0">'))
6880 out.write(u(
'<tr style="background-color:#CFCFCF">'))
6883 out.write(u(
"<tr>"))
6885 out.write(u(
"<td>%s</td><td>%s</td></tr>" % (k, v)))
6886 out.write(u(
"</table>"))
6887 return out.getvalue()
6892 """Return the number of statistical counters.
6895 >>> s = Then('simplify', 'nlsat').solver()
6899 >>> st = s.statistics()
6906 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6909 >>> s = Then('simplify', 'nlsat').solver()
6913 >>> st = s.statistics()
6917 ('nlsat propagations', 2)
6919 ('nlsat restarts', 1)
6921 if idx >= len(self):
6930 """Return the list of statistical counters.
6933 >>> s = Then('simplify', 'nlsat').solver()
6937 >>> st = s.statistics()
6942 """Return the value of a particular statistical counter.
6945 >>> s = Then('simplify', 'nlsat').solver()
6949 >>> st = s.statistics()
6950 >>> st.get_key_value('nlsat propagations')
6953 for idx
in range(len(self)):
6959 raise Z3Exception(
"unknown key")
6962 """Access the value of statistical using attributes.
6964 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
6965 we should use '_' (e.g., 'nlsat_propagations').
6968 >>> s = Then('simplify', 'nlsat').solver()
6972 >>> st = s.statistics()
6973 >>> st.nlsat_propagations
6978 key = name.replace(
"_",
" ")
6982 raise AttributeError
6992 """Represents the result of a satisfiability check: sat, unsat, unknown.
6998 >>> isinstance(r, CheckSatResult)
7009 return isinstance(other, CheckSatResult)
and self.
r == other.r
7012 return not self.
__eq__(other)
7016 if self.
r == Z3_L_TRUE:
7018 elif self.
r == Z3_L_FALSE:
7019 return "<b>unsat</b>"
7021 return "<b>unknown</b>"
7023 if self.
r == Z3_L_TRUE:
7025 elif self.
r == Z3_L_FALSE:
7031 in_html = in_html_mode()
7034 set_html_mode(in_html)
7045 Solver API provides methods for implementing the main SMT 2.0 commands:
7046 push, pop, check, get-model, etc.
7049 def __init__(self, solver=None, ctx=None, logFile=None):
7050 assert solver
is None or ctx
is not None
7059 if logFile
is not None:
7060 self.
set(
"smtlib2_log", logFile)
7063 if self.
solver is not None and self.
ctx.ref()
is not None and Z3_solver_dec_ref
is not None:
7074 """Set a configuration option.
7075 The method `help()` return a string containing all available options.
7078 >>> # The option MBQI can be set using three different approaches.
7079 >>> s.set(mbqi=True)
7080 >>> s.set('MBQI', True)
7081 >>> s.set(':mbqi', True)
7087 """Create a backtracking point.
7109 """Backtrack \\c num backtracking points.
7131 """Return the current number of backtracking points.
7149 """Remove all asserted constraints and backtracking points created using `push()`.
7163 """Assert constraints into the solver.
7167 >>> s.assert_exprs(x > 0, x < 2)
7174 if isinstance(arg, Goal)
or isinstance(arg, AstVector):
7182 """Assert constraints into the solver.
7186 >>> s.add(x > 0, x < 2)
7197 """Assert constraints into the solver.
7201 >>> s.append(x > 0, x < 2)
7208 """Assert constraints into the solver.
7212 >>> s.insert(x > 0, x < 2)
7219 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
7221 If `p` is a string, it will be automatically converted into a Boolean constant.
7226 >>> s.set(unsat_core=True)
7227 >>> s.assert_and_track(x > 0, 'p1')
7228 >>> s.assert_and_track(x != 1, 'p2')
7229 >>> s.assert_and_track(x < 0, p3)
7230 >>> print(s.check())
7232 >>> c = s.unsat_core()
7242 if isinstance(p, str):
7244 _z3_assert(isinstance(a, BoolRef),
"Boolean expression expected")
7249 """Check whether the assertions in the given solver plus the optional assumptions are consistent or not.
7255 >>> s.add(x > 0, x < 2)
7258 >>> s.model().eval(x)
7264 >>> s.add(2**x == 4)
7270 num = len(assumptions)
7271 _assumptions = (Ast * num)()
7272 for i
in range(num):
7273 _assumptions[i] = s.cast(assumptions[i]).as_ast()
7278 """Return a model for the last `check()`.
7280 This function raises an exception if
7281 a model is not available (e.g., last `check()` returned unsat).
7285 >>> s.add(a + 2 == 0)
7294 raise Z3Exception(
"model is not available")
7297 """Import model converter from other into the current solver"""
7298 Z3_solver_import_model_converter(self.ctx.ref(), other.solver, self.solver)
7300 def interrupt(self):
7301 """Interrupt the execution of the solver object.
7302 Remarks: This ensures that the interrupt applies only
7303 to the given solver object and it applies only if it is running.
7305 Z3_solver_interrupt(self.ctx.ref(), self.solver)
7307 def unsat_core(self):
7308 """Return a subset (as an AST vector) of the assumptions provided to the last check().
7310 These are the assumptions Z3 used in the unsatisfiability proof.
7311 Assumptions are available in Z3. They are used to extract unsatisfiable cores.
7312 They may be also used to "retract" assumptions. Note that, assumptions are not really
7313 "soft constraints", but they can be used to implement them.
7315 >>> p1, p2, p3 = Bools('p1 p2 p3')
7316 >>> x, y = Ints('x y')
7318 >>> s.add(Implies(p1, x > 0))
7319 >>> s.add(Implies(p2, y > x))
7320 >>> s.add(Implies(p2, y < 1))
7321 >>> s.add(Implies(p3, y > -3))
7322 >>> s.check(p1, p2, p3)
7324 >>> core = s.unsat_core()
7333 >>> # "Retracting" p2
7337 return AstVector(Z3_solver_get_unsat_core(self.ctx.ref(), self.solver), self.ctx)
7339 def consequences(self, assumptions, variables):
7340 """Determine fixed values for the variables based on the solver state and assumptions.
7342 >>> a, b, c, d = Bools('a b c d')
7343 >>> s.add(Implies(a,b), Implies(b, c))
7344 >>> s.consequences([a],[b,c,d])
7345 (sat, [Implies(a, b), Implies(a, c)])
7346 >>> s.consequences([Not(c),d],[a,b,c,d])
7347 (sat, [Implies(d, d), Implies(Not(c), Not(c)), Implies(Not(c), Not(b)), Implies(Not(c), Not(a))])
7349 if isinstance(assumptions, list):
7350 _asms = AstVector(None, self.ctx)
7351 for a in assumptions:
7354 if isinstance(variables, list):
7355 _vars = AstVector(None, self.ctx)
7359 _z3_assert(isinstance(assumptions, AstVector), "ast vector expected")
7360 _z3_assert(isinstance(variables, AstVector), "ast vector expected")
7361 consequences = AstVector(None, self.ctx)
7362 r = Z3_solver_get_consequences(self.ctx.ref(), self.solver, assumptions.vector,
7363 variables.vector, consequences.vector)
7364 sz = len(consequences)
7365 consequences = [consequences[i] for i in range(sz)]
7366 return CheckSatResult(r), consequences
7368 def from_file(self, filename):
7369 """Parse assertions from a file"""
7370 Z3_solver_from_file(self.ctx.ref(), self.solver, filename)
7372 def from_string(self, s):
7373 """Parse assertions from a string"""
7374 Z3_solver_from_string(self.ctx.ref(), self.solver, s)
7376 def cube(self, vars=None):
7378 The method takes an optional set of variables that restrict which
7379 variables may be used as a starting point for cubing.
7380 If vars is not None, then the first case split is based on a variable in
7383 self.cube_vs = AstVector(None, self.ctx)
7384 if vars is not None:
7386 self.cube_vs.push(v)
7388 lvl = self.backtrack_level
7389 self.backtrack_level = 4000000000
7390 r = AstVector(Z3_solver_cube(self.ctx.ref(), self.solver, self.cube_vs.vector, lvl), self.ctx)
7391 if (len(r) == 1 and is_false(r[0])):
7397 def cube_vars(self):
7398 """Access the set of variables that were touched by the most recently generated cube.
7399 This set of variables can be used as a starting point for additional cubes.
7400 The idea is that variables that appear in clauses that are reduced by the most recent
7401 cube are likely more useful to cube on."""
7405 """Retrieve congruence closure root of the term t relative to the current search state
7406 The function primarily works for SimpleSolver. Terms and variables that are
7407 eliminated during pre-processing are not visible to the congruence closure.
7409 t = _py2expr(t, self.ctx)
7410 return _to_expr_ref(Z3_solver_congruence_root(self.ctx.ref(), self.solver, t.ast), self.ctx)
7413 """Retrieve congruence closure sibling of the term t relative to the current search state
7414 The function primarily works for SimpleSolver. Terms and variables that are
7415 eliminated during pre-processing are not visible to the congruence closure.
7417 t = _py2expr(t, self.ctx)
7418 return _to_expr_ref(Z3_solver_congruence_next(self.ctx.ref(), self.solver, t.ast), self.ctx)
7420 def explain_congruent(self, a, b):
7421 """Explain congruence of a and b relative to the current search state"""
7422 a = _py2expr(a, self.ctx)
7423 b = _py2expr(b, self.ctx)
7424 return _to_expr_ref(Z3_solver_congruence_explain(self.ctx.ref(), self.solver, a.ast, b.ast), self.ctx)
7427 def solve_for(self, ts):
7428 """Retrieve a solution for t relative to linear equations maintained in the current state."""
7429 vars = AstVector(ctx=self.ctx);
7430 terms = AstVector(ctx=self.ctx);
7431 guards = AstVector(ctx=self.ctx);
7433 t = _py2expr(t, self.ctx)
7435 Z3_solver_solve_for(self.ctx.ref(), self.solver, vars.vector, terms.vector, guards.vector)
7436 return [(vars[i], terms[i], guards[i]) for i in range(len(vars))]
7440 """Return a proof for the last `check()`. Proof construction must be enabled."""
7441 return _to_expr_ref(Z3_solver_get_proof(self.ctx.ref(), self.solver), self.ctx)
7443 def assertions(self):
7444 """Return an AST vector containing all added constraints.
7455 return AstVector(Z3_solver_get_assertions(self.ctx.ref(), self.solver), self.ctx)
7458 """Return an AST vector containing all currently inferred units.
7460 return AstVector(Z3_solver_get_units(self.ctx.ref(), self.solver), self.ctx)
7462 def non_units(self):
7463 """Return an AST vector containing all atomic formulas in solver state that are not units.
7465 return AstVector(Z3_solver_get_non_units(self.ctx.ref(), self.solver), self.ctx)
7467 def trail_levels(self):
7468 """Return trail and decision levels of the solver state after a check() call.
7470 trail = self.trail()
7471 levels = (ctypes.c_uint * len(trail))()
7472 Z3_solver_get_levels(self.ctx.ref(), self.solver, trail.vector, len(trail), levels)
7473 return trail, levels
7475 def set_initial_value(self, var, value):
7476 """initialize the solver's state by setting the initial value of var to value
7479 value = s.cast(value)
7480 Z3_solver_set_initial_value(self.ctx.ref(), self.solver, var.ast, value.ast)
7483 """Return trail of the solver state after a check() call.
7485 return AstVector(Z3_solver_get_trail(self.ctx.ref(), self.solver), self.ctx)
7487 def statistics(self):
7488 """Return statistics for the last `check()`.
7490 >>> s = SimpleSolver()
7495 >>> st = s.statistics()
7496 >>> st.get_key_value('final checks')
7503 return Statistics(Z3_solver_get_statistics(self.ctx.ref(), self.solver), self.ctx)
7505 def reason_unknown(self):
7506 """Return a string describing why the last `check()` returned `unknown`.
7509 >>> s = SimpleSolver()
7510 >>> s.add(2**x == 4)
7513 >>> s.reason_unknown()
7514 '(incomplete (theory arithmetic))'
7516 return Z3_solver_get_reason_unknown(self.ctx.ref(), self.solver)
7519 """Display a string describing all available options."""
7520 print(Z3_solver_get_help(self.ctx.ref(), self.solver))
7522 def param_descrs(self):
7523 """Return the parameter description set."""
7524 return ParamDescrsRef(Z3_solver_get_param_descrs(self.ctx.ref(), self.solver), self.ctx)
7527 """Return a formatted string with all added constraints."""
7528 return obj_to_string(self)
7530 def translate(self, target):
7531 """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
7535 >>> s1 = Solver(ctx=c1)
7536 >>> s2 = s1.translate(c2)
7539 _z3_assert(isinstance(target, Context), "argument must be a Z3 context")
7540 solver = Z3_solver_translate(self.ctx.ref(), self.solver, target.ref())
7541 return Solver(solver, target)
7544 return self.translate(self.ctx)
7546 def __deepcopy__(self, memo={}):
7547 return self.translate(self.ctx)
7550 """Return a formatted string (in Lisp-like format) with all added constraints.
7551 We say the string is in s-expression format.
7559 return Z3_solver_to_string(self.ctx.ref(), self.solver)
7561 def dimacs(self, include_names=True):
7562 """Return a textual representation of the solver in DIMACS format."""
7563 return Z3_solver_to_dimacs_string(self.ctx.ref(), self.solver, include_names)
7566 """return SMTLIB2 formatted benchmark for solver's assertions"""
7567 es = self.assertions()
7573 for i in range(sz1):
7574 v[i] = es[i].as_ast()
7576 e = es[sz1].as_ast()
7578 e = BoolVal(True, self.ctx).as_ast()
7579 return Z3_benchmark_to_smtlib_string(
7580 self.ctx.ref(), "benchmark generated from python API", "", "unknown", "", sz1, v, e,
7584def SolverFor(logic, ctx=None, logFile=None):
7585 """Create a solver customized for the given logic.
7587 The parameter `logic` is a string. It should be contains
7588 the name of a SMT-LIB logic.
7589 See http://www.smtlib.org/ for the name of all available logics.
7591 >>> s = SolverFor("QF_LIA")
7601 logic = to_symbol(logic)
7602 return Solver(Z3_mk_solver_for_logic(ctx.ref(), logic), ctx, logFile)
7605def SimpleSolver(ctx=None, logFile=None):
7606 """Return a simple general purpose solver with limited amount of preprocessing.
7608 >>> s = SimpleSolver()
7615 return Solver(Z3_mk_simple_solver(ctx.ref()), ctx, logFile)
7617#########################################
7621#########################################
7624class Fixedpoint(Z3PPObject):
7625 """Fixedpoint API provides methods for solving with recursive predicates"""
7627 def __init__(self, fixedpoint=None, ctx=None):
7628 assert fixedpoint is None or ctx is not None
7629 self.ctx = _get_ctx(ctx)
7630 self.fixedpoint = None
7631 if fixedpoint is None:
7632 self.fixedpoint = Z3_mk_fixedpoint(self.ctx.ref())
7634 self.fixedpoint = fixedpoint
7635 Z3_fixedpoint_inc_ref(self.ctx.ref(), self.fixedpoint)
7638 def __deepcopy__(self, memo={}):
7639 return FixedPoint(self.fixedpoint, self.ctx)
7642 if self.fixedpoint is not None and self.ctx.ref() is not None and Z3_fixedpoint_dec_ref is not None:
7643 Z3_fixedpoint_dec_ref(self.ctx.ref(), self.fixedpoint)
7645 def set(self, *args, **keys):
7646 """Set a configuration option. The method `help()` return a string containing all available options.
7648 p = args2params(args, keys, self.ctx)
7649 Z3_fixedpoint_set_params(self.ctx.ref(), self.fixedpoint, p.params)
7652 """Display a string describing all available options."""
7653 print(Z3_fixedpoint_get_help(self.ctx.ref(), self.fixedpoint))
7655 def param_descrs(self):
7656 """Return the parameter description set."""
7657 return ParamDescrsRef(Z3_fixedpoint_get_param_descrs(self.ctx.ref(), self.fixedpoint), self.ctx)
7659 def assert_exprs(self, *args):
7660 """Assert constraints as background axioms for the fixedpoint solver."""
7661 args = _get_args(args)
7662 s = BoolSort(self.ctx)
7664 if isinstance(arg, Goal) or isinstance(arg, AstVector):
7666 f = self.abstract(f)
7667 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, f.as_ast())
7670 arg = self.abstract(arg)
7671 Z3_fixedpoint_assert(self.ctx.ref(), self.fixedpoint, arg.as_ast())
7673 def add(self, *args):
7674 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7675 self.assert_exprs(*args)
7677 def __iadd__(self, fml):
7681 def append(self, *args):
7682 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7683 self.assert_exprs(*args)
7685 def insert(self, *args):
7686 """Assert constraints as background axioms for the fixedpoint solver. Alias for assert_expr."""
7687 self.assert_exprs(*args)
7689 def add_rule(self, head, body=None, name=None):
7690 """Assert rules defining recursive predicates to the fixedpoint solver.
7693 >>> s = Fixedpoint()
7694 >>> s.register_relation(a.decl())
7695 >>> s.register_relation(b.decl())
7703 name = to_symbol(name, self.ctx)
7705 head = self.abstract(head)
7706 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, head.as_ast(), name)
7708 body = _get_args(body)
7709 f = self.abstract(Implies(And(body, self.ctx), head))
7710 Z3_fixedpoint_add_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7712 def rule(self, head, body=None, name=None):
7713 """Assert rules defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7714 self.add_rule(head, body, name)
7716 def fact(self, head, name=None):
7717 """Assert facts defining recursive predicates to the fixedpoint solver. Alias for add_rule."""
7718 self.add_rule(head, None, name)
7720 def query(self, *query):
7721 """Query the fixedpoint engine whether formula is derivable.
7722 You can also pass an tuple or list of recursive predicates.
7724 query = _get_args(query)
7726 if sz >= 1 and isinstance(query[0], FuncDeclRef):
7727 _decls = (FuncDecl * sz)()
7732 r = Z3_fixedpoint_query_relations(self.ctx.ref(), self.fixedpoint, sz, _decls)
7737 query = And(query, self.ctx)
7738 query = self.abstract(query, False)
7739 r = Z3_fixedpoint_query(self.ctx.ref(), self.fixedpoint, query.as_ast())
7740 return CheckSatResult(r)
7742 def query_from_lvl(self, lvl, *query):
7743 """Query the fixedpoint engine whether formula is derivable starting at the given query level.
7745 query = _get_args(query)
7747 if sz >= 1 and isinstance(query[0], FuncDecl):
7748 _z3_assert(False, "unsupported")
7754 query = self.abstract(query, False)
7755 r = Z3_fixedpoint_query_from_lvl(self.ctx.ref(), self.fixedpoint, query.as_ast(), lvl)
7756 return CheckSatResult(r)
7758 def update_rule(self, head, body, name):
7762 name = to_symbol(name, self.ctx)
7763 body = _get_args(body)
7764 f = self.abstract(Implies(And(body, self.ctx), head))
7765 Z3_fixedpoint_update_rule(self.ctx.ref(), self.fixedpoint, f.as_ast(), name)
7767 def get_answer(self):
7768 """Retrieve answer from last query call."""
7769 r = Z3_fixedpoint_get_answer(self.ctx.ref(), self.fixedpoint)
7770 return _to_expr_ref(r, self.ctx)
7772 def get_ground_sat_answer(self):
7773 """Retrieve a ground cex from last query call."""
7774 r = Z3_fixedpoint_get_ground_sat_answer(self.ctx.ref(), self.fixedpoint)
7775 return _to_expr_ref(r, self.ctx)
7777 def get_rules_along_trace(self):
7778 """retrieve rules along the counterexample trace"""
7779 return AstVector(Z3_fixedpoint_get_rules_along_trace(self.ctx.ref(), self.fixedpoint), self.ctx)
7781 def get_rule_names_along_trace(self):
7782 """retrieve rule names along the counterexample trace"""
7783 # this is a hack as I don't know how to return a list of symbols from C++;
7784 # obtain names as a single string separated by semicolons
7785 names = _symbol2py(self.ctx, Z3_fixedpoint_get_rule_names_along_trace(self.ctx.ref(), self.fixedpoint))
7786 # split into individual names
7787 return names.split(";")
7789 def get_num_levels(self, predicate):
7790 """Retrieve number of levels used for predicate in PDR engine"""
7791 return Z3_fixedpoint_get_num_levels(self.ctx.ref(), self.fixedpoint, predicate.ast)
7793 def get_cover_delta(self, level, predicate):
7794 """Retrieve properties known about predicate for the level'th unfolding.
7795 -1 is treated as the limit (infinity)
7797 r = Z3_fixedpoint_get_cover_delta(self.ctx.ref(), self.fixedpoint, level, predicate.ast)
7798 return _to_expr_ref(r, self.ctx)
7800 def add_cover(self, level, predicate, property):
7801 """Add property to predicate for the level'th unfolding.
7802 -1 is treated as infinity (infinity)
7804 Z3_fixedpoint_add_cover(self.ctx.ref(), self.fixedpoint, level, predicate.ast, property.ast)
7806 def register_relation(self, *relations):
7807 """Register relation as recursive"""
7808 relations = _get_args(relations)
7810 Z3_fixedpoint_register_relation(self.ctx.ref(), self.fixedpoint, f.ast)
7812 def set_predicate_representation(self, f, *representations):
7813 """Control how relation is represented"""
7814 representations = _get_args(representations)
7815 representations = [to_symbol(s) for s in representations]
7816 sz = len(representations)
7817 args = (Symbol * sz)()
7819 args[i] = representations[i]
7820 Z3_fixedpoint_set_predicate_representation(self.ctx.ref(), self.fixedpoint, f.ast, sz, args)
7822 def parse_string(self, s):
7823 """Parse rules and queries from a string"""
7824 return AstVector(Z3_fixedpoint_from_string(self.ctx.ref(), self.fixedpoint, s), self.ctx)
7826 def parse_file(self, f):
7827 """Parse rules and queries from a file"""
7828 return AstVector(Z3_fixedpoint_from_file(self.ctx.ref(), self.fixedpoint, f), self.ctx)
7830 def get_rules(self):
7831 """retrieve rules that have been added to fixedpoint context"""
7832 return AstVector(Z3_fixedpoint_get_rules(self.ctx.ref(), self.fixedpoint), self.ctx)
7834 def get_assertions(self):
7835 """retrieve assertions that have been added to fixedpoint context"""
7836 return AstVector(Z3_fixedpoint_get_assertions(self.ctx.ref(), self.fixedpoint), self.ctx)
7839 """Return a formatted string with all added rules and constraints."""
7843 """Return a formatted string (in Lisp-like format) with all added constraints.
7844 We say the string is in s-expression format.
7846 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, 0, (Ast * 0)())
7848 def to_string(self, queries):
7849 """Return a formatted string (in Lisp-like format) with all added constraints.
7850 We say the string is in s-expression format.
7851 Include also queries.
7853 args, len = _to_ast_array(queries)
7854 return Z3_fixedpoint_to_string(self.ctx.ref(), self.fixedpoint, len, args)
7856 def statistics(self):
7857 """Return statistics for the last `query()`.
7859 return Statistics(Z3_fixedpoint_get_statistics(self.ctx.ref(), self.fixedpoint), self.ctx)
7861 def reason_unknown(self):
7862 """Return a string describing why the last `query()` returned `unknown`.
7864 return Z3_fixedpoint_get_reason_unknown(self.ctx.ref(), self.fixedpoint)
7866 def declare_var(self, *vars):
7867 """Add variable or several variables.
7868 The added variable or variables will be bound in the rules
7871 vars = _get_args(vars)
7875 def abstract(self, fml, is_forall=True):
7879 return ForAll(self.vars, fml)
7881 return Exists(self.vars, fml)
7884#########################################
7888#########################################
7890class FiniteDomainSortRef(SortRef):
7891 """Finite domain sort."""
7894 """Return the size of the finite domain sort"""
7895 r = (ctypes.c_ulonglong * 1)()
7896 if Z3_get_finite_domain_sort_size(self.ctx_ref(), self.ast, r):
7899 raise Z3Exception("Failed to retrieve finite domain sort size")
7902def FiniteDomainSort(name, sz, ctx=None):
7903 """Create a named finite domain sort of a given size sz"""
7904 if not isinstance(name, Symbol):
7905 name = to_symbol(name)
7907 return FiniteDomainSortRef(Z3_mk_finite_domain_sort(ctx.ref(), name, sz), ctx)
7910def is_finite_domain_sort(s):
7911 """Return True if `s` is a Z3 finite-domain sort.
7913 >>> is_finite_domain_sort(FiniteDomainSort('S', 100))
7915 >>> is_finite_domain_sort(IntSort())
7918 return isinstance(s, FiniteDomainSortRef)
7921class FiniteDomainRef(ExprRef):
7922 """Finite-domain expressions."""
7925 """Return the sort of the finite-domain expression `self`."""
7926 return FiniteDomainSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
7928 def as_string(self):
7929 """Return a Z3 floating point expression as a Python string."""
7930 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
7933def is_finite_domain(a):
7934 """Return `True` if `a` is a Z3 finite-domain expression.
7936 >>> s = FiniteDomainSort('S', 100)
7937 >>> b = Const('b', s)
7938 >>> is_finite_domain(b)
7940 >>> is_finite_domain(Int('x'))
7943 return isinstance(a, FiniteDomainRef)
7946class FiniteDomainNumRef(FiniteDomainRef):
7947 """Integer values."""
7950 """Return a Z3 finite-domain numeral as a Python long (bignum) numeral.
7952 >>> s = FiniteDomainSort('S', 100)
7953 >>> v = FiniteDomainVal(3, s)
7959 return int(self.as_string())
7961 def as_string(self):
7962 """Return a Z3 finite-domain numeral as a Python string.
7964 >>> s = FiniteDomainSort('S', 100)
7965 >>> v = FiniteDomainVal(42, s)
7969 return Z3_get_numeral_string(self.ctx_ref(), self.as_ast())
7972def FiniteDomainVal(val, sort, ctx=None):
7973 """Return a Z3 finite-domain value. If `ctx=None`, then the global context is used.
7975 >>> s = FiniteDomainSort('S', 256)
7976 >>> FiniteDomainVal(255, s)
7978 >>> FiniteDomainVal('100', s)
7982 _z3_assert(is_finite_domain_sort(sort), "Expected finite-domain sort")
7984 return FiniteDomainNumRef(Z3_mk_numeral(ctx.ref(), _to_int_str(val), sort.ast), ctx)
7987def is_finite_domain_value(a):
7988 """Return `True` if `a` is a Z3 finite-domain value.
7990 >>> s = FiniteDomainSort('S', 100)
7991 >>> b = Const('b', s)
7992 >>> is_finite_domain_value(b)
7994 >>> b = FiniteDomainVal(10, s)
7997 >>> is_finite_domain_value(b)
8000 return is_finite_domain(a) and _is_numeral(a.ctx, a.as_ast())
8003#########################################
8007#########################################
8009class OptimizeObjective:
8010 def __init__(self, opt, value, is_max):
8013 self._is_max = is_max
8017 return _to_expr_ref(Z3_optimize_get_lower(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8021 return _to_expr_ref(Z3_optimize_get_upper(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8023 def lower_values(self):
8025 return AstVector(Z3_optimize_get_lower_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8027 def upper_values(self):
8029 return AstVector(Z3_optimize_get_upper_as_vector(opt.ctx.ref(), opt.optimize, self._value), opt.ctx)
8038 return "%s:%s" % (self._value, self._is_max)
8044def _global_on_model(ctx):
8045 (fn, mdl) = _on_models[ctx]
8049_on_model_eh = on_model_eh_type(_global_on_model)
8052class Optimize(Z3PPObject):
8053 """Optimize API provides methods for solving using objective functions and weighted soft constraints"""
8055 def __init__(self, optimize=None, ctx=None):
8056 self.ctx = _get_ctx(ctx)
8057 if optimize is None:
8058 self.optimize = Z3_mk_optimize(self.ctx.ref())
8060 self.optimize = optimize
8061 self._on_models_id = None
8062 Z3_optimize_inc_ref(self.ctx.ref(), self.optimize)
8064 def __deepcopy__(self, memo={}):
8065 return Optimize(self.optimize, self.ctx)
8068 if self.optimize is not None and self.ctx.ref() is not None and Z3_optimize_dec_ref is not None:
8069 Z3_optimize_dec_ref(self.ctx.ref(), self.optimize)
8070 if self._on_models_id is not None:
8071 del _on_models[self._on_models_id]
8073 def __enter__(self):
8077 def __exit__(self, *exc_info):
8080 def set(self, *args, **keys):
8081 """Set a configuration option.
8082 The method `help()` return a string containing all available options.
8084 p = args2params(args, keys, self.ctx)
8085 Z3_optimize_set_params(self.ctx.ref(), self.optimize, p.params)
8088 """Display a string describing all available options."""
8089 print(Z3_optimize_get_help(self.ctx.ref(), self.optimize))
8091 def param_descrs(self):
8092 """Return the parameter description set."""
8093 return ParamDescrsRef(Z3_optimize_get_param_descrs(self.ctx.ref(), self.optimize), self.ctx)
8095 def assert_exprs(self, *args):
8096 """Assert constraints as background axioms for the optimize solver."""
8097 args = _get_args(args)
8098 s = BoolSort(self.ctx)
8100 if isinstance(arg, Goal) or isinstance(arg, AstVector):
8102 Z3_optimize_assert(self.ctx.ref(), self.optimize, f.as_ast())
8105 Z3_optimize_assert(self.ctx.ref(), self.optimize, arg.as_ast())
8107 def add(self, *args):
8108 """Assert constraints as background axioms for the optimize solver. Alias for assert_expr."""
8109 self.assert_exprs(*args)
8111 def __iadd__(self, fml):
8115 def assert_and_track(self, a, p):
8116 """Assert constraint `a` and track it in the unsat core using the Boolean constant `p`.
8118 If `p` is a string, it will be automatically converted into a Boolean constant.
8123 >>> s.assert_and_track(x > 0, 'p1')
8124 >>> s.assert_and_track(x != 1, 'p2')
8125 >>> s.assert_and_track(x < 0, p3)
8126 >>> print(s.check())
8128 >>> c = s.unsat_core()
8138 if isinstance(p, str):
8139 p = Bool(p, self.ctx)
8140 _z3_assert(isinstance(a, BoolRef), "Boolean expression expected")
8141 _z3_assert(isinstance(p, BoolRef) and is_const(p), "Boolean expression expected")
8142 Z3_optimize_assert_and_track(self.ctx.ref(), self.optimize, a.as_ast(), p.as_ast())
8144 def add_soft(self, arg, weight="1", id=None):
8145 """Add soft constraint with optional weight and optional identifier.
8146 If no weight is supplied, then the penalty for violating the soft constraint
8148 Soft constraints are grouped by identifiers. Soft constraints that are
8149 added without identifiers are grouped by default.
8152 weight = "%d" % weight
8153 elif isinstance(weight, float):
8154 weight = "%f" % weight
8155 if not isinstance(weight, str):
8156 raise Z3Exception("weight should be a string or an integer")
8159 id = to_symbol(id, self.ctx)
8162 v = Z3_optimize_assert_soft(self.ctx.ref(), self.optimize, a.as_ast(), weight, id)
8163 return OptimizeObjective(self, v, False)
8164 if sys.version_info.major >= 3 and isinstance(arg, Iterable):
8165 return [asoft(a) for a in arg]
8168 def set_initial_value(self, var, value):
8169 """initialize the solver's state by setting the initial value of var to value
8172 value = s.cast(value)
8173 Z3_optimize_set_initial_value(self.ctx.ref(), self.optimize, var.ast, value.ast)
8175 def maximize(self, arg):
8176 """Add objective function to maximize."""
8177 return OptimizeObjective(
8179 Z3_optimize_maximize(self.ctx.ref(), self.optimize, arg.as_ast()),
8183 def minimize(self, arg):
8184 """Add objective function to minimize."""
8185 return OptimizeObjective(
8187 Z3_optimize_minimize(self.ctx.ref(), self.optimize, arg.as_ast()),
8192 """create a backtracking point for added rules, facts and assertions"""
8193 Z3_optimize_push(self.ctx.ref(), self.optimize)
8196 """restore to previously created backtracking point"""
8197 Z3_optimize_pop(self.ctx.ref(), self.optimize)
8199 def check(self, *assumptions):
8200 """Check consistency and produce optimal values."""
8201 assumptions = _get_args(assumptions)
8202 num = len(assumptions)
8203 _assumptions = (Ast * num)()
8204 for i in range(num):
8205 _assumptions[i] = assumptions[i].as_ast()
8206 return CheckSatResult(Z3_optimize_check(self.ctx.ref(), self.optimize, num, _assumptions))
8208 def reason_unknown(self):
8209 """Return a string that describes why the last `check()` returned `unknown`."""
8210 return Z3_optimize_get_reason_unknown(self.ctx.ref(), self.optimize)
8213 """Return a model for the last check()."""
8215 return ModelRef(Z3_optimize_get_model(self.ctx.ref(), self.optimize), self.ctx)
8217 raise Z3Exception("model is not available")
8219 def unsat_core(self):
8220 return AstVector(Z3_optimize_get_unsat_core(self.ctx.ref(), self.optimize), self.ctx)
8222 def lower(self, obj):
8223 if not isinstance(obj, OptimizeObjective):
8224 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8227 def upper(self, obj):
8228 if not isinstance(obj, OptimizeObjective):
8229 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8232 def lower_values(self, obj):
8233 if not isinstance(obj, OptimizeObjective):
8234 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8235 return obj.lower_values()
8237 def upper_values(self, obj):
8238 if not isinstance(obj, OptimizeObjective):
8239 raise Z3Exception("Expecting objective handle returned by maximize/minimize")
8240 return obj.upper_values()
8242 def from_file(self, filename):
8243 """Parse assertions and objectives from a file"""
8244 Z3_optimize_from_file(self.ctx.ref(), self.optimize, filename)
8246 def from_string(self, s):
8247 """Parse assertions and objectives from a string"""
8248 Z3_optimize_from_string(self.ctx.ref(), self.optimize, s)
8250 def assertions(self):
8251 """Return an AST vector containing all added constraints."""
8252 return AstVector(Z3_optimize_get_assertions(self.ctx.ref(), self.optimize), self.ctx)
8254 def objectives(self):
8255 """returns set of objective functions"""
8256 return AstVector(Z3_optimize_get_objectives(self.ctx.ref(), self.optimize), self.ctx)
8259 """Return a formatted string with all added rules and constraints."""
8263 """Return a formatted string (in Lisp-like format) with all added constraints.
8264 We say the string is in s-expression format.
8266 return Z3_optimize_to_string(self.ctx.ref(), self.optimize)
8268 def statistics(self):
8269 """Return statistics for the last check`.
8271 return Statistics(Z3_optimize_get_statistics(self.ctx.ref(), self.optimize), self.ctx)
8273 def set_on_model(self, on_model):
8274 """Register a callback that is invoked with every incremental improvement to
8275 objective values. The callback takes a model as argument.
8276 The life-time of the model is limited to the callback so the
8277 model has to be (deep) copied if it is to be used after the callback
8279 id = len(_on_models) + 41
8280 mdl = Model(self.ctx)
8281 _on_models[id] = (on_model, mdl)
8282 self._on_models_id = id
8283 Z3_optimize_register_model_eh(
8284 self.ctx.ref(), self.optimize, mdl.model, ctypes.c_void_p(id), _on_model_eh,
8288#########################################
8292#########################################
8293class ApplyResult(Z3PPObject):
8294 """An ApplyResult object contains the subgoals produced by a tactic when applied to a goal.
8295 It also contains model and proof converters.
8298 def __init__(self, result, ctx):
8299 self.result = result
8301 Z3_apply_result_inc_ref(self.ctx.ref(), self.result)
8303 def __deepcopy__(self, memo={}):
8304 return ApplyResult(self.result, self.ctx)
8307 if self.ctx.ref() is not None and Z3_apply_result_dec_ref is not None:
8308 Z3_apply_result_dec_ref(self.ctx.ref(), self.result)
8311 """Return the number of subgoals in `self`.
8313 >>> a, b = Ints('a b')
8315 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8316 >>> t = Tactic('split-clause')
8320 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
8323 >>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
8327 return int(Z3_apply_result_get_num_subgoals(self.ctx.ref(), self.result))
8329 def __getitem__(self, idx):
8330 """Return one of the subgoals stored in ApplyResult object `self`.
8332 >>> a, b = Ints('a b')
8334 >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
8335 >>> t = Tactic('split-clause')
8338 [a == 0, Or(b == 0, b == 1), a > b]
8340 [a == 1, Or(b == 0, b == 1), a > b]
8342 if idx >= len(self):
8344 return Goal(goal=Z3_apply_result_get_subgoal(self.ctx.ref(), self.result, idx), ctx=self.ctx)
8347 return obj_to_string(self)
8350 """Return a textual representation of the s-expression representing the set of subgoals in `self`."""
8351 return Z3_apply_result_to_string(self.ctx.ref(), self.result)
8354 """Return a Z3 expression consisting of all subgoals.
8359 >>> g.add(Or(x == 2, x == 3))
8360 >>> r = Tactic('simplify')(g)
8362 [[Not(x <= 1), Or(x == 2, x == 3)]]
8364 And(Not(x <= 1), Or(x == 2, x == 3))
8365 >>> r = Tactic('split-clause')(g)
8367 [[x > 1, x == 2], [x > 1, x == 3]]
8369 Or(And(x > 1, x == 2), And(x > 1, x == 3))
8373 return BoolVal(False, self.ctx)
8375 return self[0].as_expr()
8377 return Or([self[i].as_expr() for i in range(len(self))])
8379#########################################
8383#########################################
8386 """Simplifiers act as pre-processing utilities for solvers.
8387 Build a custom simplifier and add it to a solve
r"""
8389 def __init__(self, simplifier, ctx=None):
8390 self.ctx = _get_ctx(ctx)
8391 self.simplifier = None
8392 if isinstance(simplifier, SimplifierObj):
8393 self.simplifier = simplifier
8394 elif isinstance(simplifier, list):
8395 simps = [Simplifier(s, ctx) for s in simplifier]
8396 self.simplifier = simps[0].simplifier
8397 for i in range(1, len(simps)):
8398 self.simplifier = Z3_simplifier_and_then(self.ctx.ref(), self.simplifier, simps[i].simplifier)
8399 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8403 _z3_assert(isinstance(simplifier, str), "simplifier name expected")
8405 self.simplifier = Z3_mk_simplifier(self.ctx.ref(), str(simplifier))
8407 raise Z3Exception("unknown simplifier '%s'" % simplifier)
8408 Z3_simplifier_inc_ref(self.ctx.ref(), self.simplifier)
8410 def __deepcopy__(self, memo={}):
8411 return Simplifier(self.simplifier, self.ctx)
8414 if self.simplifier is not None and self.ctx.ref() is not None and Z3_simplifier_dec_ref is not None:
8415 Z3_simplifier_dec_ref(self.ctx.ref(), self.simplifier)
8417 def using_params(self, *args, **keys):
8418 """Return a simplifier that uses the given configuration options"""
8419 p = args2params(args, keys, self.ctx)
8420 return Simplifier(Z3_simplifier_using_params(self.ctx.ref(), self.simplifier, p.params), self.ctx)
8422 def add(self, solver):
8423 """Return a solver that applies the simplification pre-processing specified by the simplifie
r"""
8424 return Solver(Z3_solver_add_simplifier(self.ctx.ref(), solver.solver, self.simplifier), self.ctx)
8427 """Display a string containing a description of the available options for the `self` simplifier."""
8428 print(Z3_simplifier_get_help(self.ctx.ref(), self.simplifier))
8430 def param_descrs(self):
8431 """Return the parameter description set."""
8432 return ParamDescrsRef(Z3_simplifier_get_param_descrs(self.ctx.ref(), self.simplifier), self.ctx)
8435#########################################
8439#########################################
8443 """Tactics transform, solver and/or simplify sets of constraints (Goal).
8444 A Tactic can be converted into a Solver using the method solver().
8446 Several combinators are available for creating new tactics using the built-in ones:
8447 Then(), OrElse(), FailIf(), Repeat(), When(), Cond().
8450 def __init__(self, tactic, ctx=None):
8451 self.ctx = _get_ctx(ctx)
8453 if isinstance(tactic, TacticObj):
8454 self.tactic = tactic
8457 _z3_assert(isinstance(tactic, str), "tactic name expected")
8459 self.tactic = Z3_mk_tactic(self.ctx.ref(), str(tactic))
8461 raise Z3Exception("unknown tactic '%s'" % tactic)
8462 Z3_tactic_inc_ref(self.ctx.ref(), self.tactic)
8464 def __deepcopy__(self, memo={}):
8465 return Tactic(self.tactic, self.ctx)
8468 if self.tactic is not None and self.ctx.ref() is not None and Z3_tactic_dec_ref is not None:
8469 Z3_tactic_dec_ref(self.ctx.ref(), self.tactic)
8471 def solver(self, logFile=None):
8472 """Create a solver using the tactic `self`.
8474 The solver supports the methods `push()` and `pop()`, but it
8475 will always solve each `check()` from scratch.
8477 >>> t = Then('simplify', 'nlsat')
8480 >>> s.add(x**2 == 2, x > 0)
8486 return Solver(Z3_mk_solver_from_tactic(self.ctx.ref(), self.tactic), self.ctx, logFile)
8488 def apply(self, goal, *arguments, **keywords):
8489 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8491 >>> x, y = Ints('x y')
8492 >>> t = Tactic('solve-eqs')
8493 >>> t.apply(And(x == 0, y >= x + 1))
8497 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expressions expected")
8498 goal = _to_goal(goal)
8499 if len(arguments) > 0 or len(keywords) > 0:
8500 p = args2params(arguments, keywords, self.ctx)
8501 return ApplyResult(Z3_tactic_apply_ex(self.ctx.ref(), self.tactic, goal.goal, p.params), self.ctx)
8503 return ApplyResult(Z3_tactic_apply(self.ctx.ref(), self.tactic, goal.goal), self.ctx)
8505 def __call__(self, goal, *arguments, **keywords):
8506 """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8508 >>> x, y = Ints('x y')
8509 >>> t = Tactic('solve-eqs')
8510 >>> t(And(x == 0, y >= x + 1))
8513 return self.apply(goal, *arguments, **keywords)
8516 """Display a string containing a description of the available options for the `self` tactic."""
8517 print(Z3_tactic_get_help(self.ctx.ref(), self.tactic))
8519 def param_descrs(self):
8520 """Return the parameter description set."""
8521 return ParamDescrsRef(Z3_tactic_get_param_descrs(self.ctx.ref(), self.tactic), self.ctx)
8525 if isinstance(a, BoolRef):
8526 goal = Goal(ctx=a.ctx)
8533def _to_tactic(t, ctx=None):
8534 if isinstance(t, Tactic):
8537 return Tactic(t, ctx)
8540def _and_then(t1, t2, ctx=None):
8541 t1 = _to_tactic(t1, ctx)
8542 t2 = _to_tactic(t2, ctx)
8544 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8545 return Tactic(Z3_tactic_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8548def _or_else(t1, t2, ctx=None):
8549 t1 = _to_tactic(t1, ctx)
8550 t2 = _to_tactic(t2, ctx)
8552 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8553 return Tactic(Z3_tactic_or_else(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8556def AndThen(*ts, **ks):
8557 """Return a tactic that applies the tactics in `*ts` in sequence.
8559 >>> x, y = Ints('x y')
8560 >>> t = AndThen(Tactic('simplify'), Tactic('solve-eqs'))
8561 >>> t(And(x == 0, y > x + 1))
8563 >>> t(And(x == 0, y > x + 1)).as_expr()
8567 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8568 ctx = ks.get("ctx", None)
8571 for i in range(num - 1):
8572 r = _and_then(r, ts[i + 1], ctx)
8577 """Return a tactic that applies the tactics in `*ts` in sequence. Shorthand for AndThen(*ts, **ks).
8579 >>> x, y = Ints('x y')
8580 >>> t = Then(Tactic('simplify'), Tactic('solve-eqs'))
8581 >>> t(And(x == 0, y > x + 1))
8583 >>> t(And(x == 0, y > x + 1)).as_expr()
8586 return AndThen(*ts, **ks)
8589def OrElse(*ts, **ks):
8590 """Return a tactic that applies the tactics in `*ts` until one of them succeeds (it doesn't fail).
8593 >>> t = OrElse(Tactic('split-clause'), Tactic('skip'))
8594 >>> # Tactic split-clause fails if there is no clause in the given goal.
8597 >>> t(Or(x == 0, x == 1))
8598 [[x == 0], [x == 1]]
8601 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8602 ctx = ks.get("ctx", None)
8605 for i in range(num - 1):
8606 r = _or_else(r, ts[i + 1], ctx)
8610def ParOr(*ts, **ks):
8611 """Return a tactic that applies the tactics in `*ts` in parallel until one of them succeeds (it doesn't fail).
8614 >>> t = ParOr(Tactic('simplify'), Tactic('fail'))
8619 _z3_assert(len(ts) >= 2, "At least two arguments expected")
8620 ctx = _get_ctx(ks.get("ctx", None))
8621 ts = [_to_tactic(t, ctx) for t in ts]
8623 _args = (TacticObj * sz)()
8625 _args[i] = ts[i].tactic
8626 return Tactic(Z3_tactic_par_or(ctx.ref(), sz, _args), ctx)
8629def ParThen(t1, t2, ctx=None):
8630 """Return a tactic that applies t1 and then t2 to every subgoal produced by t1.
8631 The subgoals are processed in parallel.
8633 >>> x, y = Ints('x y')
8634 >>> t = ParThen(Tactic('split-clause'), Tactic('propagate-values'))
8635 >>> t(And(Or(x == 1, x == 2), y == x + 1))
8636 [[x == 1, y == 2], [x == 2, y == 3]]
8638 t1 = _to_tactic(t1, ctx)
8639 t2 = _to_tactic(t2, ctx)
8641 _z3_assert(t1.ctx == t2.ctx, "Context mismatch")
8642 return Tactic(Z3_tactic_par_and_then(t1.ctx.ref(), t1.tactic, t2.tactic), t1.ctx)
8645def ParAndThen(t1, t2, ctx=None):
8646 """Alias for ParThen(t1, t2, ctx)."""
8647 return ParThen(t1, t2, ctx)
8650def With(t, *args, **keys):
8651 """Return a tactic that applies tactic `t` using the given configuration options.
8653 >>> x, y = Ints('x y')
8654 >>> t = With(Tactic('simplify'), som=True)
8655 >>> t((x + 1)*(y + 2) == 0)
8656 [[2*x + y + x*y == -2]]
8658 ctx = keys.pop("ctx", None)
8659 t = _to_tactic(t, ctx)
8660 p = args2params(args, keys, t.ctx)
8661 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8664def WithParams(t, p):
8665 """Return a tactic that applies tactic `t` using the given configuration options.
8667 >>> x, y = Ints('x y')
8669 >>> p.set("som", True)
8670 >>> t = WithParams(Tactic('simplify'), p)
8671 >>> t((x + 1)*(y + 2) == 0)
8672 [[2*x + y + x*y == -2]]
8674 t = _to_tactic(t, None)
8675 return Tactic(Z3_tactic_using_params(t.ctx.ref(), t.tactic, p.params), t.ctx)
8678def Repeat(t, max=4294967295, ctx=None):
8679 """Return a tactic that keeps applying `t` until the goal is not modified anymore
8680 or the maximum number of iterations `max` is reached.
8682 >>> x, y = Ints('x y')
8683 >>> c = And(Or(x == 0, x == 1), Or(y == 0, y == 1), x > y)
8684 >>> t = Repeat(OrElse(Tactic('split-clause'), Tactic('skip')))
8686 >>> for subgoal in r: print(subgoal)
8687 [x == 0, y == 0, x > y]
8688 [x == 0, y == 1, x > y]
8689 [x == 1, y == 0, x > y]
8690 [x == 1, y == 1, x > y]
8691 >>> t = Then(t, Tactic('propagate-values'))
8695 t = _to_tactic(t, ctx)
8696 return Tactic(Z3_tactic_repeat(t.ctx.ref(), t.tactic, max), t.ctx)
8699def TryFor(t, ms, ctx=None):
8700 """Return a tactic that applies `t` to a given goal for `ms` milliseconds.
8702 If `t` does not terminate in `ms` milliseconds, then it fails.
8704 t = _to_tactic(t, ctx)
8705 return Tactic(Z3_tactic_try_for(t.ctx.ref(), t.tactic, ms), t.ctx)
8708def tactics(ctx=None):
8709 """Return a list of all available tactics in Z3.
8712 >>> l.count('simplify') == 1
8716 return [Z3_get_tactic_name(ctx.ref(), i) for i in range(Z3_get_num_tactics(ctx.ref()))]
8719def tactic_description(name, ctx=None):
8720 """Return a short description for the tactic named `name`.
8722 >>> d = tactic_description('simplify')
8725 return Z3_tactic_get_descr(ctx.ref(), name)
8728def describe_tactics():
8729 """Display a (tabular) description of all available tactics in Z3."""
8732 print('<table border="1" cellpadding="2" cellspacing="0">')
8735 print('<tr style="background-color:#CFCFCF">')
8740 print("<td>%s</td><td>%s</td></tr>" % (t, insert_line_breaks(tactic_description(t), 40)))
8744 print("%s : %s" % (t, tactic_description(t)))
8748 """Probes are used to inspect a goal (aka problem) and collect information that may be used
8749 to decide which solver and/or preprocessing step will be used.
8752 def __init__(self, probe, ctx=None):
8753 self.ctx = _get_ctx(ctx)
8755 if isinstance(probe, ProbeObj):
8757 elif isinstance(probe, float):
8758 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8759 elif _is_int(probe):
8760 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8761 elif isinstance(probe, bool):
8763 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8765 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8768 _z3_assert(isinstance(probe, str), "probe name expected")
8770 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8772 raise Z3Exception("unknown probe '%s'" % probe)
8773 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8775 def __deepcopy__(self, memo={}):
8776 return Probe(self.probe, self.ctx)
8779 if self.probe is not None and self.ctx.ref() is not None and Z3_probe_dec_ref is not None:
8780 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8782 def __lt__(self, other):
8783 """Return a probe that evaluates to "true" when the value returned by `self`
8784 is less than the value returned by `other`.
8786 >>> p = Probe('size') < 10
8794 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8796 def __gt__(self, other):
8797 """Return a probe that evaluates to "true" when the value returned by `self`
8798 is greater than the value returned by `other`.
8800 >>> p = Probe('size') > 10
8808 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8810 def __le__(self, other):
8811 """Return a probe that evaluates to "true" when the value returned by `self`
8812 is less than or equal to the value returned by `other`.
8814 >>> p = Probe('size') <= 2
8822 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8824 def __ge__(self, other):
8825 """Return a probe that evaluates to "true" when the value returned by `self`
8826 is greater than or equal to the value returned by `other`.
8828 >>> p = Probe('size') >= 2
8836 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8838 def __eq__(self, other):
8839 """Return a probe that evaluates to "true" when the value returned by `self`
8840 is equal to the value returned by `other`.
8842 >>> p = Probe('size') == 2
8850 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8852 def __ne__(self, other):
8853 """Return a probe that evaluates to "true" when the value returned by `self`
8854 is not equal to the value returned by `other`.
8856 >>> p = Probe('size') != 2
8864 p = self.__eq__(other)
8865 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8867 def __call__(self, goal):
8868 """Evaluate the probe `self` in the given goal.
8870 >>> p = Probe('size')
8880 >>> p = Probe('num-consts')
8883 >>> p = Probe('is-propositional')
8886 >>> p = Probe('is-qflia')
8891 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
8892 goal = _to_goal(goal)
8893 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8897 """Return `True` if `p` is a Z3 probe.
8899 >>> is_probe(Int('x'))
8901 >>> is_probe(Probe('memory'))
8904 return isinstance(p, Probe)
8907def _to_probe(p, ctx=None):
8911 return Probe(p, ctx)
8914def probes(ctx=None):
8915 """Return a list of all available probes in Z3.
8918 >>> l.count('memory') == 1
8922 return [Z3_get_probe_name(ctx.ref(), i) for i in range(Z3_get_num_probes(ctx.ref()))]
8925def probe_description(name, ctx=None):
8926 """Return a short description for the probe named `name`.
8928 >>> d = probe_description('memory')
8931 return Z3_probe_get_descr(ctx.ref(), name)
8934def describe_probes():
8935 """Display a (tabular) description of all available probes in Z3."""
8938 print('<table border="1" cellpadding="2" cellspacing="0">')
8941 print('<tr style="background-color:#CFCFCF">')
8946 print("<td>%s</td><td>%s</td></tr>" % (p, insert_line_breaks(probe_description(p), 40)))
8950 print("%s : %s" % (p, probe_description(p)))
8953def _probe_nary(f, args, ctx):
8955 _z3_assert(len(args) > 0, "At least one argument expected")
8957 r = _to_probe(args[0], ctx)
8958 for i in range(num - 1):
8959 r = Probe(f(ctx.ref(), r.probe, _to_probe(args[i + 1], ctx).probe), ctx)
8963def _probe_and(args, ctx):
8964 return _probe_nary(Z3_probe_and, args, ctx)
8967def _probe_or(args, ctx):
8968 return _probe_nary(Z3_probe_or, args, ctx)
8971def FailIf(p, ctx=None):
8972 """Return a tactic that fails if the probe `p` evaluates to true.
8973 Otherwise, it returns the input goal unmodified.
8975 In the following example, the tactic applies 'simplify' if and only if there are
8976 more than 2 constraints in the goal.
8978 >>> t = OrElse(FailIf(Probe('size') > 2), Tactic('simplify'))
8979 >>> x, y = Ints('x y')
8985 >>> g.add(x == y + 1)
8987 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
8989 p = _to_probe(p, ctx)
8990 return Tactic(Z3_tactic_fail_if(p.ctx.ref(), p.probe), p.ctx)
8993def When(p, t, ctx=None):
8994 """Return a tactic that applies tactic `t` only if probe `p` evaluates to true.
8995 Otherwise, it returns the input goal unmodified.
8997 >>> t = When(Probe('size') > 2, Tactic('simplify'))
8998 >>> x, y = Ints('x y')
9004 >>> g.add(x == y + 1)
9006 [[Not(x <= 0), Not(y <= 0), x == 1 + y]]
9008 p = _to_probe(p, ctx)
9009 t = _to_tactic(t, ctx)
9010 return Tactic(Z3_tactic_when(t.ctx.ref(), p.probe, t.tactic), t.ctx)
9013def Cond(p, t1, t2, ctx=None):
9014 """Return a tactic that applies tactic `t1` to a goal if probe `p` evaluates to true, and `t2` otherwise.
9016 >>> t = Cond(Probe('is-qfnra'), Tactic('qfnra'), Tactic('smt'))
9018 p = _to_probe(p, ctx)
9019 t1 = _to_tactic(t1, ctx)
9020 t2 = _to_tactic(t2, ctx)
9021 return Tactic(Z3_tactic_cond(t1.ctx.ref(), p.probe, t1.tactic, t2.tactic), t1.ctx)
9023#########################################
9027#########################################
9030def simplify(a, *arguments, **keywords):
9031 """Simplify the expression `a` using the given options.
9033 This function has many options. Use `help_simplify` to obtain the complete list.
9037 >>> simplify(x + 1 + y + x + 1)
9039 >>> simplify((x + 1)*(y + 1), som=True)
9041 >>> simplify(Distinct(x, y, 1), blast_distinct=True)
9042 And(Not(x == y), Not(x == 1), Not(y == 1))
9043 >>> simplify(And(x == 0, y == 1), elim_and=True)
9044 Not(Or(Not(x == 0), Not(y == 1)))
9047 _z3_assert(is_expr(a), "Z3 expression expected")
9048 if len(arguments) > 0 or len(keywords) > 0:
9049 p = args2params(arguments, keywords, a.ctx)
9050 return _to_expr_ref(Z3_simplify_ex(a.ctx_ref(), a.as_ast(), p.params), a.ctx)
9052 return _to_expr_ref(Z3_simplify(a.ctx_ref(), a.as_ast()), a.ctx)
9056 """Return a string describing all options available for Z3 `simplify` procedure."""
9057 print(Z3_simplify_get_help(main_ctx().ref()))
9060def simplify_param_descrs():
9061 """Return the set of parameter descriptions for Z3 `simplify` procedure."""
9062 return ParamDescrsRef(Z3_simplify_get_param_descrs(main_ctx().ref()), main_ctx())
9065def substitute(t, *m):
9066 """Apply substitution m on t, m is a list of pairs of the form (from, to).
9067 Every occurrence in t of from is replaced with to.
9071 >>> substitute(x + 1, (x, y + 1))
9073 >>> f = Function('f', IntSort(), IntSort())
9074 >>> substitute(f(x) + f(y), (f(x), IntVal(1)), (f(y), IntVal(1)))
9077 if isinstance(m, tuple):
9079 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9082 _z3_assert(is_expr(t), "Z3 expression expected")
9084 all([isinstance(p, tuple) and is_expr(p[0]) and is_expr(p[1]) for p in m]),
9085 "Z3 invalid substitution, expression pairs expected.")
9087 all([p[0].sort().eq(p[1].sort()) for p in m]),
9088 'Z3 invalid substitution, mismatching "from" and "to" sorts.')
9090 _from = (Ast * num)()
9092 for i in range(num):
9093 _from[i] = m[i][0].as_ast()
9094 _to[i] = m[i][1].as_ast()
9095 return _to_expr_ref(Z3_substitute(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9098def substitute_vars(t, *m):
9099 """Substitute the free variables in t with the expression in m.
9101 >>> v0 = Var(0, IntSort())
9102 >>> v1 = Var(1, IntSort())
9104 >>> f = Function('f', IntSort(), IntSort(), IntSort())
9105 >>> # replace v0 with x+1 and v1 with x
9106 >>> substitute_vars(f(v0, v1), x + 1, x)
9110 _z3_assert(is_expr(t), "Z3 expression expected")
9111 _z3_assert(all([is_expr(n) for n in m]), "Z3 invalid substitution, list of expressions expected.")
9114 for i in range(num):
9115 _to[i] = m[i].as_ast()
9116 return _to_expr_ref(Z3_substitute_vars(t.ctx.ref(), t.as_ast(), num, _to), t.ctx)
9118def substitute_funs(t, *m):
9119 """Apply substitution m on t, m is a list of pairs of a function and expression (from, to)
9120 Every occurrence in to of the function from is replaced with the expression to.
9121 The expression to can have free variables, that refer to the arguments of from.
9124 if isinstance(m, tuple):
9126 if isinstance(m1, list) and all(isinstance(p, tuple) for p in m1):
9129 _z3_assert(is_expr(t), "Z3 expression expected")
9130 _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.")
9132 _from = (FuncDecl * num)()
9134 for i in range(num):
9135 _from[i] = m[i][0].as_func_decl()
9136 _to[i] = m[i][1].as_ast()
9137 return _to_expr_ref(Z3_substitute_funs(t.ctx.ref(), t.as_ast(), num, _from, _to), t.ctx)
9141 """Create the sum of the Z3 expressions.
9143 >>> a, b, c = Ints('a b c')
9148 >>> A = IntVector('a', 5)
9150 a__0 + a__1 + a__2 + a__3 + a__4
9152 args = _get_args(args)
9155 ctx = _ctx_from_ast_arg_list(args)
9157 return _reduce(lambda a, b: a + b, args, 0)
9158 args = _coerce_expr_list(args, ctx)
9160 return _reduce(lambda a, b: a + b, args, 0)
9162 _args, sz = _to_ast_array(args)
9163 return ArithRef(Z3_mk_add(ctx.ref(), sz, _args), ctx)
9167 """Create the product of the Z3 expressions.
9169 >>> a, b, c = Ints('a b c')
9170 >>> Product(a, b, c)
9172 >>> Product([a, b, c])
9174 >>> A = IntVector('a', 5)
9176 a__0*a__1*a__2*a__3*a__4
9178 args = _get_args(args)
9181 ctx = _ctx_from_ast_arg_list(args)
9183 return _reduce(lambda a, b: a * b, args, 1)
9184 args = _coerce_expr_list(args, ctx)
9186 return _reduce(lambda a, b: a * b, args, 1)
9188 _args, sz = _to_ast_array(args)
9189 return ArithRef(Z3_mk_mul(ctx.ref(), sz, _args), ctx)
9192 """Create the absolute value of an arithmetic expression"""
9193 return If(arg > 0, arg, -arg)
9197 """Create an at-most Pseudo-Boolean k constraint.
9199 >>> a, b, c = Bools('a b c')
9200 >>> f = AtMost(a, b, c, 2)
9202 args = _get_args(args)
9204 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9205 ctx = _ctx_from_ast_arg_list(args)
9207 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9208 args1 = _coerce_expr_list(args[:-1], ctx)
9210 _args, sz = _to_ast_array(args1)
9211 return BoolRef(Z3_mk_atmost(ctx.ref(), sz, _args, k), ctx)
9215 """Create an at-least Pseudo-Boolean k constraint.
9217 >>> a, b, c = Bools('a b c')
9218 >>> f = AtLeast(a, b, c, 2)
9220 args = _get_args(args)
9222 _z3_assert(len(args) > 1, "Non empty list of arguments expected")
9223 ctx = _ctx_from_ast_arg_list(args)
9225 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9226 args1 = _coerce_expr_list(args[:-1], ctx)
9228 _args, sz = _to_ast_array(args1)
9229 return BoolRef(Z3_mk_atleast(ctx.ref(), sz, _args, k), ctx)
9232def _reorder_pb_arg(arg):
9234 if not _is_int(b) and _is_int(a):
9239def _pb_args_coeffs(args, default_ctx=None):
9240 args = _get_args_ast_list(args)
9242 return _get_ctx(default_ctx), 0, (Ast * 0)(), (ctypes.c_int * 0)()
9243 args = [_reorder_pb_arg(arg) for arg in args]
9244 args, coeffs = zip(*args)
9246 _z3_assert(len(args) > 0, "Non empty list of arguments expected")
9247 ctx = _ctx_from_ast_arg_list(args)
9249 _z3_assert(ctx is not None, "At least one of the arguments must be a Z3 expression")
9250 args = _coerce_expr_list(args, ctx)
9251 _args, sz = _to_ast_array(args)
9252 _coeffs = (ctypes.c_int * len(coeffs))()
9253 for i in range(len(coeffs)):
9254 _z3_check_cint_overflow(coeffs[i], "coefficient")
9255 _coeffs[i] = coeffs[i]
9256 return ctx, sz, _args, _coeffs, args
9260 """Create a Pseudo-Boolean inequality k constraint.
9262 >>> a, b, c = Bools('a b c')
9263 >>> f = PbLe(((a,1),(b,3),(c,2)), 3)
9265 _z3_check_cint_overflow(k, "k")
9266 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9267 return BoolRef(Z3_mk_pble(ctx.ref(), sz, _args, _coeffs, k), ctx)
9271 """Create a Pseudo-Boolean inequality k constraint.
9273 >>> a, b, c = Bools('a b c')
9274 >>> f = PbGe(((a,1),(b,3),(c,2)), 3)
9276 _z3_check_cint_overflow(k, "k")
9277 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9278 return BoolRef(Z3_mk_pbge(ctx.ref(), sz, _args, _coeffs, k), ctx)
9281def PbEq(args, k, ctx=None):
9282 """Create a Pseudo-Boolean equality k constraint.
9284 >>> a, b, c = Bools('a b c')
9285 >>> f = PbEq(((a,1),(b,3),(c,2)), 3)
9287 _z3_check_cint_overflow(k, "k")
9288 ctx, sz, _args, _coeffs, args = _pb_args_coeffs(args)
9289 return BoolRef(Z3_mk_pbeq(ctx.ref(), sz, _args, _coeffs, k), ctx)
9292def solve(*args, **keywords):
9293 """Solve the constraints `*args`.
9295 This is a simple function for creating demonstrations. It creates a solver,
9296 configure it using the options in `keywords`, adds the constraints
9297 in `args`, and invokes check.
9300 >>> solve(a > 0, a < 2)
9303 show = keywords.pop("show", False)
9311 print("no solution")
9313 print("failed to solve")
9322def solve_using(s, *args, **keywords):
9323 """Solve the constraints `*args` using solver `s`.
9325 This is a simple function for creating demonstrations. It is similar to `solve`,
9326 but it uses the given solver `s`.
9327 It configures solver `s` using the options in `keywords`, adds the constraints
9328 in `args`, and invokes check.
9330 show = keywords.pop("show", False)
9332 _z3_assert(isinstance(s, Solver), "Solver object expected")
9340 print("no solution")
9342 print("failed to solve")
9353def prove(claim, show=False, **keywords):
9354 """Try to prove the given claim.
9356 This is a simple function for creating demonstrations. It tries to prove
9357 `claim` by showing the negation is unsatisfiable.
9359 >>> p, q = Bools('p q')
9360 >>> prove(Not(And(p, q)) == Or(Not(p), Not(q)))
9364 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9374 print("failed to prove")
9377 print("counterexample")
9381def _solve_html(*args, **keywords):
9382 """Version of function `solve` that renders HTML output."""
9383 show = keywords.pop("show", False)
9388 print("<b>Problem:</b>")
9392 print("<b>no solution</b>")
9394 print("<b>failed to solve</b>")
9401 print("<b>Solution:</b>")
9405def _solve_using_html(s, *args, **keywords):
9406 """Version of function `solve_using` that renders HTML."""
9407 show = keywords.pop("show", False)
9409 _z3_assert(isinstance(s, Solver), "Solver object expected")
9413 print("<b>Problem:</b>")
9417 print("<b>no solution</b>")
9419 print("<b>failed to solve</b>")
9426 print("<b>Solution:</b>")
9430def _prove_html(claim, show=False, **keywords):
9431 """Version of function `prove` that renders HTML."""
9433 _z3_assert(is_bool(claim), "Z3 Boolean expression expected")
9441 print("<b>proved</b>")
9443 print("<b>failed to prove</b>")
9446 print("<b>counterexample</b>")
9450def _dict2sarray(sorts, ctx):
9452 _names = (Symbol * sz)()
9453 _sorts = (Sort * sz)()
9458 _z3_assert(isinstance(k, str), "String expected")
9459 _z3_assert(is_sort(v), "Z3 sort expected")
9460 _names[i] = to_symbol(k, ctx)
9463 return sz, _names, _sorts
9466def _dict2darray(decls, ctx):
9468 _names = (Symbol * sz)()
9469 _decls = (FuncDecl * sz)()
9474 _z3_assert(isinstance(k, str), "String expected")
9475 _z3_assert(is_func_decl(v) or is_const(v), "Z3 declaration or constant expected")
9476 _names[i] = to_symbol(k, ctx)
9478 _decls[i] = v.decl().ast
9482 return sz, _names, _decls
9485 def __init__(self, ctx= None):
9486 self.ctx = _get_ctx(ctx)
9487 self.pctx = Z3_mk_parser_context(self.ctx.ref())
9488 Z3_parser_context_inc_ref(self.ctx.ref(), self.pctx)
9491 if self.ctx.ref() is not None and self.pctx is not None and Z3_parser_context_dec_ref is not None:
9492 Z3_parser_context_dec_ref(self.ctx.ref(), self.pctx)
9495 def add_sort(self, sort):
9496 Z3_parser_context_add_sort(self.ctx.ref(), self.pctx, sort.as_ast())
9498 def add_decl(self, decl):
9499 Z3_parser_context_add_decl(self.ctx.ref(), self.pctx, decl.as_ast())
9501 def from_string(self, s):
9502 return AstVector(Z3_parser_context_from_string(self.ctx.ref(), self.pctx, s), self.ctx)
9504def parse_smt2_string(s, sorts={}, decls={}, ctx=None):
9505 """Parse a string in SMT 2.0 format using the given sorts and decls.
9507 The arguments sorts and decls are Python dictionaries used to initialize
9508 the symbol table used for the SMT 2.0 parser.
9510 >>> parse_smt2_string('(declare-const x Int) (assert (> x 0)) (assert (< x 10))')
9512 >>> x, y = Ints('x y')
9513 >>> f = Function('f', IntSort(), IntSort())
9514 >>> parse_smt2_string('(assert (> (+ foo (g bar)) 0))', decls={ 'foo' : x, 'bar' : y, 'g' : f})
9516 >>> parse_smt2_string('(declare-const a U) (assert (> a 0))', sorts={ 'U' : IntSort() })
9520 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9521 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9522 return AstVector(Z3_parse_smtlib2_string(ctx.ref(), s, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9525def parse_smt2_file(f, sorts={}, decls={}, ctx=None):
9526 """Parse a file in SMT 2.0 format using the given sorts and decls.
9528 This function is similar to parse_smt2_string().
9531 ssz, snames, ssorts = _dict2sarray(sorts, ctx)
9532 dsz, dnames, ddecls = _dict2darray(decls, ctx)
9533 return AstVector(Z3_parse_smtlib2_file(ctx.ref(), f, ssz, snames, ssorts, dsz, dnames, ddecls), ctx)
9536#########################################
9538# Floating-Point Arithmetic
9540#########################################
9543# Global default rounding mode
9544_dflt_rounding_mode = Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN
9545_dflt_fpsort_ebits = 11
9546_dflt_fpsort_sbits = 53
9549def get_default_rounding_mode(ctx=None):
9550 """Retrieves the global default rounding mode."""
9551 global _dflt_rounding_mode
9552 if _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_ZERO:
9554 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_NEGATIVE:
9556 elif _dflt_rounding_mode == Z3_OP_FPA_RM_TOWARD_POSITIVE:
9558 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN:
9560 elif _dflt_rounding_mode == Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY:
9564_ROUNDING_MODES = frozenset({
9565 Z3_OP_FPA_RM_TOWARD_ZERO,
9566 Z3_OP_FPA_RM_TOWARD_NEGATIVE,
9567 Z3_OP_FPA_RM_TOWARD_POSITIVE,
9568 Z3_OP_FPA_RM_NEAREST_TIES_TO_EVEN,
9569 Z3_OP_FPA_RM_NEAREST_TIES_TO_AWAY
9573def set_default_rounding_mode(rm, ctx=None):
9574 global _dflt_rounding_mode
9575 if is_fprm_value(rm):
9576 _dflt_rounding_mode = rm.kind()
9578 _z3_assert(_dflt_rounding_mode in _ROUNDING_MODES, "illegal rounding mode")
9579 _dflt_rounding_mode = rm
9582def get_default_fp_sort(ctx=None):
9583 return FPSort(_dflt_fpsort_ebits, _dflt_fpsort_sbits, ctx)
9586def set_default_fp_sort(ebits, sbits, ctx=None):
9587 global _dflt_fpsort_ebits
9588 global _dflt_fpsort_sbits
9589 _dflt_fpsort_ebits = ebits
9590 _dflt_fpsort_sbits = sbits
9593def _dflt_rm(ctx=None):
9594 return get_default_rounding_mode(ctx)
9597def _dflt_fps(ctx=None):
9598 return get_default_fp_sort(ctx)
9601def _coerce_fp_expr_list(alist, ctx):
9602 first_fp_sort = None
9605 if first_fp_sort is None:
9606 first_fp_sort = a.sort()
9607 elif first_fp_sort == a.sort():
9608 pass # OK, same as before
9610 # we saw at least 2 different float sorts; something will
9611 # throw a sort mismatch later, for now assume None.
9612 first_fp_sort = None
9616 for i in range(len(alist)):
9618 is_repr = isinstance(a, str) and a.contains("2**(") and a.endswith(")")
9619 if is_repr or _is_int(a) or isinstance(a, (float, bool)):
9620 r.append(FPVal(a, None, first_fp_sort, ctx))
9623 return _coerce_expr_list(r, ctx)
9628class FPSortRef(SortRef):
9629 """Floating-point sort."""
9632 """Retrieves the number of bits reserved for the exponent in the FloatingPoint sort `self`.
9633 >>> b = FPSort(8, 24)
9637 return int(Z3_fpa_get_ebits(self.ctx_ref(), self.ast))
9640 """Retrieves the number of bits reserved for the significand in the FloatingPoint sort `self`.
9641 >>> b = FPSort(8, 24)
9645 return int(Z3_fpa_get_sbits(self.ctx_ref(), self.ast))
9647 def cast(self, val):
9648 """Try to cast `val` as a floating-point expression.
9649 >>> b = FPSort(8, 24)
9652 >>> b.cast(1.0).sexpr()
9653 '(fp #b0 #x7f #b00000000000000000000000)'
9657 _z3_assert(self.ctx == val.ctx, "Context mismatch")
9660 return FPVal(val, None, self, self.ctx)
9663def Float16(ctx=None):
9664 """Floating-point 16-bit (half) sort."""
9666 return FPSortRef(Z3_mk_fpa_sort_16(ctx.ref()), ctx)
9669def FloatHalf(ctx=None):
9670 """Floating-point 16-bit (half) sort."""
9672 return FPSortRef(Z3_mk_fpa_sort_half(ctx.ref()), ctx)
9675def Float32(ctx=None):
9676 """Floating-point 32-bit (single) sort."""
9678 return FPSortRef(Z3_mk_fpa_sort_32(ctx.ref()), ctx)
9681def FloatSingle(ctx=None):
9682 """Floating-point 32-bit (single) sort."""
9684 return FPSortRef(Z3_mk_fpa_sort_single(ctx.ref()), ctx)
9687def Float64(ctx=None):
9688 """Floating-point 64-bit (double) sort."""
9690 return FPSortRef(Z3_mk_fpa_sort_64(ctx.ref()), ctx)
9693def FloatDouble(ctx=None):
9694 """Floating-point 64-bit (double) sort."""
9696 return FPSortRef(Z3_mk_fpa_sort_double(ctx.ref()), ctx)
9699def Float128(ctx=None):
9700 """Floating-point 128-bit (quadruple) sort."""
9702 return FPSortRef(Z3_mk_fpa_sort_128(ctx.ref()), ctx)
9705def FloatQuadruple(ctx=None):
9706 """Floating-point 128-bit (quadruple) sort."""
9708 return FPSortRef(Z3_mk_fpa_sort_quadruple(ctx.ref()), ctx)
9711class FPRMSortRef(SortRef):
9712 """"Floating-point rounding mode sort."""
9716 """Return True if `s` is a Z3 floating-point sort.
9718 >>> is_fp_sort(FPSort(8, 24))
9720 >>> is_fp_sort(IntSort())
9723 return isinstance(s, FPSortRef)
9727 """Return True if `s` is a Z3 floating-point rounding mode sort.
9729 >>> is_fprm_sort(FPSort(8, 24))
9731 >>> is_fprm_sort(RNE().sort())
9734 return isinstance(s, FPRMSortRef)
9739class FPRef(ExprRef):
9740 """Floating-point expressions."""
9743 """Return the sort of the floating-point expression `self`.
9745 >>> x = FP('1.0', FPSort(8, 24))
9748 >>> x.sort() == FPSort(8, 24)
9751 return FPSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
9754 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9755 >>> b = FPSort(8, 24)
9759 return self.sort().ebits()
9762 """Retrieves the number of bits reserved for the exponent in the FloatingPoint expression `self`.
9763 >>> b = FPSort(8, 24)
9767 return self.sort().sbits()
9769 def as_string(self):
9770 """Return a Z3 floating point expression as a Python string."""
9771 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
9773 def __le__(self, other):
9774 return fpLEQ(self, other, self.ctx)
9776 def __lt__(self, other):
9777 return fpLT(self, other, self.ctx)
9779 def __ge__(self, other):
9780 return fpGEQ(self, other, self.ctx)
9782 def __gt__(self, other):
9783 return fpGT(self, other, self.ctx)
9785 def __add__(self, other):
9786 """Create the Z3 expression `self + other`.
9788 >>> x = FP('x', FPSort(8, 24))
9789 >>> y = FP('y', FPSort(8, 24))
9795 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9796 return fpAdd(_dflt_rm(), a, b, self.ctx)
9798 def __radd__(self, other):
9799 """Create the Z3 expression `other + self`.
9801 >>> x = FP('x', FPSort(8, 24))
9805 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9806 return fpAdd(_dflt_rm(), a, b, self.ctx)
9808 def __sub__(self, other):
9809 """Create the Z3 expression `self - other`.
9811 >>> x = FP('x', FPSort(8, 24))
9812 >>> y = FP('y', FPSort(8, 24))
9818 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9819 return fpSub(_dflt_rm(), a, b, self.ctx)
9821 def __rsub__(self, other):
9822 """Create the Z3 expression `other - self`.
9824 >>> x = FP('x', FPSort(8, 24))
9828 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9829 return fpSub(_dflt_rm(), a, b, self.ctx)
9831 def __mul__(self, other):
9832 """Create the Z3 expression `self * other`.
9834 >>> x = FP('x', FPSort(8, 24))
9835 >>> y = FP('y', FPSort(8, 24))
9843 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9844 return fpMul(_dflt_rm(), a, b, self.ctx)
9846 def __rmul__(self, other):
9847 """Create the Z3 expression `other * self`.
9849 >>> x = FP('x', FPSort(8, 24))
9850 >>> y = FP('y', FPSort(8, 24))
9856 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9857 return fpMul(_dflt_rm(), a, b, self.ctx)
9860 """Create the Z3 expression `+self`."""
9864 """Create the Z3 expression `-self`.
9866 >>> x = FP('x', Float32())
9872 def __div__(self, other):
9873 """Create the Z3 expression `self / other`.
9875 >>> x = FP('x', FPSort(8, 24))
9876 >>> y = FP('y', FPSort(8, 24))
9884 [a, b] = _coerce_fp_expr_list([self, other], self.ctx)
9885 return fpDiv(_dflt_rm(), a, b, self.ctx)
9887 def __rdiv__(self, other):
9888 """Create the Z3 expression `other / self`.
9890 >>> x = FP('x', FPSort(8, 24))
9891 >>> y = FP('y', FPSort(8, 24))
9897 [a, b] = _coerce_fp_expr_list([other, self], self.ctx)
9898 return fpDiv(_dflt_rm(), a, b, self.ctx)
9900 def __truediv__(self, other):
9901 """Create the Z3 expression division `self / other`."""
9902 return self.__div__(other)
9904 def __rtruediv__(self, other):
9905 """Create the Z3 expression division `other / self`."""
9906 return self.__rdiv__(other)
9908 def __mod__(self, other):
9909 """Create the Z3 expression mod `self % other`."""
9910 return fpRem(self, other)
9912 def __rmod__(self, other):
9913 """Create the Z3 expression mod `other % self`."""
9914 return fpRem(other, self)
9917class FPRMRef(ExprRef):
9918 """Floating-point rounding mode expressions"""
9920 def as_string(self):
9921 """Return a Z3 floating point expression as a Python string."""
9922 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
9925def RoundNearestTiesToEven(ctx=None):
9927 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
9932 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_even(ctx.ref()), ctx)
9935def RoundNearestTiesToAway(ctx=None):
9937 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
9942 return FPRMRef(Z3_mk_fpa_round_nearest_ties_to_away(ctx.ref()), ctx)
9945def RoundTowardPositive(ctx=None):
9947 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
9952 return FPRMRef(Z3_mk_fpa_round_toward_positive(ctx.ref()), ctx)
9955def RoundTowardNegative(ctx=None):
9957 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
9962 return FPRMRef(Z3_mk_fpa_round_toward_negative(ctx.ref()), ctx)
9965def RoundTowardZero(ctx=None):
9967 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
9972 return FPRMRef(Z3_mk_fpa_round_toward_zero(ctx.ref()), ctx)
9976 """Return `True` if `a` is a Z3 floating-point rounding mode expression.
9985 return isinstance(a, FPRMRef)
9988def is_fprm_value(a):
9989 """Return `True` if `a` is a Z3 floating-point rounding mode numeral value."""
9990 return is_fprm(a) and _is_numeral(a.ctx, a.ast)
9995class FPNumRef(FPRef):
9996 """The sign of the numeral.
9998 >>> x = FPVal(+1.0, FPSort(8, 24))
10001 >>> x = FPVal(-1.0, FPSort(8, 24))
10007 num = (ctypes.c_int)()
10008 nsign = Z3_fpa_get_numeral_sign(self.ctx.ref(), self.as_ast(), byref(num))
10010 raise Z3Exception("error retrieving the sign of a numeral.")
10011 return num.value != 0
10013 """The sign of a floating-point numeral as a bit-vector expression.
10015 Remark: NaN's are invalid arguments.
10018 def sign_as_bv(self):
10019 return BitVecNumRef(Z3_fpa_get_numeral_sign_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10021 """The significand of the numeral.
10023 >>> x = FPVal(2.5, FPSort(8, 24))
10024 >>> x.significand()
10028 def significand(self):
10029 return Z3_fpa_get_numeral_significand_string(self.ctx.ref(), self.as_ast())
10031 """The significand of the numeral as a long.
10033 >>> x = FPVal(2.5, FPSort(8, 24))
10034 >>> x.significand_as_long()
10038 def significand_as_long(self):
10039 ptr = (ctypes.c_ulonglong * 1)()
10040 if not Z3_fpa_get_numeral_significand_uint64(self.ctx.ref(), self.as_ast(), ptr):
10041 raise Z3Exception("error retrieving the significand of a numeral.")
10044 """The significand of the numeral as a bit-vector expression.
10046 Remark: NaN are invalid arguments.
10049 def significand_as_bv(self):
10050 return BitVecNumRef(Z3_fpa_get_numeral_significand_bv(self.ctx.ref(), self.as_ast()), self.ctx)
10052 """The exponent of the numeral.
10054 >>> x = FPVal(2.5, FPSort(8, 24))
10059 def exponent(self, biased=True):
10060 return Z3_fpa_get_numeral_exponent_string(self.ctx.ref(), self.as_ast(), biased)
10062 """The exponent of the numeral as a long.
10064 >>> x = FPVal(2.5, FPSort(8, 24))
10065 >>> x.exponent_as_long()
10069 def exponent_as_long(self, biased=True):
10070 ptr = (ctypes.c_longlong * 1)()
10071 if not Z3_fpa_get_numeral_exponent_int64(self.ctx.ref(), self.as_ast(), ptr, biased):
10072 raise Z3Exception("error retrieving the exponent of a numeral.")
10075 """The exponent of the numeral as a bit-vector expression.
10077 Remark: NaNs are invalid arguments.
10080 def exponent_as_bv(self, biased=True):
10081 return BitVecNumRef(Z3_fpa_get_numeral_exponent_bv(self.ctx.ref(), self.as_ast(), biased), self.ctx)
10083 """Indicates whether the numeral is a NaN."""
10086 return Z3_fpa_is_numeral_nan(self.ctx.ref(), self.as_ast())
10088 """Indicates whether the numeral is +oo or -oo."""
10091 return Z3_fpa_is_numeral_inf(self.ctx.ref(), self.as_ast())
10093 """Indicates whether the numeral is +zero or -zero."""
10096 return Z3_fpa_is_numeral_zero(self.ctx.ref(), self.as_ast())
10098 """Indicates whether the numeral is normal."""
10100 def isNormal(self):
10101 return Z3_fpa_is_numeral_normal(self.ctx.ref(), self.as_ast())
10103 """Indicates whether the numeral is subnormal."""
10105 def isSubnormal(self):
10106 return Z3_fpa_is_numeral_subnormal(self.ctx.ref(), self.as_ast())
10108 """Indicates whether the numeral is positive."""
10110 def isPositive(self):
10111 return Z3_fpa_is_numeral_positive(self.ctx.ref(), self.as_ast())
10113 """Indicates whether the numeral is negative."""
10115 def isNegative(self):
10116 return Z3_fpa_is_numeral_negative(self.ctx.ref(), self.as_ast())
10119 The string representation of the numeral.
10121 >>> x = FPVal(20, FPSort(8, 24))
10126 def as_string(self):
10127 s = Z3_get_numeral_string(self.ctx.ref(), self.as_ast())
10128 return ("FPVal(%s, %s)" % (s, self.sort()))
10130 def py_value(self):
10131 bv = simplify(fpToIEEEBV(self))
10132 binary = bv.py_value()
10133 if not isinstance(binary, int):
10135 # Decode the IEEE 754 binary representation
10137 bytes_rep = binary.to_bytes(8, byteorder='big')
10138 return struct.unpack('>d', bytes_rep)[0]
10142 """Return `True` if `a` is a Z3 floating-point expression.
10144 >>> b = FP('b', FPSort(8, 24))
10149 >>> is_fp(Int('x'))
10152 return isinstance(a, FPRef)
10156 """Return `True` if `a` is a Z3 floating-point numeral value.
10158 >>> b = FP('b', FPSort(8, 24))
10161 >>> b = FPVal(1.0, FPSort(8, 24))
10167 return is_fp(a) and _is_numeral(a.ctx, a.ast)
10170def FPSort(ebits, sbits, ctx=None):
10171 """Return a Z3 floating-point sort of the given sizes. If `ctx=None`, then the global context is used.
10173 >>> Single = FPSort(8, 24)
10174 >>> Double = FPSort(11, 53)
10177 >>> x = Const('x', Single)
10178 >>> eq(x, FP('x', FPSort(8, 24)))
10181 ctx = _get_ctx(ctx)
10182 return FPSortRef(Z3_mk_fpa_sort(ctx.ref(), ebits, sbits), ctx)
10185def _to_float_str(val, exp=0):
10186 if isinstance(val, float):
10187 if math.isnan(val):
10190 sone = math.copysign(1.0, val)
10195 elif val == float("+inf"):
10197 elif val == float("-inf"):
10200 v = val.as_integer_ratio()
10203 rvs = str(num) + "/" + str(den)
10204 res = rvs + "p" + _to_int_str(exp)
10205 elif isinstance(val, bool):
10212 elif isinstance(val, str):
10213 inx = val.find("*(2**")
10216 elif val[-1] == ")":
10218 exp = str(int(val[inx + 5:-1]) + int(exp))
10220 _z3_assert(False, "String does not have floating-point numeral form.")
10222 _z3_assert(False, "Python value cannot be used to create floating-point numerals.")
10226 return res + "p" + exp
10230 """Create a Z3 floating-point NaN term.
10232 >>> s = FPSort(8, 24)
10233 >>> set_fpa_pretty(True)
10236 >>> pb = get_fpa_pretty()
10237 >>> set_fpa_pretty(False)
10239 fpNaN(FPSort(8, 24))
10240 >>> set_fpa_pretty(pb)
10242 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10243 return FPNumRef(Z3_mk_fpa_nan(s.ctx_ref(), s.ast), s.ctx)
10246def fpPlusInfinity(s):
10247 """Create a Z3 floating-point +oo term.
10249 >>> s = FPSort(8, 24)
10250 >>> pb = get_fpa_pretty()
10251 >>> set_fpa_pretty(True)
10252 >>> fpPlusInfinity(s)
10254 >>> set_fpa_pretty(False)
10255 >>> fpPlusInfinity(s)
10256 fpPlusInfinity(FPSort(8, 24))
10257 >>> set_fpa_pretty(pb)
10259 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10260 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, False), s.ctx)
10263def fpMinusInfinity(s):
10264 """Create a Z3 floating-point -oo term."""
10265 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10266 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, True), s.ctx)
10269def fpInfinity(s, negative):
10270 """Create a Z3 floating-point +oo or -oo term."""
10271 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10272 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10273 return FPNumRef(Z3_mk_fpa_inf(s.ctx_ref(), s.ast, negative), s.ctx)
10277 """Create a Z3 floating-point +0.0 term."""
10278 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10279 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, False), s.ctx)
10283 """Create a Z3 floating-point -0.0 term."""
10284 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10285 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, True), s.ctx)
10288def fpZero(s, negative):
10289 """Create a Z3 floating-point +0.0 or -0.0 term."""
10290 _z3_assert(isinstance(s, FPSortRef), "sort mismatch")
10291 _z3_assert(isinstance(negative, bool), "expected Boolean flag")
10292 return FPNumRef(Z3_mk_fpa_zero(s.ctx_ref(), s.ast, negative), s.ctx)
10295def FPVal(sig, exp=None, fps=None, ctx=None):
10296 """Return a floating-point value of value `val` and sort `fps`.
10297 If `ctx=None`, then the global context is used.
10299 >>> v = FPVal(20.0, FPSort(8, 24))
10302 >>> print("0x%.8x" % v.exponent_as_long(False))
10304 >>> v = FPVal(2.25, FPSort(8, 24))
10307 >>> v = FPVal(-2.25, FPSort(8, 24))
10310 >>> FPVal(-0.0, FPSort(8, 24))
10312 >>> FPVal(0.0, FPSort(8, 24))
10314 >>> FPVal(+0.0, FPSort(8, 24))
10317 ctx = _get_ctx(ctx)
10318 if is_fp_sort(exp):
10322 fps = _dflt_fps(ctx)
10323 _z3_assert(is_fp_sort(fps), "sort mismatch")
10326 val = _to_float_str(sig)
10327 if val == "NaN" or val == "nan":
10329 elif val == "-0.0":
10330 return fpMinusZero(fps)
10331 elif val == "0.0" or val == "+0.0":
10332 return fpPlusZero(fps)
10333 elif val == "+oo" or val == "+inf" or val == "+Inf":
10334 return fpPlusInfinity(fps)
10335 elif val == "-oo" or val == "-inf" or val == "-Inf":
10336 return fpMinusInfinity(fps)
10338 return FPNumRef(Z3_mk_numeral(ctx.ref(), val, fps.ast), ctx)
10341def FP(name, fpsort, ctx=None):
10342 """Return a floating-point constant named `name`.
10343 `fpsort` is the floating-point sort.
10344 If `ctx=None`, then the global context is used.
10346 >>> x = FP('x', FPSort(8, 24))
10353 >>> word = FPSort(8, 24)
10354 >>> x2 = FP('x', word)
10358 if isinstance(fpsort, FPSortRef) and ctx is None:
10361 ctx = _get_ctx(ctx)
10362 return FPRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), fpsort.ast), ctx)
10365def FPs(names, fpsort, ctx=None):
10366 """Return an array of floating-point constants.
10368 >>> x, y, z = FPs('x y z', FPSort(8, 24))
10375 >>> fpMul(RNE(), fpAdd(RNE(), x, y), z)
10378 ctx = _get_ctx(ctx)
10379 if isinstance(names, str):
10380 names = names.split(" ")
10381 return [FP(name, fpsort, ctx) for name in names]
10384def fpAbs(a, ctx=None):
10385 """Create a Z3 floating-point absolute value expression.
10387 >>> s = FPSort(8, 24)
10389 >>> x = FPVal(1.0, s)
10392 >>> y = FPVal(-20.0, s)
10396 fpAbs(-1.25*(2**4))
10397 >>> fpAbs(-1.25*(2**4))
10398 fpAbs(-1.25*(2**4))
10399 >>> fpAbs(x).sort()
10402 ctx = _get_ctx(ctx)
10403 [a] = _coerce_fp_expr_list([a], ctx)
10404 return FPRef(Z3_mk_fpa_abs(ctx.ref(), a.as_ast()), ctx)
10407def fpNeg(a, ctx=None):
10408 """Create a Z3 floating-point addition expression.
10410 >>> s = FPSort(8, 24)
10415 >>> fpNeg(x).sort()
10418 ctx = _get_ctx(ctx)
10419 [a] = _coerce_fp_expr_list([a], ctx)
10420 return FPRef(Z3_mk_fpa_neg(ctx.ref(), a.as_ast()), ctx)
10423def _mk_fp_unary(f, rm, a, ctx):
10424 ctx = _get_ctx(ctx)
10425 [a] = _coerce_fp_expr_list([a], ctx)
10427 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10428 _z3_assert(is_fp(a), "Second argument must be a Z3 floating-point expression")
10429 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast()), ctx)
10432def _mk_fp_unary_pred(f, a, ctx):
10433 ctx = _get_ctx(ctx)
10434 [a] = _coerce_fp_expr_list([a], ctx)
10436 _z3_assert(is_fp(a), "First argument must be a Z3 floating-point expression")
10437 return BoolRef(f(ctx.ref(), a.as_ast()), ctx)
10440def _mk_fp_bin(f, rm, a, b, ctx):
10441 ctx = _get_ctx(ctx)
10442 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10444 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10445 _z3_assert(is_fp(a) or is_fp(b), "Second or third argument must be a Z3 floating-point expression")
10446 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast()), ctx)
10449def _mk_fp_bin_norm(f, a, b, ctx):
10450 ctx = _get_ctx(ctx)
10451 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10453 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10454 return FPRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10457def _mk_fp_bin_pred(f, a, b, ctx):
10458 ctx = _get_ctx(ctx)
10459 [a, b] = _coerce_fp_expr_list([a, b], ctx)
10461 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10462 return BoolRef(f(ctx.ref(), a.as_ast(), b.as_ast()), ctx)
10465def _mk_fp_tern(f, rm, a, b, c, ctx):
10466 ctx = _get_ctx(ctx)
10467 [a, b, c] = _coerce_fp_expr_list([a, b, c], ctx)
10469 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10470 _z3_assert(is_fp(a) or is_fp(b) or is_fp(
10471 c), "Second, third or fourth argument must be a Z3 floating-point expression")
10472 return FPRef(f(ctx.ref(), rm.as_ast(), a.as_ast(), b.as_ast(), c.as_ast()), ctx)
10475def fpAdd(rm, a, b, ctx=None):
10476 """Create a Z3 floating-point addition expression.
10478 >>> s = FPSort(8, 24)
10482 >>> fpAdd(rm, x, y)
10484 >>> fpAdd(RTZ(), x, y) # default rounding mode is RTZ
10486 >>> fpAdd(rm, x, y).sort()
10489 return _mk_fp_bin(Z3_mk_fpa_add, rm, a, b, ctx)
10492def fpSub(rm, a, b, ctx=None):
10493 """Create a Z3 floating-point subtraction expression.
10495 >>> s = FPSort(8, 24)
10499 >>> fpSub(rm, x, y)
10501 >>> fpSub(rm, x, y).sort()
10504 return _mk_fp_bin(Z3_mk_fpa_sub, rm, a, b, ctx)
10507def fpMul(rm, a, b, ctx=None):
10508 """Create a Z3 floating-point multiplication expression.
10510 >>> s = FPSort(8, 24)
10514 >>> fpMul(rm, x, y)
10516 >>> fpMul(rm, x, y).sort()
10519 return _mk_fp_bin(Z3_mk_fpa_mul, rm, a, b, ctx)
10522def fpDiv(rm, a, b, ctx=None):
10523 """Create a Z3 floating-point division expression.
10525 >>> s = FPSort(8, 24)
10529 >>> fpDiv(rm, x, y)
10531 >>> fpDiv(rm, x, y).sort()
10534 return _mk_fp_bin(Z3_mk_fpa_div, rm, a, b, ctx)
10537def fpRem(a, b, ctx=None):
10538 """Create a Z3 floating-point remainder expression.
10540 >>> s = FPSort(8, 24)
10545 >>> fpRem(x, y).sort()
10548 return _mk_fp_bin_norm(Z3_mk_fpa_rem, a, b, ctx)
10551def fpMin(a, b, ctx=None):
10552 """Create a Z3 floating-point minimum expression.
10554 >>> s = FPSort(8, 24)
10560 >>> fpMin(x, y).sort()
10563 return _mk_fp_bin_norm(Z3_mk_fpa_min, a, b, ctx)
10566def fpMax(a, b, ctx=None):
10567 """Create a Z3 floating-point maximum expression.
10569 >>> s = FPSort(8, 24)
10575 >>> fpMax(x, y).sort()
10578 return _mk_fp_bin_norm(Z3_mk_fpa_max, a, b, ctx)
10581def fpFMA(rm, a, b, c, ctx=None):
10582 """Create a Z3 floating-point fused multiply-add expression.
10584 return _mk_fp_tern(Z3_mk_fpa_fma, rm, a, b, c, ctx)
10587def fpSqrt(rm, a, ctx=None):
10588 """Create a Z3 floating-point square root expression.
10590 return _mk_fp_unary(Z3_mk_fpa_sqrt, rm, a, ctx)
10593def fpRoundToIntegral(rm, a, ctx=None):
10594 """Create a Z3 floating-point roundToIntegral expression.
10596 return _mk_fp_unary(Z3_mk_fpa_round_to_integral, rm, a, ctx)
10599def fpIsNaN(a, ctx=None):
10600 """Create a Z3 floating-point isNaN expression.
10602 >>> s = FPSort(8, 24)
10608 return _mk_fp_unary_pred(Z3_mk_fpa_is_nan, a, ctx)
10611def fpIsInf(a, ctx=None):
10612 """Create a Z3 floating-point isInfinite expression.
10614 >>> s = FPSort(8, 24)
10619 return _mk_fp_unary_pred(Z3_mk_fpa_is_infinite, a, ctx)
10622def fpIsZero(a, ctx=None):
10623 """Create a Z3 floating-point isZero expression.
10625 return _mk_fp_unary_pred(Z3_mk_fpa_is_zero, a, ctx)
10628def fpIsNormal(a, ctx=None):
10629 """Create a Z3 floating-point isNormal expression.
10631 return _mk_fp_unary_pred(Z3_mk_fpa_is_normal, a, ctx)
10634def fpIsSubnormal(a, ctx=None):
10635 """Create a Z3 floating-point isSubnormal expression.
10637 return _mk_fp_unary_pred(Z3_mk_fpa_is_subnormal, a, ctx)
10640def fpIsNegative(a, ctx=None):
10641 """Create a Z3 floating-point isNegative expression.
10643 return _mk_fp_unary_pred(Z3_mk_fpa_is_negative, a, ctx)
10646def fpIsPositive(a, ctx=None):
10647 """Create a Z3 floating-point isPositive expression.
10649 return _mk_fp_unary_pred(Z3_mk_fpa_is_positive, a, ctx)
10652def _check_fp_args(a, b):
10654 _z3_assert(is_fp(a) or is_fp(b), "First or second argument must be a Z3 floating-point expression")
10657def fpLT(a, b, ctx=None):
10658 """Create the Z3 floating-point expression `other < self`.
10660 >>> x, y = FPs('x y', FPSort(8, 24))
10663 >>> (x < y).sexpr()
10666 return _mk_fp_bin_pred(Z3_mk_fpa_lt, a, b, ctx)
10669def fpLEQ(a, b, ctx=None):
10670 """Create the Z3 floating-point expression `other <= self`.
10672 >>> x, y = FPs('x y', FPSort(8, 24))
10675 >>> (x <= y).sexpr()
10678 return _mk_fp_bin_pred(Z3_mk_fpa_leq, a, b, ctx)
10681def fpGT(a, b, ctx=None):
10682 """Create the Z3 floating-point expression `other > self`.
10684 >>> x, y = FPs('x y', FPSort(8, 24))
10687 >>> (x > y).sexpr()
10690 return _mk_fp_bin_pred(Z3_mk_fpa_gt, a, b, ctx)
10693def fpGEQ(a, b, ctx=None):
10694 """Create the Z3 floating-point expression `other >= self`.
10696 >>> x, y = FPs('x y', FPSort(8, 24))
10699 >>> (x >= y).sexpr()
10702 return _mk_fp_bin_pred(Z3_mk_fpa_geq, a, b, ctx)
10705def fpEQ(a, b, ctx=None):
10706 """Create the Z3 floating-point expression `fpEQ(other, self)`.
10708 >>> x, y = FPs('x y', FPSort(8, 24))
10711 >>> fpEQ(x, y).sexpr()
10714 return _mk_fp_bin_pred(Z3_mk_fpa_eq, a, b, ctx)
10717def fpNEQ(a, b, ctx=None):
10718 """Create the Z3 floating-point expression `Not(fpEQ(other, self))`.
10720 >>> x, y = FPs('x y', FPSort(8, 24))
10723 >>> (x != y).sexpr()
10726 return Not(fpEQ(a, b, ctx))
10729def fpFP(sgn, exp, sig, ctx=None):
10730 """Create the Z3 floating-point value `fpFP(sgn, sig, exp)` from the three bit-vectors sgn, sig, and exp.
10732 >>> s = FPSort(8, 24)
10733 >>> x = fpFP(BitVecVal(1, 1), BitVecVal(2**7-1, 8), BitVecVal(2**22, 23))
10735 fpFP(1, 127, 4194304)
10736 >>> xv = FPVal(-1.5, s)
10739 >>> slvr = Solver()
10740 >>> slvr.add(fpEQ(x, xv))
10743 >>> xv = FPVal(+1.5, s)
10746 >>> slvr = Solver()
10747 >>> slvr.add(fpEQ(x, xv))
10751 _z3_assert(is_bv(sgn) and is_bv(exp) and is_bv(sig), "sort mismatch")
10752 _z3_assert(sgn.sort().size() == 1, "sort mismatch")
10753 ctx = _get_ctx(ctx)
10754 _z3_assert(ctx == sgn.ctx == exp.ctx == sig.ctx, "context mismatch")
10755 return FPRef(Z3_mk_fpa_fp(ctx.ref(), sgn.ast, exp.ast, sig.ast), ctx)
10758def fpToFP(a1, a2=None, a3=None, ctx=None):
10759 """Create a Z3 floating-point conversion expression from other term sorts
10762 From a bit-vector term in IEEE 754-2008 format:
10763 >>> x = FPVal(1.0, Float32())
10764 >>> x_bv = fpToIEEEBV(x)
10765 >>> simplify(fpToFP(x_bv, Float32()))
10768 From a floating-point term with different precision:
10769 >>> x = FPVal(1.0, Float32())
10770 >>> x_db = fpToFP(RNE(), x, Float64())
10775 >>> x_r = RealVal(1.5)
10776 >>> simplify(fpToFP(RNE(), x_r, Float32()))
10779 From a signed bit-vector term:
10780 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10781 >>> simplify(fpToFP(RNE(), x_signed, Float32()))
10784 ctx = _get_ctx(ctx)
10785 if is_bv(a1) and is_fp_sort(a2):
10786 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), a1.ast, a2.ast), ctx)
10787 elif is_fprm(a1) and is_fp(a2) and is_fp_sort(a3):
10788 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10789 elif is_fprm(a1) and is_real(a2) and is_fp_sort(a3):
10790 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10791 elif is_fprm(a1) and is_bv(a2) and is_fp_sort(a3):
10792 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), a1.ast, a2.ast, a3.ast), ctx)
10794 raise Z3Exception("Unsupported combination of arguments for conversion to floating-point term.")
10797def fpBVToFP(v, sort, ctx=None):
10798 """Create a Z3 floating-point conversion expression that represents the
10799 conversion from a bit-vector term to a floating-point term.
10801 >>> x_bv = BitVecVal(0x3F800000, 32)
10802 >>> x_fp = fpBVToFP(x_bv, Float32())
10808 _z3_assert(is_bv(v), "First argument must be a Z3 bit-vector expression")
10809 _z3_assert(is_fp_sort(sort), "Second argument must be a Z3 floating-point sort.")
10810 ctx = _get_ctx(ctx)
10811 return FPRef(Z3_mk_fpa_to_fp_bv(ctx.ref(), v.ast, sort.ast), ctx)
10814def fpFPToFP(rm, v, sort, ctx=None):
10815 """Create a Z3 floating-point conversion expression that represents the
10816 conversion from a floating-point term to a floating-point term of different precision.
10818 >>> x_sgl = FPVal(1.0, Float32())
10819 >>> x_dbl = fpFPToFP(RNE(), x_sgl, Float64())
10822 >>> simplify(x_dbl)
10827 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10828 _z3_assert(is_fp(v), "Second argument must be a Z3 floating-point expression.")
10829 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10830 ctx = _get_ctx(ctx)
10831 return FPRef(Z3_mk_fpa_to_fp_float(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10834def fpRealToFP(rm, v, sort, ctx=None):
10835 """Create a Z3 floating-point conversion expression that represents the
10836 conversion from a real term to a floating-point term.
10838 >>> x_r = RealVal(1.5)
10839 >>> x_fp = fpRealToFP(RNE(), x_r, Float32())
10845 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10846 _z3_assert(is_real(v), "Second argument must be a Z3 expression or real sort.")
10847 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10848 ctx = _get_ctx(ctx)
10849 return FPRef(Z3_mk_fpa_to_fp_real(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10852def fpSignedToFP(rm, v, sort, ctx=None):
10853 """Create a Z3 floating-point conversion expression that represents the
10854 conversion from a signed bit-vector term (encoding an integer) to a floating-point term.
10856 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10857 >>> x_fp = fpSignedToFP(RNE(), x_signed, Float32())
10859 fpToFP(RNE(), 4294967291)
10863 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10864 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
10865 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10866 ctx = _get_ctx(ctx)
10867 return FPRef(Z3_mk_fpa_to_fp_signed(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10870def fpUnsignedToFP(rm, v, sort, ctx=None):
10871 """Create a Z3 floating-point conversion expression that represents the
10872 conversion from an unsigned bit-vector term (encoding an integer) to a floating-point term.
10874 >>> x_signed = BitVecVal(-5, BitVecSort(32))
10875 >>> x_fp = fpUnsignedToFP(RNE(), x_signed, Float32())
10877 fpToFPUnsigned(RNE(), 4294967291)
10881 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression.")
10882 _z3_assert(is_bv(v), "Second argument must be a Z3 bit-vector expression")
10883 _z3_assert(is_fp_sort(sort), "Third argument must be a Z3 floating-point sort.")
10884 ctx = _get_ctx(ctx)
10885 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, v.ast, sort.ast), ctx)
10888def fpToFPUnsigned(rm, x, s, ctx=None):
10889 """Create a Z3 floating-point conversion expression, from unsigned bit-vector to floating-point expression."""
10891 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10892 _z3_assert(is_bv(x), "Second argument must be a Z3 bit-vector expression")
10893 _z3_assert(is_fp_sort(s), "Third argument must be Z3 floating-point sort")
10894 ctx = _get_ctx(ctx)
10895 return FPRef(Z3_mk_fpa_to_fp_unsigned(ctx.ref(), rm.ast, x.ast, s.ast), ctx)
10898def fpToSBV(rm, x, s, ctx=None):
10899 """Create a Z3 floating-point conversion expression, from floating-point expression to signed bit-vector.
10901 >>> x = FP('x', FPSort(8, 24))
10902 >>> y = fpToSBV(RTZ(), x, BitVecSort(32))
10903 >>> print(is_fp(x))
10905 >>> print(is_bv(y))
10907 >>> print(is_fp(y))
10909 >>> print(is_bv(x))
10913 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10914 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
10915 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
10916 ctx = _get_ctx(ctx)
10917 return BitVecRef(Z3_mk_fpa_to_sbv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
10920def fpToUBV(rm, x, s, ctx=None):
10921 """Create a Z3 floating-point conversion expression, from floating-point expression to unsigned bit-vector.
10923 >>> x = FP('x', FPSort(8, 24))
10924 >>> y = fpToUBV(RTZ(), x, BitVecSort(32))
10925 >>> print(is_fp(x))
10927 >>> print(is_bv(y))
10929 >>> print(is_fp(y))
10931 >>> print(is_bv(x))
10935 _z3_assert(is_fprm(rm), "First argument must be a Z3 floating-point rounding mode expression")
10936 _z3_assert(is_fp(x), "Second argument must be a Z3 floating-point expression")
10937 _z3_assert(is_bv_sort(s), "Third argument must be Z3 bit-vector sort")
10938 ctx = _get_ctx(ctx)
10939 return BitVecRef(Z3_mk_fpa_to_ubv(ctx.ref(), rm.ast, x.ast, s.size()), ctx)
10942def fpToReal(x, ctx=None):
10943 """Create a Z3 floating-point conversion expression, from floating-point expression to real.
10945 >>> x = FP('x', FPSort(8, 24))
10946 >>> y = fpToReal(x)
10947 >>> print(is_fp(x))
10949 >>> print(is_real(y))
10951 >>> print(is_fp(y))
10953 >>> print(is_real(x))
10957 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
10958 ctx = _get_ctx(ctx)
10959 return ArithRef(Z3_mk_fpa_to_real(ctx.ref(), x.ast), ctx)
10962def fpToIEEEBV(x, ctx=None):
10963 """\brief Conversion of a floating-point term into a bit-vector term in IEEE 754-2008 format.
10965 The size of the resulting bit-vector is automatically determined.
10967 Note that IEEE 754-2008 allows multiple different representations of NaN. This conversion
10968 knows only one NaN and it will always produce the same bit-vector representation of
10971 >>> x = FP('x', FPSort(8, 24))
10972 >>> y = fpToIEEEBV(x)
10973 >>> print(is_fp(x))
10975 >>> print(is_bv(y))
10977 >>> print(is_fp(y))
10979 >>> print(is_bv(x))
10983 _z3_assert(is_fp(x), "First argument must be a Z3 floating-point expression")
10984 ctx = _get_ctx(ctx)
10985 return BitVecRef(Z3_mk_fpa_to_ieee_bv(ctx.ref(), x.ast), ctx)
10988#########################################
10990# Strings, Sequences and Regular expressions
10992#########################################
10994class SeqSortRef(SortRef):
10995 """Sequence sort."""
10997 def is_string(self):
10998 """Determine if sort is a string
10999 >>> s = StringSort()
11002 >>> s = SeqSort(IntSort())
11006 return Z3_is_string_sort(self.ctx_ref(), self.ast)
11009 return _to_sort_ref(Z3_get_seq_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11011class CharSortRef(SortRef):
11012 """Character sort."""
11015def StringSort(ctx=None):
11016 """Create a string sort
11017 >>> s = StringSort()
11021 ctx = _get_ctx(ctx)
11022 return SeqSortRef(Z3_mk_string_sort(ctx.ref()), ctx)
11024def CharSort(ctx=None):
11025 """Create a character sort
11026 >>> ch = CharSort()
11030 ctx = _get_ctx(ctx)
11031 return CharSortRef(Z3_mk_char_sort(ctx.ref()), ctx)
11035 """Create a sequence sort over elements provided in the argument
11036 >>> s = SeqSort(IntSort())
11037 >>> s == Unit(IntVal(1)).sort()
11040 return SeqSortRef(Z3_mk_seq_sort(s.ctx_ref(), s.ast), s.ctx)
11043class SeqRef(ExprRef):
11044 """Sequence expression."""
11047 return SeqSortRef(Z3_get_sort(self.ctx_ref(), self.as_ast()), self.ctx)
11049 def __add__(self, other):
11050 return Concat(self, other)
11052 def __radd__(self, other):
11053 return Concat(other, self)
11055 def __getitem__(self, i):
11057 i = IntVal(i, self.ctx)
11058 return _to_expr_ref(Z3_mk_seq_nth(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11062 i = IntVal(i, self.ctx)
11063 return SeqRef(Z3_mk_seq_at(self.ctx_ref(), self.as_ast(), i.as_ast()), self.ctx)
11065 def is_string(self):
11066 return Z3_is_string_sort(self.ctx_ref(), Z3_get_sort(self.ctx_ref(), self.as_ast()))
11068 def is_string_value(self):
11069 return Z3_is_string(self.ctx_ref(), self.as_ast())
11071 def as_string(self):
11072 """Return a string representation of sequence expression."""
11073 if self.is_string_value():
11074 string_length = ctypes.c_uint()
11075 chars = Z3_get_lstring(self.ctx_ref(), self.as_ast(), byref(string_length))
11076 return string_at(chars, size=string_length.value).decode("latin-1")
11077 return Z3_ast_to_string(self.ctx_ref(), self.as_ast())
11079 def py_value(self):
11080 return self.as_string()
11082 def __le__(self, other):
11083 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11085 def __lt__(self, other):
11086 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11088 def __ge__(self, other):
11089 return _to_expr_ref(Z3_mk_str_le(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11091 def __gt__(self, other):
11092 return _to_expr_ref(Z3_mk_str_lt(self.ctx_ref(), other.as_ast(), self.as_ast()), self.ctx)
11095def _coerce_char(ch, ctx=None):
11096 if isinstance(ch, str):
11097 ctx = _get_ctx(ctx)
11098 ch = CharVal(ch, ctx)
11099 if not is_expr(ch):
11100 raise Z3Exception("Character expression expected")
11103class CharRef(ExprRef):
11104 """Character expression."""
11106 def __le__(self, other):
11107 other = _coerce_char(other, self.ctx)
11108 return _to_expr_ref(Z3_mk_char_le(self.ctx_ref(), self.as_ast(), other.as_ast()), self.ctx)
11111 return _to_expr_ref(Z3_mk_char_to_int(self.ctx_ref(), self.as_ast()), self.ctx)
11114 return _to_expr_ref(Z3_mk_char_to_bv(self.ctx_ref(), self.as_ast()), self.ctx)
11116 def is_digit(self):
11117 return _to_expr_ref(Z3_mk_char_is_digit(self.ctx_ref(), self.as_ast()), self.ctx)
11120def CharVal(ch, ctx=None):
11121 ctx = _get_ctx(ctx)
11122 if isinstance(ch, str):
11124 if not isinstance(ch, int):
11125 raise Z3Exception("character value should be an ordinal")
11126 return _to_expr_ref(Z3_mk_char(ctx.ref(), ch), ctx)
11129 if not is_expr(bv):
11130 raise Z3Exception("Bit-vector expression needed")
11131 return _to_expr_ref(Z3_mk_char_from_bv(bv.ctx_ref(), bv.as_ast()), bv.ctx)
11133def CharToBv(ch, ctx=None):
11134 ch = _coerce_char(ch, ctx)
11137def CharToInt(ch, ctx=None):
11138 ch = _coerce_char(ch, ctx)
11141def CharIsDigit(ch, ctx=None):
11142 ch = _coerce_char(ch, ctx)
11143 return ch.is_digit()
11145def _coerce_seq(s, ctx=None):
11146 if isinstance(s, str):
11147 ctx = _get_ctx(ctx)
11148 s = StringVal(s, ctx)
11150 raise Z3Exception("Non-expression passed as a sequence")
11152 raise Z3Exception("Non-sequence passed as a sequence")
11156def _get_ctx2(a, b, ctx=None):
11167 """Return `True` if `a` is a Z3 sequence expression.
11168 >>> print (is_seq(Unit(IntVal(0))))
11170 >>> print (is_seq(StringVal("abc")))
11173 return isinstance(a, SeqRef)
11176def is_string(a: Any) -> bool:
11177 """Return `True` if `a` is a Z3 string expression.
11178 >>> print (is_string(StringVal("ab")))
11181 return isinstance(a, SeqRef) and a.is_string()
11184def is_string_value(a: Any) -> bool:
11185 """return 'True' if 'a' is a Z3 string constant expression.
11186 >>> print (is_string_value(StringVal("a")))
11188 >>> print (is_string_value(StringVal("a") + StringVal("b")))
11191 return isinstance(a, SeqRef) and a.is_string_value()
11193def StringVal(s, ctx=None):
11194 """create a string expression"""
11195 s = "".join(str(ch) if 32 <= ord(ch) and ord(ch) < 127 else "\\u{%x}" % (ord(ch)) for ch in s)
11196 ctx = _get_ctx(ctx)
11197 return SeqRef(Z3_mk_string(ctx.ref(), s), ctx)
11200def String(name, ctx=None):
11201 """Return a string constant named `name`. If `ctx=None`, then the global context is used.
11203 >>> x = String('x')
11205 ctx = _get_ctx(ctx)
11206 return SeqRef(Z3_mk_const(ctx.ref(), to_symbol(name, ctx), StringSort(ctx).ast), ctx)
11209def Strings(names, ctx=None):
11210 """Return a tuple of String constants. """
11211 ctx = _get_ctx(ctx)
11212 if isinstance(names, str):
11213 names = names.split(" ")
11214 return [String(name, ctx) for name in names]
11217def SubString(s, offset, length):
11218 """Extract substring or subsequence starting at offset.
11220 This is a convenience function that redirects to Extract(s, offset, length).
11222 >>> s = StringVal("hello world")
11223 >>> SubString(s, 6, 5) # Extract "world"
11224 str.substr("hello world", 6, 5)
11225 >>> simplify(SubString(StringVal("hello"), 1, 3))
11228 return Extract(s, offset, length)
11231def SubSeq(s, offset, length):
11232 """Extract substring or subsequence starting at offset.
11234 This is a convenience function that redirects to Extract(s, offset, length).
11236 >>> s = StringVal("hello world")
11237 >>> SubSeq(s, 0, 5) # Extract "hello"
11238 str.substr("hello world", 0, 5)
11239 >>> simplify(SubSeq(StringVal("testing"), 2, 4))
11242 return Extract(s, offset, length)
11246 """Create the empty sequence of the given sort
11247 >>> e = Empty(StringSort())
11248 >>> e2 = StringVal("")
11249 >>> print(e.eq(e2))
11251 >>> e3 = Empty(SeqSort(IntSort()))
11254 >>> e4 = Empty(ReSort(SeqSort(IntSort())))
11256 Empty(ReSort(Seq(Int)))
11258 if isinstance(s, SeqSortRef):
11259 return SeqRef(Z3_mk_seq_empty(s.ctx_ref(), s.ast), s.ctx)
11260 if isinstance(s, ReSortRef):
11261 return ReRef(Z3_mk_re_empty(s.ctx_ref(), s.ast), s.ctx)
11262 raise Z3Exception("Non-sequence, non-regular expression sort passed to Empty")
11266 """Create the regular expression that accepts the universal language
11267 >>> e = Full(ReSort(SeqSort(IntSort())))
11269 Full(ReSort(Seq(Int)))
11270 >>> e1 = Full(ReSort(StringSort()))
11272 Full(ReSort(String))
11274 if isinstance(s, ReSortRef):
11275 return ReRef(Z3_mk_re_full(s.ctx_ref(), s.ast), s.ctx)
11276 raise Z3Exception("Non-sequence, non-regular expression sort passed to Full")
11281 """Create a singleton sequence"""
11282 return SeqRef(Z3_mk_seq_unit(a.ctx_ref(), a.as_ast()), a.ctx)
11286 """Check if 'a' is a prefix of 'b'
11287 >>> s1 = PrefixOf("ab", "abc")
11290 >>> s2 = PrefixOf("bc", "abc")
11294 ctx = _get_ctx2(a, b)
11295 a = _coerce_seq(a, ctx)
11296 b = _coerce_seq(b, ctx)
11297 return BoolRef(Z3_mk_seq_prefix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11301 """Check if 'a' is a suffix of 'b'
11302 >>> s1 = SuffixOf("ab", "abc")
11305 >>> s2 = SuffixOf("bc", "abc")
11309 ctx = _get_ctx2(a, b)
11310 a = _coerce_seq(a, ctx)
11311 b = _coerce_seq(b, ctx)
11312 return BoolRef(Z3_mk_seq_suffix(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11316 """Check if 'a' contains 'b'
11317 >>> s1 = Contains("abc", "ab")
11320 >>> s2 = Contains("abc", "bc")
11323 >>> x, y, z = Strings('x y z')
11324 >>> s3 = Contains(Concat(x,y,z), y)
11328 ctx = _get_ctx2(a, b)
11329 a = _coerce_seq(a, ctx)
11330 b = _coerce_seq(b, ctx)
11331 return BoolRef(Z3_mk_seq_contains(a.ctx_ref(), a.as_ast(), b.as_ast()), a.ctx)
11334def Replace(s, src, dst):
11335 """Replace the first occurrence of 'src' by 'dst' in 's'
11336 >>> r = Replace("aaa", "a", "b")
11340 ctx = _get_ctx2(dst, s)
11341 if ctx is None and is_expr(src):
11343 src = _coerce_seq(src, ctx)
11344 dst = _coerce_seq(dst, ctx)
11345 s = _coerce_seq(s, ctx)
11346 return SeqRef(Z3_mk_seq_replace(src.ctx_ref(), s.as_ast(), src.as_ast(), dst.as_ast()), s.ctx)
11349def IndexOf(s, substr, offset=None):
11350 """Retrieve the index of substring within a string starting at a specified offset.
11351 >>> simplify(IndexOf("abcabc", "bc", 0))
11353 >>> simplify(IndexOf("abcabc", "bc", 2))
11359 if is_expr(offset):
11361 ctx = _get_ctx2(s, substr, ctx)
11362 s = _coerce_seq(s, ctx)
11363 substr = _coerce_seq(substr, ctx)
11364 if _is_int(offset):
11365 offset = IntVal(offset, ctx)
11366 return ArithRef(Z3_mk_seq_index(s.ctx_ref(), s.as_ast(), substr.as_ast(), offset.as_ast()), s.ctx)
11369def LastIndexOf(s, substr):
11370 """Retrieve the last index of substring within a string"""
11372 ctx = _get_ctx2(s, substr, ctx)
11373 s = _coerce_seq(s, ctx)
11374 substr = _coerce_seq(substr, ctx)
11375 return ArithRef(Z3_mk_seq_last_index(s.ctx_ref(), s.as_ast(), substr.as_ast()), s.ctx)
11379 """Obtain the length of a sequence 's'
11380 >>> l = Length(StringVal("abc"))
11385 return ArithRef(Z3_mk_seq_length(s.ctx_ref(), s.as_ast()), s.ctx)
11388 """Map function 'f' over sequence 's'"""
11389 ctx = _get_ctx2(f, s)
11390 s = _coerce_seq(s, ctx)
11391 return _to_expr_ref(Z3_mk_seq_map(s.ctx_ref(), f.as_ast(), s.as_ast()), ctx)
11393def SeqMapI(f, i, s):
11394 """Map function 'f' over sequence 's' at index 'i'"""
11395 ctx = _get_ctx2(f, s)
11396 s = _coerce_seq(s, ctx)
11399 return _to_expr_ref(Z3_mk_seq_mapi(s.ctx_ref(), f.as_ast(), i.as_ast(), s.as_ast()), ctx)
11401def SeqFoldLeft(f, a, s):
11402 ctx = _get_ctx2(f, s)
11403 s = _coerce_seq(s, ctx)
11405 return _to_expr_ref(Z3_mk_seq_foldl(s.ctx_ref(), f.as_ast(), a.as_ast(), s.as_ast()), ctx)
11407def SeqFoldLeftI(f, i, a, s):
11408 ctx = _get_ctx2(f, s)
11409 s = _coerce_seq(s, ctx)
11412 return _to_expr_ref(Z3_mk_seq_foldli(s.ctx_ref(), f.as_ast(), i.as_ast(), a.as_ast(), s.as_ast()), ctx)
11415 """Convert string expression to integer
11416 >>> a = StrToInt("1")
11417 >>> simplify(1 == a)
11419 >>> b = StrToInt("2")
11420 >>> simplify(1 == b)
11422 >>> c = StrToInt(IntToStr(2))
11423 >>> simplify(1 == c)
11427 return ArithRef(Z3_mk_str_to_int(s.ctx_ref(), s.as_ast()), s.ctx)
11431 """Convert integer expression to string"""
11434 return SeqRef(Z3_mk_int_to_str(s.ctx_ref(), s.as_ast()), s.ctx)
11438 """Convert a unit length string to integer code"""
11441 return ArithRef(Z3_mk_string_to_code(s.ctx_ref(), s.as_ast()), s.ctx)
11444 """Convert code to a string"""
11447 return SeqRef(Z3_mk_string_from_code(c.ctx_ref(), c.as_ast()), c.ctx)
11449def Re(s, ctx=None):
11450 """The regular expression that accepts sequence 's'
11452 >>> s2 = Re(StringVal("ab"))
11453 >>> s3 = Re(Unit(BoolVal(True)))
11455 s = _coerce_seq(s, ctx)
11456 return ReRef(Z3_mk_seq_to_re(s.ctx_ref(), s.as_ast()), s.ctx)
11459# Regular expressions
11461class ReSortRef(SortRef):
11462 """Regular expression sort."""
11465 return _to_sort_ref(Z3_get_re_sort_basis(self.ctx_ref(), self.ast), self.ctx)
11470 return ReSortRef(Z3_mk_re_sort(s.ctx.ref(), s.ast), s.ctx)
11471 if s is None or isinstance(s, Context):
11473 return ReSortRef(Z3_mk_re_sort(ctx.ref(), Z3_mk_string_sort(ctx.ref())), s.ctx)
11474 raise Z3Exception("Regular expression sort constructor expects either a string or a context or no argument")
11477class ReRef(ExprRef):
11478 """Regular expressions."""
11480 def __add__(self, other):
11481 return Union(self, other)
11485 return isinstance(s, ReRef)
11489 """Create regular expression membership test
11490 >>> re = Union(Re("a"),Re("b"))
11491 >>> print (simplify(InRe("a", re)))
11493 >>> print (simplify(InRe("b", re)))
11495 >>> print (simplify(InRe("c", re)))
11498 s = _coerce_seq(s, re.ctx)
11499 return BoolRef(Z3_mk_seq_in_re(s.ctx_ref(), s.as_ast(), re.as_ast()), s.ctx)
11503 """Create union of regular expressions.
11504 >>> re = Union(Re("a"), Re("b"), Re("c"))
11505 >>> print (simplify(InRe("d", re)))
11508 args = _get_args(args)
11511 _z3_assert(sz > 0, "At least one argument expected.")
11512 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11517 for i in range(sz):
11518 v[i] = args[i].as_ast()
11519 return ReRef(Z3_mk_re_union(ctx.ref(), sz, v), ctx)
11522def Intersect(*args):
11523 """Create intersection of regular expressions.
11524 >>> re = Intersect(Re("a"), Re("b"), Re("c"))
11526 args = _get_args(args)
11529 _z3_assert(sz > 0, "At least one argument expected.")
11530 _z3_assert(all([is_re(a) for a in args]), "All arguments must be regular expressions.")
11535 for i in range(sz):
11536 v[i] = args[i].as_ast()
11537 return ReRef(Z3_mk_re_intersect(ctx.ref(), sz, v), ctx)
11541 """Create the regular expression accepting one or more repetitions of argument.
11542 >>> re = Plus(Re("a"))
11543 >>> print(simplify(InRe("aa", re)))
11545 >>> print(simplify(InRe("ab", re)))
11547 >>> print(simplify(InRe("", re)))
11551 _z3_assert(is_expr(re), "expression expected")
11552 return ReRef(Z3_mk_re_plus(re.ctx_ref(), re.as_ast()), re.ctx)
11556 """Create the regular expression that optionally accepts the argument.
11557 >>> re = Option(Re("a"))
11558 >>> print(simplify(InRe("a", re)))
11560 >>> print(simplify(InRe("", re)))
11562 >>> print(simplify(InRe("aa", re)))
11566 _z3_assert(is_expr(re), "expression expected")
11567 return ReRef(Z3_mk_re_option(re.ctx_ref(), re.as_ast()), re.ctx)
11571 """Create the complement regular expression."""
11572 return ReRef(Z3_mk_re_complement(re.ctx_ref(), re.as_ast()), re.ctx)
11576 """Create the regular expression accepting zero or more repetitions of argument.
11577 >>> re = Star(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_star(re.ctx_ref(), re.as_ast()), re.ctx)
11590def Loop(re, lo, hi=0):
11591 """Create the regular expression accepting between a lower and upper bound repetitions
11592 >>> re = Loop(Re("a"), 1, 3)
11593 >>> print(simplify(InRe("aa", re)))
11595 >>> print(simplify(InRe("aaaa", re)))
11597 >>> print(simplify(InRe("", re)))
11601 _z3_assert(is_expr(re), "expression expected")
11602 return ReRef(Z3_mk_re_loop(re.ctx_ref(), re.as_ast(), lo, hi), re.ctx)
11605def Range(lo, hi, ctx=None):
11606 """Create the range regular expression over two sequences of length 1
11607 >>> range = Range("a","z")
11608 >>> print(simplify(InRe("b", range)))
11610 >>> print(simplify(InRe("bb", range)))
11613 lo = _coerce_seq(lo, ctx)
11614 hi = _coerce_seq(hi, ctx)
11616 _z3_assert(is_expr(lo), "expression expected")
11617 _z3_assert(is_expr(hi), "expression expected")
11618 return ReRef(Z3_mk_re_range(lo.ctx_ref(), lo.ast, hi.ast), lo.ctx)
11620def Diff(a, b, ctx=None):
11621 """Create the difference regular expression
11624 _z3_assert(is_expr(a), "expression expected")
11625 _z3_assert(is_expr(b), "expression expected")
11626 return ReRef(Z3_mk_re_diff(a.ctx_ref(), a.ast, b.ast), a.ctx)
11628def AllChar(regex_sort, ctx=None):
11629 """Create a regular expression that accepts all single character strings
11631 return ReRef(Z3_mk_re_allchar(regex_sort.ctx_ref(), regex_sort.ast), regex_sort.ctx)
11636def PartialOrder(a, index):
11637 return FuncDeclRef(Z3_mk_partial_order(a.ctx_ref(), a.ast, index), a.ctx)
11640def LinearOrder(a, index):
11641 return FuncDeclRef(Z3_mk_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11644def TreeOrder(a, index):
11645 return FuncDeclRef(Z3_mk_tree_order(a.ctx_ref(), a.ast, index), a.ctx)
11648def PiecewiseLinearOrder(a, index):
11649 return FuncDeclRef(Z3_mk_piecewise_linear_order(a.ctx_ref(), a.ast, index), a.ctx)
11652def TransitiveClosure(f):
11653 """Given a binary relation R, such that the two arguments have the same sort
11654 create the transitive closure relation R+.
11655 The transitive closure R+ is a new relation.
11657 return FuncDeclRef(Z3_mk_transitive_closure(f.ctx_ref(), f.ast), f.ctx)
11661 super(ctypes.c_void_p, ast).__init__(ptr)
11664def to_ContextObj(ptr,):
11665 ctx = ContextObj(ptr)
11666 super(ctypes.c_void_p, ctx).__init__(ptr)
11669def to_AstVectorObj(ptr,):
11670 v = AstVectorObj(ptr)
11671 super(ctypes.c_void_p, v).__init__(ptr)
11674# NB. my-hacky-class only works for a single instance of OnClause
11675# it should be replaced with a proper correlation between OnClause
11676# and object references that can be passed over the FFI.
11677# for UserPropagator we use a global dictionary, which isn't great code.
11679_my_hacky_class = None
11680def on_clause_eh(ctx, p, n, dep, clause):
11681 onc = _my_hacky_class
11682 p = _to_expr_ref(to_Ast(p), onc.ctx)
11683 clause = AstVector(to_AstVectorObj(clause), onc.ctx)
11684 deps = [dep[i] for i in range(n)]
11685 onc.on_clause(p, deps, clause)
11687_on_clause_eh = Z3_on_clause_eh(on_clause_eh)
11690 def __init__(self, s, on_clause):
11693 self.on_clause = on_clause
11695 global _my_hacky_class
11696 _my_hacky_class = self
11697 Z3_solver_register_on_clause(self.ctx.ref(), self.s.solver, self.idx, _on_clause_eh)
11701 def __init__(self):
11705 def set_threaded(self):
11706 if self.lock is None:
11708 self.lock = threading.Lock()
11710 def get(self, ctx):
11713 r = self.bases[ctx]
11715 r = self.bases[ctx]
11718 def set(self, ctx, r):
11721 self.bases[ctx] = r
11723 self.bases[ctx] = r
11725 def insert(self, r):
11728 id = len(self.bases) + 3
11731 id = len(self.bases) + 3
11736_prop_closures = None
11739def ensure_prop_closures():
11740 global _prop_closures
11741 if _prop_closures is None:
11742 _prop_closures = PropClosures()
11745def user_prop_push(ctx, cb):
11746 prop = _prop_closures.get(ctx)
11751def user_prop_pop(ctx, cb, num_scopes):
11752 prop = _prop_closures.get(ctx)
11754 prop.pop(num_scopes)
11757def user_prop_fresh(ctx, _new_ctx):
11758 _prop_closures.set_threaded()
11759 prop = _prop_closures.get(ctx)
11761 Z3_del_context(nctx.ctx)
11762 new_ctx = to_ContextObj(_new_ctx)
11764 nctx.eh = Z3_set_error_handler(new_ctx, z3_error_handler)
11766 new_prop = prop.fresh(nctx)
11767 _prop_closures.set(new_prop.id, new_prop)
11771def user_prop_fixed(ctx, cb, id, value):
11772 prop = _prop_closures.get(ctx)
11775 id = _to_expr_ref(to_Ast(id), prop.ctx())
11776 value = _to_expr_ref(to_Ast(value), prop.ctx())
11777 prop.fixed(id, value)
11780def user_prop_created(ctx, cb, id):
11781 prop = _prop_closures.get(ctx)
11784 id = _to_expr_ref(to_Ast(id), prop.ctx())
11789def user_prop_final(ctx, cb):
11790 prop = _prop_closures.get(ctx)
11796def user_prop_eq(ctx, cb, x, y):
11797 prop = _prop_closures.get(ctx)
11800 x = _to_expr_ref(to_Ast(x), prop.ctx())
11801 y = _to_expr_ref(to_Ast(y), prop.ctx())
11805def user_prop_diseq(ctx, cb, x, y):
11806 prop = _prop_closures.get(ctx)
11809 x = _to_expr_ref(to_Ast(x), prop.ctx())
11810 y = _to_expr_ref(to_Ast(y), prop.ctx())
11814def user_prop_decide(ctx, cb, t_ref, idx, phase):
11815 prop = _prop_closures.get(ctx)
11818 t = _to_expr_ref(to_Ast(t_ref), prop.ctx())
11819 prop.decide(t, idx, phase)
11822def user_prop_binding(ctx, cb, q_ref, inst_ref):
11823 prop = _prop_closures.get(ctx)
11826 q = _to_expr_ref(to_Ast(q_ref), prop.ctx())
11827 inst = _to_expr_ref(to_Ast(inst_ref), prop.ctx())
11828 r = prop.binding(q, inst)
11833_user_prop_push = Z3_push_eh(user_prop_push)
11834_user_prop_pop = Z3_pop_eh(user_prop_pop)
11835_user_prop_fresh = Z3_fresh_eh(user_prop_fresh)
11836_user_prop_fixed = Z3_fixed_eh(user_prop_fixed)
11837_user_prop_created = Z3_created_eh(user_prop_created)
11838_user_prop_final = Z3_final_eh(user_prop_final)
11839_user_prop_eq = Z3_eq_eh(user_prop_eq)
11840_user_prop_diseq = Z3_eq_eh(user_prop_diseq)
11841_user_prop_decide = Z3_decide_eh(user_prop_decide)
11842_user_prop_binding = Z3_on_binding_eh(user_prop_binding)
11845def PropagateFunction(name, *sig):
11846 """Create a function that gets tracked by user propagator.
11847 Every term headed by this function symbol is tracked.
11848 If a term is fixed and the fixed callback is registered a
11849 callback is invoked that the term headed by this function is fixed.
11851 sig = _get_args(sig)
11853 _z3_assert(len(sig) > 0, "At least two arguments expected")
11854 arity = len(sig) - 1
11857 _z3_assert(is_sort(rng), "Z3 sort expected")
11858 dom = (Sort * arity)()
11859 for i in range(arity):
11861 _z3_assert(is_sort(sig[i]), "Z3 sort expected")
11862 dom[i] = sig[i].ast
11864 return FuncDeclRef(Z3_solver_propagate_declare(ctx.ref(), to_symbol(name, ctx), arity, dom, rng.ast), ctx)
11868class UserPropagateBase:
11871 # Either solver is set or ctx is set.
11872 # Propagators that are created through callbacks
11873 # to "fresh" inherit the context of that is supplied
11874 # as argument to the callback.
11875 # This context should not be deleted. It is owned by the solver.
11877 def __init__(self, s, ctx=None):
11878 assert s is None or ctx is None
11879 ensure_prop_closures()
11882 self.fresh_ctx = None
11884 self.id = _prop_closures.insert(self)
11890 self.created = None
11891 self.binding = None
11893 self.fresh_ctx = ctx
11895 Z3_solver_propagate_init(self.ctx_ref(),
11897 ctypes.c_void_p(self.id),
11904 self._ctx.ctx = None
11908 return self.fresh_ctx
11910 return self.solver.ctx
11913 return self.ctx().ref()
11915 def add_fixed(self, fixed):
11916 assert not self.fixed
11917 assert not self._ctx
11919 Z3_solver_propagate_fixed(self.ctx_ref(), self.solver.solver, _user_prop_fixed)
11922 def add_created(self, created):
11923 assert not self.created
11924 assert not self._ctx
11926 Z3_solver_propagate_created(self.ctx_ref(), self.solver.solver, _user_prop_created)
11927 self.created = created
11929 def add_final(self, final):
11930 assert not self.final
11931 assert not self._ctx
11933 Z3_solver_propagate_final(self.ctx_ref(), self.solver.solver, _user_prop_final)
11936 def add_eq(self, eq):
11938 assert not self._ctx
11940 Z3_solver_propagate_eq(self.ctx_ref(), self.solver.solver, _user_prop_eq)
11943 def add_diseq(self, diseq):
11944 assert not self.diseq
11945 assert not self._ctx
11947 Z3_solver_propagate_diseq(self.ctx_ref(), self.solver.solver, _user_prop_diseq)
11950 def add_decide(self, decide):
11951 assert not self.decide
11952 assert not self._ctx
11954 Z3_solver_propagate_decide(self.ctx_ref(), self.solver.solver, _user_prop_decide)
11955 self.decide = decide
11957 def add_on_binding(self, binding):
11958 assert not self.binding
11959 assert not self._ctx
11961 Z3_solver_propagate_on_binding(self.ctx_ref(), self.solver.solver, _user_prop_binding)
11962 self.binding = binding
11965 raise Z3Exception("push needs to be overwritten")
11967 def pop(self, num_scopes):
11968 raise Z3Exception("pop needs to be overwritten")
11970 def fresh(self, new_ctx):
11971 raise Z3Exception("fresh needs to be overwritten")
11974 assert not self._ctx
11976 Z3_solver_propagate_register(self.ctx_ref(), self.solver.solver, e.ast)
11978 Z3_solver_propagate_register_cb(self.ctx_ref(), ctypes.c_void_p(self.cb), e.ast)
11981 # Tell the solver to perform the next split on a given term
11982 # If the term is a bit-vector the index idx specifies the index of the Boolean variable being
11983 # split on. A phase of true = 1/false = -1/undef = 0 = let solver decide is the last argument.
11985 def next_split(self, t, idx, phase):
11986 return Z3_solver_next_split(self.ctx_ref(), ctypes.c_void_p(self.cb), t.ast, idx, phase)
11989 # Propagation can only be invoked as during a fixed or final callback.
11991 def propagate(self, e, ids, eqs=[]):
11992 _ids, num_fixed = _to_ast_array(ids)
11994 _lhs, _num_lhs = _to_ast_array([x for x, y in eqs])
11995 _rhs, _num_rhs = _to_ast_array([y for x, y in eqs])
11996 return Z3_solver_propagate_consequence(e.ctx.ref(), ctypes.c_void_p(
11997 self.cb), num_fixed, _ids, num_eqs, _lhs, _rhs, e.ast)
11999 def conflict(self, deps = [], eqs = []):
12000 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.
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_sort Z3_API Z3_mk_datatype_sort(Z3_context c, Z3_symbol name)
create a forward reference to a recursive datatype being declared. The forward reference can be used ...
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)
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)
BVSubNoUnderflow(a, b, signed)
DatatypeSort(name, ctx=None)
SortRef DeclareSort(name, ctx=None)
BVMulNoOverflow(a, b, signed)
_mk_quantifier(is_forall, vs, body, weight=1, qid="", skid="", patterns=[], no_patterns=[])