Z3
Public Member Functions
QuantifierRef Class Reference

Quantifiers. More...

+ Inheritance diagram for QuantifierRef:

Public Member Functions

def as_ast (self)
 
def get_id (self)
 
def sort (self)
 
def is_forall (self)
 
def is_exists (self)
 
def is_lambda (self)
 
def __getitem__ (self, arg)
 
def weight (self)
 
def num_patterns (self)
 
def pattern (self, idx)
 
def num_no_patterns (self)
 
def no_pattern (self, idx)
 
def body (self)
 
def num_vars (self)
 
def var_name (self, idx)
 
def var_sort (self, idx)
 
def children (self)
 
- Public Member Functions inherited from BoolRef
def __rmul__ (self, other)
 
def __mul__ (self, other)
 
- Public Member Functions inherited from ExprRef
def sort_kind (self)
 
def __eq__ (self, other)
 
def __hash__ (self)
 
def __ne__ (self, other)
 
def params (self)
 
def decl (self)
 
def num_args (self)
 
def arg (self, idx)
 
- 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 __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

Quantifiers.

Universally and Existentially quantified formulas.

Definition at line 1951 of file z3py.py.

Member Function Documentation

◆ __getitem__()

def __getitem__ (   self,
  arg 
)
Return the Z3 expression `self[arg]`.

Definition at line 2008 of file z3py.py.

2008  def __getitem__(self, arg):
2009  """Return the Z3 expression `self[arg]`.
2010  """
2011  if z3_debug():
2012  _z3_assert(self.is_lambda(), "quantifier should be a lambda expression")
2013  return _array_select(self, arg)
2014 
def z3_debug()
Definition: z3py.py:62

◆ as_ast()

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

Reimplemented from ExprRef.

Definition at line 1954 of file z3py.py.

1954  def as_ast(self):
1955  return self.ast
1956 

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().

◆ body()

def body (   self)
Return the expression being quantified.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) == 0)
>>> q.body()
f(Var(0)) == 0

Definition at line 2069 of file z3py.py.

2069  def body(self):
2070  """Return the expression being quantified.
2071 
2072  >>> f = Function('f', IntSort(), IntSort())
2073  >>> x = Int('x')
2074  >>> q = ForAll(x, f(x) == 0)
2075  >>> q.body()
2076  f(Var(0)) == 0
2077  """
2078  return _to_expr_ref(Z3_get_quantifier_body(self.ctx_ref(), self.ast), self.ctx)
2079 
Z3_ast Z3_API Z3_get_quantifier_body(Z3_context c, Z3_ast a)
Return body of quantifier.

Referenced by QuantifierRef.children().

◆ children()

def children (   self)
Return a list containing a single element self.body()

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) == 0)
>>> q.children()
[f(Var(0)) == 0]

Reimplemented from ExprRef.

Definition at line 2124 of file z3py.py.

2124  def children(self):
2125  """Return a list containing a single element self.body()
2126 
2127  >>> f = Function('f', IntSort(), IntSort())
2128  >>> x = Int('x')
2129  >>> q = ForAll(x, f(x) == 0)
2130  >>> q.children()
2131  [f(Var(0)) == 0]
2132  """
2133  return [self.body()]
2134 
2135 

◆ get_id()

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

Reimplemented from ExprRef.

Definition at line 1957 of file z3py.py.

1957  def get_id(self):
1958  return Z3_get_ast_id(self.ctx_ref(), self.as_ast())
1959 
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....

◆ is_exists()

def is_exists (   self)
Return `True` if `self` is an existential quantifier.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) == 0)
>>> q.is_exists()
False
>>> q = Exists(x, f(x) != 0)
>>> q.is_exists()
True

Definition at line 1980 of file z3py.py.

1980  def is_exists(self):
1981  """Return `True` if `self` is an existential quantifier.
1982 
1983  >>> f = Function('f', IntSort(), IntSort())
1984  >>> x = Int('x')
1985  >>> q = ForAll(x, f(x) == 0)
1986  >>> q.is_exists()
1987  False
1988  >>> q = Exists(x, f(x) != 0)
1989  >>> q.is_exists()
1990  True
1991  """
1992  return Z3_is_quantifier_exists(self.ctx_ref(), self.ast)
1993 
bool Z3_API Z3_is_quantifier_exists(Z3_context c, Z3_ast a)
Determine if ast is an existential quantifier.

◆ is_forall()

def is_forall (   self)
Return `True` if `self` is a universal quantifier.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) == 0)
>>> q.is_forall()
True
>>> q = Exists(x, f(x) != 0)
>>> q.is_forall()
False

Definition at line 1966 of file z3py.py.

1966  def is_forall(self):
1967  """Return `True` if `self` is a universal quantifier.
1968 
1969  >>> f = Function('f', IntSort(), IntSort())
1970  >>> x = Int('x')
1971  >>> q = ForAll(x, f(x) == 0)
1972  >>> q.is_forall()
1973  True
1974  >>> q = Exists(x, f(x) != 0)
1975  >>> q.is_forall()
1976  False
1977  """
1978  return Z3_is_quantifier_forall(self.ctx_ref(), self.ast)
1979 
bool Z3_API Z3_is_quantifier_forall(Z3_context c, Z3_ast a)
Determine if an ast is a universal quantifier.

