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

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

743  def arity(self):
744  """Return the number of arguments of a function declaration.
745  If `self` is a constant, then `self.arity()` is 0.
746 
747  >>> f = Function('f', IntSort(), RealSort(), BoolSort())
748  >>> f.arity()
749  2
750  """
751  return int(Z3_get_arity(self.ctx_ref(), self.ast))
752 
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 723 of file z3py.py.

723  def as_ast(self):
724  return Z3_func_decl_to_ast(self.ctx_ref(), self.ast)
725 
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__(), QuantifierRef.__getitem__(), ArrayRef.__getitem__(), SeqRef.__getitem__(), SeqRef.__gt__(), BitVecRef.__invert__(), SeqRef.__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(), 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(), and AstRef.translate().

◆ as_func_decl()

def as_func_decl (   self)

Definition at line 729 of file z3py.py.

729  def as_func_decl(self):
730  return self.ast
731 

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

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

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

726  def get_id(self):
727  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
728 
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 777 of file z3py.py.

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

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

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

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