Z3
Public Member Functions | Data Fields
ApplyResult Class Reference
+ Inheritance diagram for ApplyResult:

Public Member Functions

def __init__ (self, result, ctx)
 
def __deepcopy__ (self, memo={})
 
def __del__ (self)
 
def __len__ (self)
 
def __getitem__ (self, idx)
 
def __repr__ (self)
 
def sexpr (self)
 
def convert_model (self, model, idx=0)
 
def as_expr (self)
 
- Public Member Functions inherited from Z3PPObject
def use_pp (self)
 

Data Fields

 result
 
 ctx
 

Detailed Description

An ApplyResult object contains the subgoals produced by a tactic when applied to a goal. It also contains model and proof converters.

Definition at line 7132 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  result,
  ctx 
)

Definition at line 7135 of file z3py.py.

7135  def __init__(self, result, ctx):
7136  self.result = result
7137  self.ctx = ctx
7138  Z3_apply_result_inc_ref(self.ctx.ref(), self.result)
7139 
void Z3_API Z3_apply_result_inc_ref(Z3_context c, Z3_apply_result r)
Increment the reference counter of the given Z3_apply_result object.

◆ __del__()

def __del__ (   self)

Definition at line 7143 of file z3py.py.

7143  def __del__(self):
7144  if self.ctx.ref() is not None:
7145  Z3_apply_result_dec_ref(self.ctx.ref(), self.result)
7146 
void Z3_API Z3_apply_result_dec_ref(Z3_context c, Z3_apply_result r)
Decrement the reference counter of the given Z3_apply_result object.

Member Function Documentation

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 7140 of file z3py.py.

7140  def __deepcopy__(self, memo={}):
7141  return ApplyResult(self.result, self.ctx)
7142 

◆ __getitem__()

def __getitem__ (   self,
  idx 
)
Return one of the subgoals stored in ApplyResult object `self`.

>>> a, b = Ints('a b')
>>> g = Goal()
>>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
>>> t = Tactic('split-clause')
>>> r = t(g)
>>> r[0]
[a == 0, Or(b == 0, b == 1), a > b]
>>> r[1]
[a == 1, Or(b == 0, b == 1), a > b]

Definition at line 7166 of file z3py.py.

7166  def __getitem__(self, idx):
7167  """Return one of the subgoals stored in ApplyResult object `self`.
7168 
7169  >>> a, b = Ints('a b')
7170  >>> g = Goal()
7171  >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
7172  >>> t = Tactic('split-clause')
7173  >>> r = t(g)
7174  >>> r[0]
7175  [a == 0, Or(b == 0, b == 1), a > b]
7176  >>> r[1]
7177  [a == 1, Or(b == 0, b == 1), a > b]
7178  """
7179  if idx >= len(self):
7180  raise IndexError
7181  return Goal(goal=Z3_apply_result_get_subgoal(self.ctx.ref(), self.result, idx), ctx=self.ctx)
7182 
Z3_goal Z3_API Z3_apply_result_get_subgoal(Z3_context c, Z3_apply_result r, unsigned i)
Return one of the subgoals in the Z3_apply_result object returned by Z3_tactic_apply.

◆ __len__()

def __len__ (   self)
Return the number of subgoals in `self`.

>>> a, b = Ints('a b')
>>> g = Goal()
>>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
>>> t = Tactic('split-clause')
>>> r = t(g)
>>> len(r)
2
>>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
>>> len(t(g))
4
>>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
>>> len(t(g))
1

Definition at line 7147 of file z3py.py.

7147  def __len__(self):
7148  """Return the number of subgoals in `self`.
7149 
7150  >>> a, b = Ints('a b')
7151  >>> g = Goal()
7152  >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
7153  >>> t = Tactic('split-clause')
7154  >>> r = t(g)
7155  >>> len(r)
7156  2
7157  >>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
7158  >>> len(t(g))
7159  4
7160  >>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
7161  >>> len(t(g))
7162  1
7163  """
7164  return int(Z3_apply_result_get_num_subgoals(self.ctx.ref(), self.result))
7165 
unsigned Z3_API Z3_apply_result_get_num_subgoals(Z3_context c, Z3_apply_result r)
Return the number of subgoals in the Z3_apply_result object returned by Z3_tactic_apply.

◆ __repr__()

def __repr__ (   self)

Definition at line 7183 of file z3py.py.

7183  def __repr__(self):
7184  return obj_to_string(self)
7185 

◆ as_expr()

def as_expr (   self)
Return a Z3 expression consisting of all subgoals.

