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

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

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

740  def arity(self):
741  """Return the number of arguments of a function declaration.
742  If `self` is a constant, then `self.arity()` is 0.
743 
744  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
745  >>> f.arity()
746  2
747  """
748  return int(Z3_get_arity(self.ctx_ref(), self.ast))
749 
unsigned Z3_API Z3_get_arity(Z3_context c, Z3_func_decl d)
Alias for Z3_get_domain_size.

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

720  def as_ast(self):
721  return Z3_func_decl_to_ast(self.ctx_ref(), self.ast)
722 
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.

Referenced by AstRef.__del__(), SeqRef.__ge__(), SeqRef.__getitem__(), SeqRef.__gt__(), BitVecRef.__invert__(), SeqRef.__le__(), CharRef.__le__(), SeqRef.__lt__(), ArithRef.__neg__(), BitVecRef.__neg__(), AlgebraicNumRef.approx(), ExprRef.arg(), IntNumRef.as_binary_string(), BitVecNumRef.as_binary_string(), RatNumRef.as_decimal(), AlgebraicNumRef.as_decimal(), IntNumRef.as_string(), RatNumRef.as_string(), BitVecNumRef.as_string(), FiniteDomainRef.as_string(), FiniteDomainNumRef.as_string(), FPRef.as_string(), FPRMRef.as_string(), FPNumRef.as_string(), SeqRef.as_string(), SeqRef.at(), ExprRef.decl(), ArrayRef.default(), RatNumRef.denominator(), AstRef.eq(), FPNumRef.exponent(), FPNumRef.exponent_as_bv(), FPNumRef.exponent_as_long(), AstRef.get_id(), SortRef.get_id(), FuncDeclRef.get_id(), ExprRef.get_id(), PatternRef.get_id(), QuantifierRef.get_id(), AstRef.hash(), AlgebraicNumRef.index(), CharRef.is_digit(), SeqRef.is_string(), SeqRef.is_string_value(), FPNumRef.isInf(), FPNumRef.isNaN(), FPNumRef.isNegative(), FPNumRef.isNormal(), FPNumRef.isPositive(), FPNumRef.isSubnormal(), FPNumRef.isZero(), ExprRef.num_args(), RatNumRef.numerator(), AlgebraicNumRef.poly(), AstRef.sexpr(), FPNumRef.sign(), FPNumRef.sign_as_bv(), FPNumRef.significand(), FPNumRef.significand_as_bv(), FPNumRef.significand_as_long(), ExprRef.sort(), BoolRef.sort(), QuantifierRef.sort(), ArithRef.sort(), BitVecRef.sort(), ArrayRef.sort(), DatatypeRef.sort(), FiniteDomainRef.sort(), FPRef.sort(), SeqRef.sort(), CharRef.to_bv(), CharRef.to_int(), and AstRef.translate().

◆ as_func_decl()

def as_func_decl (   self)

Definition at line 726 of file z3py.py.

726  def as_func_decl(self):
727  return self.ast
728 

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

750  def domain(self, i):
751  """Return the sort of the argument `i` of a function declaration.
752  This method assumes that `0 <= i < self.arity()`.
753 
754  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
755  >>> f.domain(0)
756  Int
757  >>> f.domain(1)
758  Real
759  """
760  if z3_debug():
761  _z3_assert(i < self.arity(), "Index out of bounds")
762  return _to_sort_ref(Z3_get_domain(self.ctx_ref(), self.ast, i), self.ctx)
763 
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()

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

Reimplemented from AstRef.

Definition at line 723 of file z3py.py.

723  def get_id(self):
724  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
725 
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()

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

774  def kind(self):
775  """Return the internal kind of a function declaration.
776  It can be used to identify Z3 built-in functions such as addition, multiplication, etc.
777 
778  >>> x = Int('x')
779  >>> d = (x + 1).decl()
780  >>> d.kind() == Z3_OP_ADD
781  True
782  >>> d.kind() == Z3_OP_MUL
783  False
784  """
785  return Z3_get_decl_kind(self.ctx_ref(), self.ast)
786 
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()

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

729  def name(self):
730  """Return the name of the function declaration `self`.
731 
732  >>> f = Function('f', IntSort(), IntSort())
733  >>> f.name()
734  'f'
735  >>> isinstance(f.name(), str)
736  True
737  """
738  return _symbol2py(self.ctx, Z3_get_decl_name(self.ctx_ref(), self.ast))
739 
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()

def params (   self)

Definition at line 787 of file z3py.py.

787  def params(self):
788  ctx = self.ctx
789  n = Z3_get_decl_num_parameters(self.ctx_ref(), self.ast)
790  result = [None for i in range(n)]
791  for i in range(n):
792  k = Z3_get_decl_parameter_kind(self.ctx_ref(), self.ast, i)
793  if k == Z3_PARAMETER_INT:
794  result[i] = Z3_get_decl_int_parameter(self.ctx_ref(), self.ast, i)
795  elif k == Z3_PARAMETER_DOUBLE:
796  result[i] = Z3_get_decl_double_parameter(self.ctx_ref(), self.ast, i)
797  elif k == Z3_PARAMETER_RATIONAL:
798  result[i] = Z3_get_decl_rational_parameter(self.ctx_ref(), self.ast, i)
799  elif k == Z3_PARAMETER_SYMBOL:
800  result[i] = Z3_get_decl_symbol_parameter(self.ctx_ref(), self.ast, i)
801  elif k == Z3_PARAMETER_SORT:
802  result[i] = SortRef(Z3_get_decl_sort_parameter(self.ctx_ref(), self.ast, i), ctx)
803  elif k == Z3_PARAMETER_AST:
804  result[i] = ExprRef(Z3_get_decl_ast_parameter(self.ctx_ref(), self.ast, i), ctx)
805  elif k == Z3_PARAMETER_FUNC_DECL:
806  result[i] = FuncDeclRef(Z3_get_decl_func_decl_parameter(self.ctx_ref(), self.ast, i), ctx)
807  else:
808  assert(False)
809  return result
810 
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()

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

764  def range(self):
765  """Return the sort of the range of a function declaration.
766  For constants, this is the sort of the constant.
767 
768  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
769  >>> f.range()
770  Bool
771  """
772  return _to_sort_ref(Z3_get_range(self.ctx_ref(), self.ast), self.ctx)
773 
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().