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

Function Declarations. More...

+ Inheritance diagram for FuncDeclRef:

Public Member Functions

 as_ast (self)
 
 get_id (self)
 
 as_func_decl (self)
 
 name (self)
 
 arity (self)
 
 domain (self, i)
 
 range (self)
 
 kind (self)
 
 params (self)
 
 __call__ (self, *args)
 
- Public Member Functions inherited from AstRef
 __init__ (self, ast, ctx=None)
 
 __del__ (self)
 
 __deepcopy__ (self, memo={})
 
 __str__ (self)
 
 __repr__ (self)
 
 __eq__ (self, other)
 
 __hash__ (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

 ast
 
 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

Function Declarations.

Function declaration. Every constant and function have an associated declaration.

The declaration assigns a name, a sort (i.e., type), and for function
the sort (i.e., type) of each of its arguments. Note that, in Z3,
a constant is a function with 0 arguments.

Definition at line 740 of file z3py.py.

Member Function Documentation

◆ __call__()

__call__ ( self,
* args )
Create a Z3 application expression using the function `self`, and the given arguments.

The arguments must be Z3 expressions. This method assumes that
the sorts of the elements in `args` match the sorts of the
domain. Limited coercion is supported.  For example, if
args[0] is a Python integer, and the function expects a Z3
integer, then the argument is automatically converted into a
Z3 integer.

>>> f = Function('f', IntSort(), RealSort(), BoolSort())
>>> x = Int('x')
>>> y = Real('y')
>>> f(x, y)
f(x, y)
>>> f(x, x)
f(x, ToReal(x))

Definition at line 837 of file z3py.py.

837 def __call__(self, *args):
838 """Create a Z3 application expression using the function `self`, and the given arguments.
839
840 The arguments must be Z3 expressions. This method assumes that
841 the sorts of the elements in `args` match the sorts of the
842 domain. Limited coercion is supported. For example, if
843 args[0] is a Python integer, and the function expects a Z3
844 integer, then the argument is automatically converted into a
845 Z3 integer.
846
847 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
848 >>> x = Int('x')
849 >>> y = Real('y')
850 >>> f(x, y)
851 f(x, y)
852 >>> f(x, x)
853 f(x, ToReal(x))
854 """
855 args = _get_args(args)
856 num = len(args)
857 _args = (Ast * num)()
858 saved = []
859 for i in range(num):
860 # self.domain(i).cast(args[i]) may create a new Z3 expression,
861 # then we must save in 'saved' to prevent it from being garbage collected.
862 tmp = self.domain(i).cast(args[i])
863 saved.append(tmp)
864 _args[i] = tmp.as_ast()
865 return _to_expr_ref(Z3_mk_app(self.ctx_ref(), self.ast, len(args), _args), self.ctx)
866
867
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.

◆ arity()

arity ( self)
Return the number of arguments of a function declaration.
If `self` is a constant, then `self.arity()` is 0.

>>> f = Function('f', IntSort(), RealSort(), BoolSort())
>>> f.arity()
2

Definition at line 768 of file z3py.py.

768 def arity(self):
769 """Return the number of arguments of a function declaration.
770 If `self` is a constant, then `self.arity()` is 0.
771
772 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
773 >>> f.arity()
774 2
775 """
776 return int(Z3_get_arity(self.ctx_ref(), self.ast))
777
unsigned Z3_API Z3_get_arity(Z3_context c, Z3_func_decl d)
Alias for Z3_get_domain_size.

◆ as_ast()

◆ as_func_decl()

as_func_decl ( self)

Definition at line 754 of file z3py.py.

754 def as_func_decl(self):
755 return self.ast
756

◆ domain()

domain ( self,
i )
Return the sort of the argument `i` of a function declaration.
This method assumes that `0 <= i < self.arity()`.

>>> f = Function('f', IntSort(), RealSort(), BoolSort())
>>> f.domain(0)
Int
>>> f.domain(1)
Real

Definition at line 778 of file z3py.py.

778 def domain(self, i):
779 """Return the sort of the argument `i` of a function declaration.
780 This method assumes that `0 <= i < self.arity()`.
781
782 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
783 >>> f.domain(0)
784 Int
785 >>> f.domain(1)
786 Real
787 """
788 return _to_sort_ref(Z3_get_domain(self.ctx_ref(), self.ast, i), self.ctx)
789
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.

Referenced by FuncDeclRef.__call__().

◆ get_id()

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

Reimplemented from AstRef.

Definition at line 751 of file z3py.py.

751 def get_id(self):
752 return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
753
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....

◆ kind()

kind ( self)
Return the internal kind of a function declaration.
It can be used to identify Z3 built-in functions such as addition, multiplication, etc.

>>> x = Int('x')
>>> d = (x + 1).decl()
>>> d.kind() == Z3_OP_ADD
True
>>> d.kind() == Z3_OP_MUL
False

Definition at line 800 of file z3py.py.

800 def kind(self):
801 """Return the internal kind of a function declaration.
802 It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
803
804 >>> x = Int('x')
805 >>> d = (x + 1).decl()
806 >>> d.kind() == Z3_OP_ADD
807 True
808 >>> d.kind() == Z3_OP_MUL
809 False
810 """
811 return Z3_get_decl_kind(self.ctx_ref(), self.ast)
812
Z3_decl_kind Z3_API Z3_get_decl_kind(Z3_context c, Z3_func_decl d)
Return declaration kind corresponding to declaration.

Referenced by ArithSortRef.is_int(), and ArithSortRef.is_real().

◆ name()

name ( self)
Return the name of the function declaration `self`.

>>> f = Function('f', IntSort(), IntSort())
>>> f.name()
'f'
>>> isinstance(f.name(), str)
True

Definition at line 757 of file z3py.py.

757 def name(self):
758 """Return the name of the function declaration `self`.
759
760 >>> f = Function('f', IntSort(), IntSort())
761 >>> f.name()
762 'f'
763 >>> isinstance(f.name(), str)
764 True
765 """
766 return _symbol2py(self.ctx, Z3_get_decl_name(self.ctx_ref(), self.ast))
767
Z3_symbol Z3_API Z3_get_decl_name(Z3_context c, Z3_func_decl d)
Return the constant declaration name as a symbol.

Referenced by Datatype.__deepcopy__(), and Datatype.__repr__().

◆ params()

params ( self)

Definition at line 813 of file z3py.py.

813 def params(self):
814 ctx = self.ctx
815 n = Z3_get_decl_num_parameters(self.ctx_ref(), self.ast)
816 result = [None for i in range(n)]
817 for i in range(n):
818 k = Z3_get_decl_parameter_kind(self.ctx_ref(), self.ast, i)
819 if k == Z3_PARAMETER_INT:
820 result[i] = Z3_get_decl_int_parameter(self.ctx_ref(), self.ast, i)
821 elif k == Z3_PARAMETER_DOUBLE:
822 result[i] = Z3_get_decl_double_parameter(self.ctx_ref(), self.ast, i)
823 elif k == Z3_PARAMETER_RATIONAL:
824 result[i] = Z3_get_decl_rational_parameter(self.ctx_ref(), self.ast, i)
825 elif k == Z3_PARAMETER_SYMBOL:
826 result[i] = Z3_get_decl_symbol_parameter(self.ctx_ref(), self.ast, i)
827 elif k == Z3_PARAMETER_SORT:
828 result[i] = SortRef(Z3_get_decl_sort_parameter(self.ctx_ref(), self.ast, i), ctx)
829 elif k == Z3_PARAMETER_AST:
830 result[i] = ExprRef(Z3_get_decl_ast_parameter(self.ctx_ref(), self.ast, i), ctx)
831 elif k == Z3_PARAMETER_FUNC_DECL:
832 result[i] = FuncDeclRef(Z3_get_decl_func_decl_parameter(self.ctx_ref(), self.ast, i), ctx)
833 else:
834 assert(False)
835 return result
836
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_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.
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_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.
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.
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.
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.
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_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.

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

◆ range()

range ( self)
Return the sort of the range of a function declaration.
For constants, this is the sort of the constant.

>>> f = Function('f', IntSort(), RealSort(), BoolSort())
>>> f.range()
Bool

Definition at line 790 of file z3py.py.

790 def range(self):
791 """Return the sort of the range of a function declaration.
792 For constants, this is the sort of the constant.
793
794 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
795 >>> f.range()
796 Bool
797 """
798 return _to_sort_ref(Z3_get_range(self.ctx_ref(), self.ast), self.ctx)
799
Z3_sort Z3_API Z3_get_range(Z3_context c, Z3_func_decl d)
Return the range of the given declaration.

Referenced by FuncDeclRef.__call__(), and FuncDeclRef.params().

Field Documentation

◆ ast

◆ ctx

ctx

Definition at line 766 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().