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 as_ast (self)
 
def get_id (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 636 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 730 of file z3py.py.

730  def __call__(self, *args):
731  """Create a Z3 application expression using the function `self`, and the given arguments.
732 
733  The arguments must be Z3 expressions. This method assumes that
734  the sorts of the elements in `args` match the sorts of the
735  domain. Limited coercion is supported. For example, if
736  args[0] is a Python integer, and the function expects a Z3
737  integer, then the argument is automatically converted into a
738  Z3 integer.
739 
740  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
741  >>> x = Int('x')
742  >>> y = Real('y')
743  >>> f(x, y)
744  f(x, y)
745  >>> f(x, x)
746  f(x, ToReal(x))
747  """
748  args = _get_args(args)
749  num = len(args)
750  if __debug__:
751  _z3_assert(num == self.arity(), "Incorrect number of arguments to %s" % self)
752  _args = (Ast * num)()
753  saved = []
754  for i in range(num):
755  # self.domain(i).cast(args[i]) may create a new Z3 expression,
756  # then we must save in 'saved' to prevent it from being garbage collected.
757  tmp = self.domain(i).cast(args[i])
758  saved.append(tmp)
759  _args[i] = tmp.as_ast()
760  return _to_expr_ref(Z3_mk_app(self.ctx_ref(), self.ast, len(args), _args), self.ctx)
761 
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:2868
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()

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

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

663  def arity(self):
664  """Return the number of arguments of a function declaration. If `self` is a constant, then `self.arity()` is 0.
665 
666  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
667  >>> f.arity()
668  2
669  """
670  return int(Z3_get_arity(self.ctx_ref(), self.ast))
671 
unsigned Z3_API Z3_get_arity(Z3_context c, Z3_func_decl d)
Alias for Z3_get_domain_size.

§ as_ast()

def as_ast (   self)

Definition at line 643 of file z3py.py.

643  def as_ast(self):
644  return Z3_func_decl_to_ast(self.ctx_ref(), self.ast)
645 
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()

def as_func_decl (   self)

Definition at line 649 of file z3py.py.

649  def as_func_decl(self):
650  return self.ast
651 

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

Referenced by FuncDeclRef.__call__().

672  def domain(self, i):
673  """Return the sort of the argument `i` of a function declaration. This method assumes that `0 <= i < self.arity()`.
674 
675  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
676  >>> f.domain(0)
677  Int
678  >>> f.domain(1)
679  Real
680  """
681  if __debug__:
682  _z3_assert(i < self.arity(), "Index out of bounds")
683  return _to_sort_ref(Z3_get_domain(self.ctx_ref(), self.ast, i), self.ctx)
684 
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.

§ get_id()

def get_id (   self)

Definition at line 646 of file z3py.py.

646  def get_id(self):
647  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
648 
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. Thus, two ast nodes created by the same context and having the same children and same function symbols have the same identifiers. Ast nodes created in the same context, but having different children or different functions have different identifiers. Variables and quantifiers are also assigned different identifiers according to their structure.

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

694  def kind(self):
695  """Return the internal kind of a function declaration. It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
696 
697  >>> x = Int('x')
698  >>> d = (x + 1).decl()
699  >>> d.kind() == Z3_OP_ADD
700  True
701  >>> d.kind() == Z3_OP_MUL
702  False
703  """
704  return Z3_get_decl_kind(self.ctx_ref(), self.ast)
705 
Z3_decl_kind Z3_API Z3_get_decl_kind(Z3_context c, Z3_func_decl d)
Return declaration kind corresponding to declaration.

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

652  def name(self):
653  """Return the name of the function declaration `self`.
654 
655  >>> f = Function('f', IntSort(), IntSort())
656  >>> f.name()
657  'f'
658  >>> isinstance(f.name(), str)
659  True
660  """
661  return _symbol2py(self.ctx, Z3_get_decl_name(self.ctx_ref(), self.ast))
662 
Z3_symbol Z3_API Z3_get_decl_name(Z3_context c, Z3_func_decl d)
Return the constant declaration name as a symbol.

§ params()

def params (   self)

Definition at line 706 of file z3py.py.

706  def params(self):
707  ctx = self.ctx
708  n = Z3_get_decl_num_parameters(self.ctx_ref(), self.ast)
709  result = [ None for i in range(n) ]
710  for i in range(n):
711  k = Z3_get_decl_parameter_kind(self.ctx_ref(), self.ast, i)
712  if k == Z3_PARAMETER_INT:
713  result[i] = Z3_get_decl_int_parameter(self.ctx_ref(), self.ast, i)
714  elif k == Z3_PARAMETER_DOUBLE:
715  result[i] = Z3_get_decl_double_parameter(self.ctx_ref(), self.ast, i)
716  elif k == Z3_PARAMETER_RATIONAL:
717  result[i] = Z3_get_decl_rational_parameter(self.ctx_ref(), self.ast, i)
718  elif k == Z3_PARAMETER_SYMBOL:
719  result[i] = Z3_get_decl_symbol_parameter(self.ctx_ref(), self.ast, i)
720  elif k == Z3_PARAMETER_SORT:
721  result[i] = SortRef(Z3_get_decl_sort_parameter(self.ctx_ref(), self.ast, i), ctx)
722  elif k == Z3_PARAMETER_AST:
723  result[i] = ExprRef(Z3_get_decl_ast_parameter(self.ctx_ref(), self.ast, i), ctx)
724  elif k == Z3_PARAMETER_FUNC_DECL:
725  result[i] = FuncDeclRef(Z3_get_decl_func_decl_parameter(self.ctx_ref(), self.ast, i), ctx)
726  else:
727  assert(False)
728  return result
729 
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.
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:2868
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_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_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_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.
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_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.
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_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.

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

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

685  def range(self):
686  """Return the sort of the range of a function declaration. For constants, this is the sort of the constant.
687 
688  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
689  >>> f.range()
690  Bool
691  """
692  return _to_sort_ref(Z3_get_range(self.ctx_ref(), self.ast), self.ctx)
693 
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:2868
Z3_sort Z3_API Z3_get_range(Z3_context c, Z3_func_decl d)
Return the range of the given declaration.