Z3
 
Loading...
Searching...
No Matches
ExprRef Class Reference

Expressions. More...

+ Inheritance diagram for ExprRef:

Public Member Functions

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

Data Fields

 ctx
 
- Data Fields inherited from AstRef
 ast = ast
 
 ctx = _get_ctx(ctx)
 

Additional Inherited Members

- Protected Member Functions inherited from Z3PPObject
 _repr_html_ (self)
 

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 979 of file z3py.py.

Member Function Documentation

◆ __eq__()

__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 1019 of file z3py.py.

1019 def __eq__(self, other):
1020 """Return a Z3 expression that represents the constraint `self == other`.
1021
1022 If `other` is `None`, then this method simply returns `False`.
1023
1024 >>> a = Int('a')
1025 >>> b = Int('b')
1026 >>> a == b
1027 a == b
1028 >>> a is None
1029 False
1030 """
1031 if other is None:
1032 return False
1033 a, b = _coerce_exprs(self, other)
1034 return BoolRef(Z3_mk_eq(self.ctx_ref(), a.as_ast(), b.as_ast()), self.ctx)
1035
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__().

◆ __hash__()

__hash__ ( self)
 Hash code. 

Reimplemented from AstRef.

Definition at line 1036 of file z3py.py.

1036 def __hash__(self):
1037 """ Hash code. """
1038 return AstRef.__hash__(self)
1039

◆ __ne__()

__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 1040 of file z3py.py.

1040 def __ne__(self, other):
1041 """Return a Z3 expression that represents the constraint `self != other`.
1042
1043 If `other` is `None`, then this method simply returns `True`.
1044
1045 >>> a = Int('a')
1046 >>> b = Int('b')
1047 >>> a != b
1048 a != b
1049 >>> a is not None
1050 True
1051 """
1052 if other is None:
1053 return True
1054 a, b = _coerce_exprs(self, other)
1055 _args, sz = _to_ast_array((a, b))
1056 return BoolRef(Z3_mk_distinct(self.ctx_ref(), 2, _args), self.ctx)
1057
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()

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 1092 of file z3py.py.

1092 def arg(self, idx):
1093 """Return argument `idx` of the application `self`.
1094
1095 This method assumes that `self` is a function application with at least `idx+1` arguments.
1096
1097 >>> a = Int('a')
1098 >>> b = Int('b')
1099 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1100 >>> t = f(a, b, 0)
1101 >>> t.arg(0)
1102 a
1103 >>> t.arg(1)
1104 b
1105 >>> t.arg(2)
1106 0
1107 """
1108 if z3_debug():
1109 _z3_assert(is_app(self), "Z3 application expected")
1110 _z3_assert(idx < self.num_args(), "Invalid argument index")
1111 return _to_expr_ref(Z3_get_app_arg(self.ctx_ref(), self.as_ast(), idx), self.ctx)
1112
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.

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

◆ as_ast()

◆ children()

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 1113 of file z3py.py.

1113 def children(self):
1114 """Return a list containing the children of the given expression
1115
1116 >>> a = Int('a')
1117 >>> b = Int('b')
1118 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1119 >>> t = f(a, b, 0)
1120 >>> t.children()
1121 [a, b, 0]
1122 """
1123 if is_app(self):
1124 return [self.arg(i) for i in range(self.num_args())]
1125 else:
1126 return []
1127

◆ decl()

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 1061 of file z3py.py.

1061 def decl(self):
1062 """Return the Z3 function declaration associated with a Z3 application.
1063
1064 >>> f = Function('f', IntSort(), IntSort())
1065 >>> a = Int('a')
1066 >>> t = f(a)
1067 >>> eq(t.decl(), f)
1068 True
1069 >>> (a + 1).decl()
1070 +
1071 """
1072 if z3_debug():
1073 _z3_assert(is_app(self), "Z3 application expected")
1074 return FuncDeclRef(Z3_get_app_decl(self.ctx_ref(), self.as_ast()), self.ctx)
1075
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().

◆ from_string()

from_string ( self,
s )

Definition at line 1128 of file z3py.py.

