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)
 
 py_value (self)
 
- Public Member Functions inherited from Z3PPObject
 use_pp (self)
 

Additional Inherited Members

- Data Fields inherited from AstRef
 ast = ast
 
 ctx = _get_ctx(ctx)
 
- 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 754 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 855 of file z3py.py.

855 def __call__(self, *args):
856 """Create a Z3 application expression using the function `self`, and the given arguments.
857
858 The arguments must be Z3 expressions. This method assumes that
859 the sorts of the elements in `args` match the sorts of the
860 domain. Limited coercion is supported. For example, if
861 args[0] is a Python integer, and the function expects a Z3
862 integer, then the argument is automatically converted into a
863 Z3 integer.
864
865 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
866 >>> x = Int('x')
867 >>> y = Real('y')
868 >>> f(x, y)
869 f(x, y)
870 >>> f(x, x)
871 f(x, ToReal(x))
872 """
873 args = _get_args(args)
874 num = len(args)
875 _args = (Ast * num)()
876 saved = []
877 for i in range(num):
878 # self.domain(i).cast(args[i]) may create a new Z3 expression,
879 # then we must save in 'saved' to prevent it from being garbage collected.
880 tmp = self.domain(i).cast(args[i])
881 saved.append(tmp)
882 _args[i] = tmp.as_ast()
883 return _to_expr_ref(Z3_mk_app(self.ctx_ref(), self.ast, len(args), _args), self.ctx)
884
885
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 782 of file z3py.py.

782 def arity(self):
783 """Return the number of arguments of a function declaration.
784 If `self` is a constant, then `self.arity()` is 0.
785
786 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
787 >>> f.arity()
788 2
789 """
790 return int(Z3_get_arity(self.ctx_ref(), self.ast))
791
unsigned Z3_API Z3_get_arity(Z3_context c, Z3_func_decl d)
Alias for Z3_get_domain_size.

◆ as_ast()

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

Reimplemented from AstRef.

Definition at line 762 of file z3py.py.

762 def as_ast(self):
763 return Z3_func_decl_to_ast(self.ctx_ref(), self.ast)
764
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.

◆ as_func_decl()

as_func_decl ( self)

Definition at line 768 of file z3py.py.

768 def as_func_decl(self):
769 return self.ast
770

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

792 def domain(self, i):
793 """Return the sort of the argument `i` of a function declaration.
794 This method assumes that `0 <= i < self.arity()`.
795
796 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
797 >>> f.domain(0)
798 Int
799 >>> f.domain(1)
800 Real
801 """
802 return _to_sort_ref(Z3_get_domain(self.ctx_ref(), self.ast, i), self.ctx)
803
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 __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 765 of file z3py.py.

765 def get_id(self):
766 return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
767
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 814 of file z3py.py.

814 def kind(self):
815 """Return the internal kind of a function declaration.
816 It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
817
818 >>> x = Int('x')
819 >>> d = (x + 1).decl()
820 >>> d.kind() == Z3_OP_ADD
821 True
822 >>> d.kind() == Z3_OP_MUL
823 False
824 """
825 return Z3_get_decl_kind(self.ctx_ref(), self.ast)
826
Z3_decl_kind Z3_API Z3_get_decl_kind(Z3_context c, Z3_func_decl d)
Return declaration kind corresponding to declaration.

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

771 def name(self):
772 """Return the name of the function declaration `self`.
773
774 >>> f = Function('f', IntSort(), IntSort())
775 >>> f.name()
776 'f'
777 >>> isinstance(f.name(), str)
778 True
779 """
780 return _symbol2py(self.ctx, Z3_get_decl_name(self.ctx_ref(), self.ast))
781
Z3_symbol Z3_API Z3_get_decl_name(Z3_context c, Z3_func_decl d)
Return the constant declaration name as a symbol.

◆ params()

params ( self)

Definition at line 827 of file z3py.py.

827 def params(self):
828 ctx = self.ctx
829 n = Z3_get_decl_num_parameters(self.ctx_ref(), self.ast)
830 result = [None for i in range(n)]
831 for i in range(n):
832 k = Z3_get_decl_parameter_kind(self.ctx_ref(), self.ast, i)
833 if k == Z3_PARAMETER_INT:
834 result[i] = Z3_get_decl_int_parameter(self.ctx_ref(), self.ast, i)
835 elif k == Z3_PARAMETER_DOUBLE:
836 result[i] = Z3_get_decl_double_parameter(self.ctx_ref(), self.ast, i)
837 elif k == Z3_PARAMETER_RATIONAL:
838 result[i] = Z3_get_decl_rational_parameter(self.ctx_ref(), self.ast, i)
839 elif k == Z3_PARAMETER_SYMBOL:
840 result[i] = Z3_get_decl_symbol_parameter(self.ctx_ref(), self.ast, i)
841 elif k == Z3_PARAMETER_SORT:
842 result[i] = SortRef(Z3_get_decl_sort_parameter(self.ctx_ref(), self.ast, i), ctx)
843 elif k == Z3_PARAMETER_AST:
844 result[i] = ExprRef(Z3_get_decl_ast_parameter(self.ctx_ref(), self.ast, i), ctx)
845 elif k == Z3_PARAMETER_FUNC_DECL:
846 result[i] = FuncDeclRef(Z3_get_decl_func_decl_parameter(self.ctx_ref(), self.ast, i), ctx)
847 elif k == Z3_PARAMETER_INTERNAL:
848 result[i] = "internal parameter"
849 elif k == Z3_PARAMETER_ZSTRING:
850 result[i] = "internal string"
851 else:
852 assert(False)
853 return result
854
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.

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

804 def range(self):
805 """Return the sort of the range of a function declaration.
806 For constants, this is the sort of the constant.
807
808 >>> f = Function('f', IntSort(), RealSort(), BoolSort())
809 >>> f.range()
810 Bool
811 """
812 return _to_sort_ref(Z3_get_range(self.ctx_ref(), self.ast), self.ctx)
813
Z3_sort Z3_API Z3_get_range(Z3_context c, Z3_func_decl d)
Return the range of the given declaration.

Referenced by __call__(), and params().