Z3
Public Member Functions
FuncDeclRef Class Reference

Function Declarations. More...

+ Inheritance diagram for FuncDeclRef:

Public Member Functions

def as_ast (self)
 
def get_id (self)
 
def as_func_decl (self)
 
def name (self)
 
def arity (self)
 
def domain (self, i)
 
def range (self)
 
def kind (self)
 
def params (self)
 
def __call__ (self, *args)
 
- 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 __eq__ (self, other)
 
def __hash__ (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

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

Member Function Documentation

◆ __call__()

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

817  def __call__(self, *args):
818  """Create a Z3 application expression using the function `self`, and the given arguments.
819 
820  The arguments must be Z3 expressions. This method assumes that
821  the sorts of the elements in `args` match the sorts of the
822  domain. Limited coercion is supported. For example, if
823  args[0] is a Python integer, and the function expects a Z3
824  integer, then the argument is automatically converted into a
825  Z3 integer.
826 
827  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
828  >>> x = Int('x')
829  >>> y = Real('y')
830  >>> f(x, y)
831  f(x, y)
832  >>> f(x, x)
833  f(x, ToReal(x))
834  """
835  args = _get_args(args)
836  num = len(args)
837  if z3_debug():
838  _z3_assert(num == self.arity(), "Incorrect number of arguments to %s" % self)
839  _args = (Ast * num)()
840  saved = []
841  for i in range(num):
842  # self.domain(i).cast(args[i]) may create a new Z3 expression,
843  # then we must save in 'saved' to prevent it from being garbage collected.
844  tmp = self.domain(i).cast(args[i])
845  saved.append(tmp)
846  _args[i] = tmp.as_ast()
847  return _to_expr_ref(Z3_mk_app(self.ctx_ref(), self.ast, len(args), _args), self.ctx)
848 
849 

◆ arity()

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

746  def arity(self):
747  """Return the number of arguments of a function declaration.
748  If `self` is a constant, then `self.arity()` is 0.
749 
750  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
751  >>> f.arity()
752  2
753  """
754  return int(Z3_get_arity(self.ctx_ref(), self.ast))
755 

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

◆ as_ast()

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

Reimplemented from AstRef.

Definition at line 726 of file z3py.py.

726  def as_ast(self):
727  return Z3_func_decl_to_ast(self.ctx_ref(), self.ast)
728 

◆ as_func_decl()

def as_func_decl (   self)

Definition at line 732 of file z3py.py.

732  def as_func_decl(self):
733  return self.ast
734 

◆ domain()

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

756  def domain(self, i):
757  """Return the sort of the argument `i` of a function declaration.
758  This method assumes that `0 <= i < self.arity()`.
759 
760  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
761  >>> f.domain(0)
762  Int
763  >>> f.domain(1)
764  Real
765  """
766  if z3_debug():
767  _z3_assert(i < self.arity(), "Index out of bounds")
768  return _to_sort_ref(Z3_get_domain(self.ctx_ref(), self.ast, i), self.ctx)
769 

Referenced by FuncDeclRef.__call__().

◆ get_id()

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

Reimplemented from AstRef.

Definition at line 729 of file z3py.py.

729  def get_id(self):
730  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
731 

◆ kind()

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

780  def kind(self):
781  """Return the internal kind of a function declaration.
782  It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
783 
784  >>> x = Int('x')
785  >>> d = (x + 1).decl()
786  >>> d.kind() == Z3_OP_ADD
787  True
788  >>> d.kind() == Z3_OP_MUL
789  False
790  """
791  return Z3_get_decl_kind(self.ctx_ref(), self.ast)
792 

◆ name()

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

735  def name(self):
736  """Return the name of the function declaration `self`.
737 
738  >>> f = Function('f', IntSort(), IntSort())
739  >>> f.name()
740  'f'
741  >>> isinstance(f.name(), str)
742  True
743  """
744  return _symbol2py(self.ctx, Z3_get_decl_name(self.ctx_ref(), self.ast))
745 

◆ params()

def params (   self)

Definition at line 793 of file z3py.py.

793  def params(self):
794  ctx = self.ctx
795  n = Z3_get_decl_num_parameters(self.ctx_ref(), self.ast)
796  result = [None for i in range(n)]
797  for i in range(n):
798  k = Z3_get_decl_parameter_kind(self.ctx_ref(), self.ast, i)
799  if k == Z3_PARAMETER_INT:
800  result[i] = Z3_get_decl_int_parameter(self.ctx_ref(), self.ast, i)
801  elif k == Z3_PARAMETER_DOUBLE:
802  result[i] = Z3_get_decl_double_parameter(self.ctx_ref(), self.ast, i)
803  elif k == Z3_PARAMETER_RATIONAL:
804  result[i] = Z3_get_decl_rational_parameter(self.ctx_ref(), self.ast, i)
805  elif k == Z3_PARAMETER_SYMBOL:
806  result[i] = Z3_get_decl_symbol_parameter(self.ctx_ref(), self.ast, i)
807  elif k == Z3_PARAMETER_SORT:
808  result[i] = SortRef(Z3_get_decl_sort_parameter(self.ctx_ref(), self.ast, i), ctx)
809  elif k == Z3_PARAMETER_AST:
810  result[i] = ExprRef(Z3_get_decl_ast_parameter(self.ctx_ref(), self.ast, i), ctx)
811  elif k == Z3_PARAMETER_FUNC_DECL:
812  result[i] = FuncDeclRef(Z3_get_decl_func_decl_parameter(self.ctx_ref(), self.ast, i), ctx)
813  else:
814  assert(False)
815  return result
816 

◆ range()

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

770  def range(self):
771  """Return the sort of the range of a function declaration.
772  For constants, this is the sort of the constant.
773 
774  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
775  >>> f.range()
776  Bool
777  """
778  return _to_sort_ref(Z3_get_range(self.ctx_ref(), self.ast), self.ctx)
779 

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

Z3_get_decl_name
Z3_symbol Z3_API Z3_get_decl_name(Z3_context c, Z3_func_decl d)
Return the constant declaration name as a symbol.
Z3_get_decl_func_decl_parameter
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_get_decl_parameter_kind
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::range
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:3946
Z3_get_range
Z3_sort Z3_API Z3_get_range(Z3_context c, Z3_func_decl d)
Return the range of the given declaration.
Z3_get_decl_symbol_parameter
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_get_decl_ast_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.
Z3_func_decl_to_ast
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.
Z3_get_decl_int_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.
Z3_get_decl_num_parameters
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_get_domain
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.
z3py.z3_debug
def z3_debug()
Definition: z3py.py:62
Z3_get_arity
unsigned Z3_API Z3_get_arity(Z3_context c, Z3_func_decl d)
Alias for Z3_get_domain_size.
Z3_get_decl_kind
Z3_decl_kind Z3_API Z3_get_decl_kind(Z3_context c, Z3_func_decl d)
Return declaration kind corresponding to declaration.
Z3_get_decl_rational_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_mk_app
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_get_decl_sort_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_get_decl_double_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_get_ast_id
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....