Z3
Public Member Functions
ExprRef Class Reference

Expressions. More...

+ Inheritance diagram for ExprRef:

Public Member Functions

def as_ast (self)
 
def get_id (self)
 
def sort (self)
 
def sort_kind (self)
 
def __eq__ (self, other)
 
def __hash__ (self)
 
def __ne__ (self, other)
 
def params (self)
 
def decl (self)
 
def num_args (self)
 
def arg (self, idx)
 
def children (self)
 
- Public Member Functions inherited from AstRef
def __init__ (self, ast, ctx=None)
 
def __del__ (self)
 
def __deepcopy__ (self, memo={})
 
def __str__ (self)
 
def __repr__ (self)
 
def __nonzero__ (self)
 
def __bool__ (self)
 
def sexpr (self)
 
def ctx_ref (self)
 
def eq (self, other)
 
def translate (self, target)
 
def __copy__ (self)
 
def hash (self)
 
- Public Member Functions inherited from Z3PPObject
def use_pp (self)
 

Additional Inherited Members

- Data Fields inherited from AstRef
 ast
 
 ctx
 

Detailed Description

Expressions.

Constraints, formulas and terms are expressions in Z3.

Expressions are ASTs. Every expression has a sort.
There are three main kinds of expressions:
function applications, quantifiers and bounded variables.
A constant is a function application with 0 arguments.
For quantifier free problems, all expressions are
function applications.

Definition at line 955 of file z3py.py.

Member Function Documentation

◆ __eq__()

def __eq__ (   self,
  other 
)
Return a Z3 expression that represents the constraint `self == other`.

If `other` is `None`, then this method simply returns `False`.

>>> a = Int('a')
>>> b = Int('b')
>>> a == b
a == b
>>> a is None
False

Reimplemented from AstRef.

Definition at line 995 of file z3py.py.

995  def __eq__(self, other):
996  """Return a Z3 expression that represents the constraint `self == other`.
997 
998  If `other` is `None`, then this method simply returns `False`.
999 
1000  >>> a = Int('a')
1001  >>> b = Int('b')
1002  >>> a == b
1003  a == b
1004  >>> a is None
1005  False
1006  """
1007  if other is None:
1008  return False
1009  a, b = _coerce_exprs(self, other)
1010  return BoolRef(Z3_mk_eq(self.ctx_ref(), a.as_ast(), b.as_ast()), self.ctx)
1011 
Z3_ast Z3_API Z3_mk_eq(Z3_context c, Z3_ast l, Z3_ast r)
Create an AST node representing l = r.

Referenced by CheckSatResult.__ne__(), and Probe.__ne__().

◆ __hash__()

def __hash__ (   self)
 Hash code. 

Reimplemented from AstRef.

Definition at line 1012 of file z3py.py.

1012  def __hash__(self):
1013  """ Hash code. """
1014  return AstRef.__hash__(self)
1015 

◆ __ne__()

def __ne__ (   self,
  other 
)
Return a Z3 expression that represents the constraint `self != other`.

If `other` is `None`, then this method simply returns `True`.

>>> a = Int('a')
>>> b = Int('b')
>>> a != b
a != b
>>> a is not None
True

Definition at line 1016 of file z3py.py.

1016  def __ne__(self, other):
1017  """Return a Z3 expression that represents the constraint `self != other`.
1018 
1019  If `other` is `None`, then this method simply returns `True`.
1020 
1021  >>> a = Int('a')
1022  >>> b = Int('b')
1023  >>> a != b
1024  a != b
1025  >>> a is not None
1026  True
1027  """
1028  if other is None:
1029  return True
1030  a, b = _coerce_exprs(self, other)
1031  _args, sz = _to_ast_array((a, b))
1032  return BoolRef(Z3_mk_distinct(self.ctx_ref(), 2, _args), self.ctx)
1033 
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]).

◆ arg()

def arg (   self,
  idx 
)
Return argument `idx` of the application `self`.

This method assumes that `self` is a function application with at least `idx+1` arguments.

>>> a = Int('a')
>>> b = Int('b')
>>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
>>> t = f(a, b, 0)
>>> t.arg(0)
a
>>> t.arg(1)
b
>>> t.arg(2)
0

Definition at line 1068 of file z3py.py.