1128 def from_string(self, s):
1129 pass
1130

◆ get_id()

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

Reimplemented from AstRef.

Reimplemented in PatternRef, and QuantifierRef.

Definition at line 993 of file z3py.py.

993 def get_id(self):
994 return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
995
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()

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 1076 of file z3py.py.

1076 def num_args(self):
1077 """Return the number of arguments of a Z3 application.
1078
1079 >>> a = Int('a')
1080 >>> b = Int('b')
1081 >>> (a + b).num_args()
1082 2
1083 >>> f = Function('f', IntSort(), IntSort(), IntSort(), IntSort())
1084 >>> t = f(a, b, 0)
1085 >>> t.num_args()
1086 3
1087 """
1088 if z3_debug():
1089 _z3_assert(is_app(self), "Z3 application expected")
1090 return int(Z3_get_app_num_args(self.ctx_ref(), self.as_ast()))
1091
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()

params ( self)

Definition at line 1058 of file z3py.py.

1058 def params(self):
1059 return self.decl().params()
1060

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

◆ serialize()

serialize ( self)

Definition at line 1131 of file z3py.py.

1131 def serialize(self):
1132 s = Solver()
1133 f = Function('F', self.sort(), BoolSort(self.ctx))
1134 s.add(f(self))
1135 return s.sexpr()
1136

◆ sort()

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

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

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

Definition at line 996 of file z3py.py.

996 def sort(self):
997 """Return the sort of expression `self`.
998
999 >>> x = Int('x')
1000 >>> (x + 1).sort()
1001 Int
1002 >>> y = Real('y')
1003 >>> (x + y).sort()
1004 Real
1005 """
1006 return _sort(self.ctx, self.as_ast())
1007

Referenced by ArrayRef.domain(), ArrayRef.domain_n(), ArithRef.is_int(), ArithRef.is_real(), ArrayRef.range(), BitVecRef.size(), and ExprRef.sort_kind().

◆ sort_kind()

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 1008 of file z3py.py.

1008 def sort_kind(self):
1009 """Shorthand for `self.sort().kind()`.
1010
1011 >>> a = Array('a', IntSort(), IntSort())
1012 >>> a.sort_kind() == Z3_ARRAY_SORT
1013 True
1014 >>> a.sort_kind() == Z3_INT_SORT
1015 False
1016 """
1017 return self.sort().kind()
1018

Field Documentation

◆ ctx

ctx

Definition at line 1006 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), Goal.__copy__(), ModelRef.__copy__(), AstMap.__deepcopy__(), AstRef.__deepcopy__(), AstVector.__deepcopy__(), Datatype.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), Goal.__deepcopy__(), ModelRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), ParamsRef.__deepcopy__(), Statistics.__deepcopy__(), AstMap.__del__(), AstRef.__del__(), AstVector.__del__(), Context.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), Goal.__del__(), ModelRef.__del__(), ParamDescrsRef.__del__(), ParamsRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), Solver.__del__(), Statistics.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstMap.__getitem__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstMap.__len__(), AstVector.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), BoolRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), AstMap.__repr__(), ParamDescrsRef.__repr__(), ParamsRef.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), AstMap.__setitem__(), AstVector.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), Solver.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), QuantifierRef.body(), Solver.check(), Goal.convert_model(), AstRef.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), FuncDeclRef.domain(), ArraySortRef.domain_n(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), Goal.get(), ParamDescrsRef.get_documentation(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), ModelRef.get_sort(), ModelRef.get_universe(), Goal.inconsistent(), AstMap.keys(), Statistics.keys(), Solver.model(), SortRef.name(), QuantifierRef.no_pattern(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Solver.pop(), Goal.prec(), AstVector.push(), Solver.push(), QuantifierRef.qid(), ArraySortRef.range(), FuncDeclRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), ParamsRef.set(), Solver.set(), AstVector.sexpr(), Goal.sexpr(), ModelRef.sexpr(), Goal.size(), ParamDescrsRef.size(), QuantifierRef.skolem_id(), AstRef.translate(), AstVector.translate(), Goal.translate(), ModelRef.translate(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().