>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 1)
>>> g.add(Or(x == 2, x == 3))
>>> r = Tactic('simplify')(g)
>>> r
[[Not(x <= 1), Or(x == 2, x == 3)]]
>>> r.as_expr()
And(Not(x <= 1), Or(x == 2, x == 3))
>>> r = Tactic('split-clause')(g)
>>> r
[[x > 1, x == 2], [x > 1, x == 3]]
>>> r.as_expr()
Or(And(x > 1, x == 2), And(x > 1, x == 3))

Definition at line 7221 of file z3py.py.

7221  def as_expr(self):
7222  """Return a Z3 expression consisting of all subgoals.
7223 
7224  >>> x = Int('x')
7225  >>> g = Goal()
7226  >>> g.add(x > 1)
7227  >>> g.add(Or(x == 2, x == 3))
7228  >>> r = Tactic('simplify')(g)
7229  >>> r
7230  [[Not(x <= 1), Or(x == 2, x == 3)]]
7231  >>> r.as_expr()
7232  And(Not(x <= 1), Or(x == 2, x == 3))
7233  >>> r = Tactic('split-clause')(g)
7234  >>> r
7235  [[x > 1, x == 2], [x > 1, x == 3]]
7236  >>> r.as_expr()
7237  Or(And(x > 1, x == 2), And(x > 1, x == 3))
7238  """
7239  sz = len(self)
7240  if sz == 0:
7241  return BoolVal(False, self.ctx)
7242  elif sz == 1:
7243  return self[0].as_expr()
7244  else:
7245  return Or([ self[i].as_expr() for i in range(len(self)) ])
7246 
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:2868
def Or(args)
Definition: z3py.py:1625
def BoolVal(val, ctx=None)
Definition: z3py.py:1466

◆ convert_model()

def convert_model (   self,
  model,
  idx = 0 
)
Convert a model for a subgoal into a model for the original goal.

>>> a, b = Ints('a b')
>>> g = Goal()
>>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
>>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
>>> r = t(g)
>>> r[0]
[Or(b == 0, b == 1), Not(0 <= b)]
>>> r[1]
[Or(b == 0, b == 1), Not(1 <= b)]
>>> # Remark: the subgoal r[0] is unsatisfiable
>>> # Creating a solver for solving the second subgoal
>>> s = Solver()
>>> s.add(r[1])
>>> s.check()
sat
>>> s.model()
[b = 0]
>>> # Model s.model() does not assign a value to `a`
>>> # It is a model for subgoal `r[1]`, but not for goal `g`
>>> # The method convert_model creates a model for `g` from a model for `r[1]`.
>>> r.convert_model(s.model(), 1)
[b = 0, a = 1]

Definition at line 7190 of file z3py.py.

7190  def convert_model(self, model, idx=0):
7191  """Convert a model for a subgoal into a model for the original goal.
7192 
7193  >>> a, b = Ints('a b')
7194  >>> g = Goal()
7195  >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
7196  >>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
7197  >>> r = t(g)
7198  >>> r[0]
7199  [Or(b == 0, b == 1), Not(0 <= b)]
7200  >>> r[1]
7201  [Or(b == 0, b == 1), Not(1 <= b)]
7202  >>> # Remark: the subgoal r[0] is unsatisfiable
7203  >>> # Creating a solver for solving the second subgoal
7204  >>> s = Solver()
7205  >>> s.add(r[1])
7206  >>> s.check()
7207  sat
7208  >>> s.model()
7209  [b = 0]
7210  >>> # Model s.model() does not assign a value to `a`
7211  >>> # It is a model for subgoal `r[1]`, but not for goal `g`
7212  >>> # The method convert_model creates a model for `g` from a model for `r[1]`.
7213  >>> r.convert_model(s.model(), 1)
7214  [b = 0, a = 1]
7215  """
7216  if __debug__:
7217  _z3_assert(idx < len(self), "index out of bounds")
7218  _z3_assert(isinstance(model, ModelRef), "Z3 Model expected")
7219  return ModelRef(Z3_apply_result_convert_model(self.ctx.ref(), self.result, idx, model.model), self.ctx)
7220 
Z3_model Z3_API Z3_apply_result_convert_model(Z3_context c, Z3_apply_result r, unsigned i, Z3_model m)
Convert a model for the subgoal Z3_apply_result_get_subgoal(c, r, i) into a model for the original go...

◆ sexpr()

def sexpr (   self)
Return a textual representation of the s-expression representing the set of subgoals in `self`.

Definition at line 7186 of file z3py.py.

7186  def sexpr(self):
7187  """Return a textual representation of the s-expression representing the set of subgoals in `self`."""
7188  return Z3_apply_result_to_string(self.ctx.ref(), self.result)
7189 
Z3_string Z3_API Z3_apply_result_to_string(Z3_context c, Z3_apply_result r)
Convert the Z3_apply_result object returned by Z3_tactic_apply into a string.

Field Documentation

◆ ctx

ctx

◆ result

result