◆ is_lambda()

def is_lambda (   self)
Return `True` if `self` is a lambda expression.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> q = Lambda(x, f(x))
>>> q.is_lambda()
True
>>> q = Exists(x, f(x) != 0)
>>> q.is_lambda()
False

Definition at line 1994 of file z3py.py.

1994  def is_lambda(self):
1995  """Return `True` if `self` is a lambda expression.
1996 
1997  >>> f = Function('f', IntSort(), IntSort())
1998  >>> x = Int('x')
1999  >>> q = Lambda(x, f(x))
2000  >>> q.is_lambda()
2001  True
2002  >>> q = Exists(x, f(x) != 0)
2003  >>> q.is_lambda()
2004  False
2005  """
2006  return Z3_is_lambda(self.ctx_ref(), self.ast)
2007 
bool Z3_API Z3_is_lambda(Z3_context c, Z3_ast a)
Determine if ast is a lambda expression.

Referenced by QuantifierRef.__getitem__(), and QuantifierRef.sort().

◆ no_pattern()

def no_pattern (   self,
  idx 
)
Return a no-pattern.

Definition at line 2063 of file z3py.py.

2063  def no_pattern(self, idx):
2064  """Return a no-pattern."""
2065  if z3_debug():
2066  _z3_assert(idx < self.num_no_patterns(), "Invalid no-pattern idx")
2067  return _to_expr_ref(Z3_get_quantifier_no_pattern_ast(self.ctx_ref(), self.ast, idx), self.ctx)
2068 
Z3_ast Z3_API Z3_get_quantifier_no_pattern_ast(Z3_context c, Z3_ast a, unsigned i)
Return i'th no_pattern.

◆ num_no_patterns()

def num_no_patterns (   self)
Return the number of no-patterns.

Definition at line 2059 of file z3py.py.

2059  def num_no_patterns(self):
2060  """Return the number of no-patterns."""
2061  return Z3_get_quantifier_num_no_patterns(self.ctx_ref(), self.ast)
2062 
unsigned Z3_API Z3_get_quantifier_num_no_patterns(Z3_context c, Z3_ast a)
Return number of no_patterns used in quantifier.

Referenced by QuantifierRef.no_pattern().

◆ num_patterns()

def num_patterns (   self)
Return the number of patterns (i.e., quantifier instantiation hints) in `self`.