1068  def arg(self, idx):
1069  """Return argument `idx` of the application `self`.
1070 
1071  This method assumes that `self` is a function application with at least `idx+1` arguments.
1072 
1073  >>> a = Int('a')
1074  >>> b = Int('b')
1075  >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1076  >>> t = f(a, b, 0)
1077  >>> t.arg(0)
1078  a
1079  >>> t.arg(1)
1080  b
1081  >>> t.arg(2)
1082  0
1083  """
1084  if z3_debug():
1085  _z3_assert(is_app(self), "Z3 application expected")
1086  _z3_assert(idx < self.num_args(), "Invalid argument index")
1087  return _to_expr_ref(Z3_get_app_arg(self.ctx_ref(), self.as_ast(), idx), self.ctx)
1088 
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.
def z3_debug()
Definition: z3py.py:62
def is_app(a)
Definition: z3py.py:1232

Referenced by AstRef.__bool__(), and ExprRef.children().

◆ as_ast()

def as_ast (   self)
Return a pointer to the corresponding C Z3_ast object.

Reimplemented from AstRef.

Reimplemented in QuantifierRef, and PatternRef.

Definition at line 966 of file z3py.py.

966  def as_ast(self):
967  return self.ast
968 

Referenced by AstRef.__del__(), SeqRef.__ge__(), SeqRef.__getitem__(), SeqRef.__gt__(), BitVecRef.__invert__(), SeqRef.__le__(), CharRef.__le__(), SeqRef.__lt__(), ArithRef.__neg__(), BitVecRef.__neg__(), AlgebraicNumRef.approx(), ExprRef.arg(), IntNumRef.as_binary_string(), BitVecNumRef.as_binary_string(), RatNumRef.as_decimal(), AlgebraicNumRef.as_decimal(), IntNumRef.as_string(), RatNumRef.as_string(), BitVecNumRef.as_string(), FiniteDomainRef.as_string(), FiniteDomainNumRef.as_string(), FPRef.as_string(), FPRMRef.as_string(), FPNumRef.as_string(), SeqRef.as_string(), SeqRef.at(), ExprRef.decl(), ArrayRef.default(), RatNumRef.denominator(), AstRef.eq(), FPNumRef.exponent(), FPNumRef.exponent_as_bv(), FPNumRef.exponent_as_long(), AstRef.get_id(), SortRef.get_id(), FuncDeclRef.get_id(), ExprRef.get_id(), PatternRef.get_id(), QuantifierRef.get_id(), AstRef.hash(), AlgebraicNumRef.index(), CharRef.is_digit(), SeqRef.is_string(), SeqRef.is_string_value(), FPNumRef.isInf(), FPNumRef.isNaN(), FPNumRef.isNegative(), FPNumRef.isNormal(), FPNumRef.isPositive(), FPNumRef.isSubnormal(), FPNumRef.isZero(), ExprRef.num_args(), RatNumRef.numerator(), AlgebraicNumRef.poly(), AstRef.sexpr(), FPNumRef.sign(), FPNumRef.sign_as_bv(), FPNumRef.significand(), FPNumRef.significand_as_bv(), FPNumRef.significand_as_long(), ExprRef.sort(), BoolRef.sort(), QuantifierRef.sort(), ArithRef.sort(), BitVecRef.sort(), ArrayRef.sort(), DatatypeRef.sort(), FiniteDomainRef.sort(), FPRef.sort(), SeqRef.sort(), CharRef.to_bv(), CharRef.to_int(), and AstRef.translate().

◆ children()

def children (   self)
Return a list containing the children of the given expression

>>> a = Int('a')
>>> b = Int('b')
>>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
>>> t = f(a, b, 0)
>>> t.children()
[a, b, 0]

Reimplemented in QuantifierRef.

Definition at line 1089 of file z3py.py.

1089  def children(self):
1090  """Return a list containing the children of the given expression
1091 
1092  >>> a = Int('a')
1093  >>> b = Int('b')
1094  >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1095  >>> t = f(a, b, 0)
1096  >>> t.children()
1097  [a, b, 0]
1098  """
1099  if is_app(self):
1100  return [self.arg(i) for i in range(self.num_args())]
1101  else:
1102  return []
1103 
1104 
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:3823

◆ decl()

def decl (   self)
Return the Z3 function declaration associated with a Z3 application.