>>> f = Function('f', IntSort(), IntSort())
>>> g = Function('g', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
>>> q.num_patterns()
2

Definition at line 2029 of file z3py.py.

2029  def num_patterns(self):
2030  """Return the number of patterns (i.e., quantifier instantiation hints) in `self`.
2031 
2032  >>> f = Function('f', IntSort(), IntSort())
2033  >>> g = Function('g', IntSort(), IntSort())
2034  >>> x = Int('x')
2035  >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2036  >>> q.num_patterns()
2037  2
2038  """
2039  return int(Z3_get_quantifier_num_patterns(self.ctx_ref(), self.ast))
2040 
unsigned Z3_API Z3_get_quantifier_num_patterns(Z3_context c, Z3_ast a)
Return number of patterns used in quantifier.

Referenced by QuantifierRef.pattern().

◆ num_vars()

def num_vars (   self)
Return the number of variables bounded by this quantifier.

>>> f = Function('f', IntSort(), IntSort(), IntSort())
>>> x = Int('x')
>>> y = Int('y')
>>> q = ForAll([x, y], f(x, y) >= x)
>>> q.num_vars()
2

Definition at line 2080 of file z3py.py.

2080  def num_vars(self):
2081  """Return the number of variables bounded by this quantifier.
2082 
2083  >>> f = Function('f', IntSort(), IntSort(), IntSort())
2084  >>> x = Int('x')
2085  >>> y = Int('y')
2086  >>> q = ForAll([x, y], f(x, y) >= x)
2087  >>> q.num_vars()
2088  2
2089  """
2090  return int(Z3_get_quantifier_num_bound(self.ctx_ref(), self.ast))
2091 
unsigned Z3_API Z3_get_quantifier_num_bound(Z3_context c, Z3_ast a)
Return number of bound variables of quantifier.

Referenced by QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ pattern()

def pattern (   self,
  idx 
)
Return a pattern (i.e., quantifier instantiation hints) in `self`.

>>> f = Function('f', IntSort(), IntSort())
>>> g = Function('g', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
>>> q.num_patterns()
2
>>> q.pattern(0)
f(Var(0))
>>> q.pattern(1)
g(Var(0))

Definition at line 2041 of file z3py.py.

2041  def pattern(self, idx):
2042  """Return a pattern (i.e., quantifier instantiation hints) in `self`.
2043 
2044  >>> f = Function('f', IntSort(), IntSort())
2045  >>> g = Function('g', IntSort(), IntSort())
2046  >>> x = Int('x')
2047  >>> q = ForAll(x, f(x) != g(x), patterns = [ f(x), g(x) ])
2048  >>> q.num_patterns()
2049  2
2050  >>> q.pattern(0)
2051  f(Var(0))
2052  >>> q.pattern(1)
2053  g(Var(0))
2054  """
2055  if z3_debug():
2056  _z3_assert(idx < self.num_patterns(), "Invalid pattern idx")
2057  return PatternRef(Z3_get_quantifier_pattern_ast(self.ctx_ref(), self.ast, idx), self.ctx)
2058 
Z3_pattern Z3_API Z3_get_quantifier_pattern_ast(Z3_context c, Z3_ast a, unsigned i)
Return i'th pattern.

◆ sort()

def sort (   self)
Return the Boolean sort or sort of Lambda.

Reimplemented from BoolRef.

Definition at line 1960 of file z3py.py.

1960  def sort(self):
1961  """Return the Boolean sort or sort of Lambda."""
1962  if self.is_lambda():
1963  return _sort(self.ctx, self.as_ast())
1964  return BoolSort(self.ctx)
1965 
def BoolSort(ctx=None)
Definition: z3py.py:1654

Referenced by FPNumRef.as_string(), ArrayRef.domain(), ArrayRef.domain_n(), FPRef.ebits(), ArithRef.is_int(), ArithRef.is_real(), ArrayRef.range(), FPRef.sbits(), BitVecRef.size(), and ExprRef.sort_kind().

◆ var_name()

def var_name (   self,
  idx 
)
Return a string representing a name used when displaying the quantifier.

>>> f = Function('f', IntSort(), IntSort(), IntSort())
>>> x = Int('x')
>>> y = Int('y')
>>> q = ForAll([x, y], f(x, y) >= x)
>>> q.var_name(0)
'x'
>>> q.var_name(1)
'y'

Definition at line 2092 of file z3py.py.

2092  def var_name(self, idx):
2093  """Return a string representing a name used when displaying the quantifier.
2094 
2095  >>> f = Function('f', IntSort(), IntSort(), IntSort())
2096  >>> x = Int('x')
2097  >>> y = Int('y')
2098  >>> q = ForAll([x, y], f(x, y) >= x)
2099  >>> q.var_name(0)
2100  'x'
2101  >>> q.var_name(1)
2102  'y'
2103  """
2104  if z3_debug():
2105  _z3_assert(idx < self.num_vars(), "Invalid variable idx")
2106  return _symbol2py(self.ctx, Z3_get_quantifier_bound_name(self.ctx_ref(), self.ast, idx))
2107 
Z3_symbol Z3_API Z3_get_quantifier_bound_name(Z3_context c, Z3_ast a, unsigned i)
Return symbol of the i'th bound variable.

◆ var_sort()

def var_sort (   self,
  idx 
)
Return the sort of a bound variable.

>>> f = Function('f', IntSort(), RealSort(), IntSort())
>>> x = Int('x')
>>> y = Real('y')
>>> q = ForAll([x, y], f(x, y) >= x)
>>> q.var_sort(0)
Int
>>> q.var_sort(1)
Real

Definition at line 2108 of file z3py.py.

2108  def var_sort(self, idx):
2109  """Return the sort of a bound variable.
2110 
2111  >>> f = Function('f', IntSort(), RealSort(), IntSort())
2112  >>> x = Int('x')
2113  >>> y = Real('y')
2114  >>> q = ForAll([x, y], f(x, y) >= x)
2115  >>> q.var_sort(0)
2116  Int
2117  >>> q.var_sort(1)
2118  Real
2119  """
2120  if z3_debug():
2121  _z3_assert(idx < self.num_vars(), "Invalid variable idx")
2122  return _to_sort_ref(Z3_get_quantifier_bound_sort(self.ctx_ref(), self.ast, idx), self.ctx)
2123 
Z3_sort Z3_API Z3_get_quantifier_bound_sort(Z3_context c, Z3_ast a, unsigned i)
Return sort of the i'th bound variable.

◆ weight()

def weight (   self)
Return the weight annotation of `self`.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> q = ForAll(x, f(x) == 0)
>>> q.weight()
1
>>> q = ForAll(x, f(x) == 0, weight=10)
>>> q.weight()
10

Definition at line 2015 of file z3py.py.

2015  def weight(self):
2016  """Return the weight annotation of `self`.
2017 
2018  >>> f = Function('f', IntSort(), IntSort())
2019  >>> x = Int('x')
2020  >>> q = ForAll(x, f(x) == 0)
2021  >>> q.weight()
2022  1
2023  >>> q = ForAll(x, f(x) == 0, weight=10)
2024  >>> q.weight()
2025  10
2026  """
2027  return int(Z3_get_quantifier_weight(self.ctx_ref(), self.ast))
2028 
unsigned Z3_API Z3_get_quantifier_weight(Z3_context c, Z3_ast a)
Obtain weight of quantifier.