>>> f = Function('f', IntSort(), IntSort())
>>> a = Int('a')
>>> t = f(a)
>>> eq(t.decl(), f)
True
>>> (a + 1).decl()
+

Definition at line 1037 of file z3py.py.

1037  def decl(self):
1038  """Return the Z3 function declaration associated with a Z3 application.
1039 
1040  >>> f = Function('f', IntSort(), IntSort())
1041  >>> a = Int('a')
1042  >>> t = f(a)
1043  >>> eq(t.decl(), f)
1044  True
1045  >>> (a + 1).decl()
1046  +
1047  """
1048  if z3_debug():
1049  _z3_assert(is_app(self), "Z3 application expected")
1050  return FuncDeclRef(Z3_get_app_decl(self.ctx_ref(), self.as_ast()), self.ctx)
1051 
Z3_func_decl Z3_API Z3_get_app_decl(Z3_context c, Z3_app a)
Return the declaration of a constant or function application.

Referenced by ExprRef.params().

◆ get_id()

def get_id (   self)
Return unique identifier for object. It can be used for hash-tables and maps.

Reimplemented from AstRef.

Reimplemented in QuantifierRef, and PatternRef.

Definition at line 969 of file z3py.py.

969  def get_id(self):
970  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
971 
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....

◆ num_args()

def num_args (   self)
Return the number of arguments of a Z3 application.

>>> a = Int('a')
>>> b = Int('b')
>>> (a + b).num_args()
2
>>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
>>> t = f(a, b, 0)
>>> t.num_args()
3

Definition at line 1052 of file z3py.py.

1052  def num_args(self):
1053  """Return the number of arguments of a Z3 application.
1054 
1055  >>> a = Int('a')
1056  >>> b = Int('b')
1057  >>> (a + b).num_args()
1058  2
1059  >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1060  >>> t = f(a, b, 0)
1061  >>> t.num_args()
1062  3
1063  """
1064  if z3_debug():
1065  _z3_assert(is_app(self), "Z3 application expected")
1066  return int(Z3_get_app_num_args(self.ctx_ref(), self.as_ast()))
1067 
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...

Referenced by AstRef.__bool__(), ExprRef.arg(), FuncEntry.arg_value(), FuncEntry.as_list(), and ExprRef.children().

◆ params()

def params (   self)

Definition at line 1034 of file z3py.py.

1034  def params(self):
1035  return self.decl().params()
1036 

Referenced by ParamsRef.__deepcopy__(), ParamsRef.__del__(), ParamsRef.__repr__(), ParamsRef.set(), and ParamsRef.validate().

◆ sort()

def sort (   self)
Return the sort of expression `self`.

>>> x = Int('x')
>>> (x + 1).sort()
Int
>>> y = Real('y')
>>> (x + y).sort()
Real

Reimplemented in SeqRef, FPRef, FiniteDomainRef, DatatypeRef, ArrayRef, BitVecRef, ArithRef, QuantifierRef, and BoolRef.

Definition at line 972 of file z3py.py.

972  def sort(self):
973  """Return the sort of expression `self`.
974 
975  >>> x = Int('x')
976  >>> (x + 1).sort()
977  Int
978  >>> y = Real('y')
979  >>> (x + y).sort()
980  Real
981  """
982  return _sort(self.ctx, self.as_ast())
983 

Referenced by FPNumRef.as_string(), ArrayRef.domain(), ArrayRef.domain_n(), FPRef.ebits(), ArithRef.is_int(), ArithRef.is_real(), ArrayRef.range(), FPRef.sbits(), BitVecRef.size(), and ExprRef.sort_kind().

◆ sort_kind()

def sort_kind (   self)
Shorthand for `self.sort().kind()`.

>>> a = Array('a', IntSort(), IntSort())
>>> a.sort_kind() == Z3_ARRAY_SORT
True
>>> a.sort_kind() == Z3_INT_SORT
False

Definition at line 984 of file z3py.py.

984  def sort_kind(self):
985  """Shorthand for `self.sort().kind()`.
986 
987  >>> a = Array('a', IntSort(), IntSort())
988  >>> a.sort_kind() == Z3_ARRAY_SORT
989  True
990  >>> a.sort_kind() == Z3_INT_SORT
991  False
992  """
993  return self.sort().kind()
994