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

Public Member Functions

def __init__ (self, result, ctx)
 
def __del__ (self)
 
def __len__ (self)
 
def __getitem__ (self, idx)
 
def __repr__ (self)
 
def sexpr (self)
 
def convert_model
 
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 6341 of file z3py.py.

Constructor & Destructor Documentation

def __init__ (   self,
  result,
  ctx 
)

Definition at line 6344 of file z3py.py.

6344  def __init__(self, result, ctx):
6345  self.result = result
6346  self.ctx = ctx
6347  Z3_apply_result_inc_ref(self.ctx.ref(), self.result)
6348 
void Z3_API Z3_apply_result_inc_ref(__in Z3_context c, __in Z3_apply_result r)
Increment the reference counter of the given Z3_apply_result object.
def __init__(self, result, ctx)
Definition: z3py.py:6344
def __del__ (   self)

Definition at line 6349 of file z3py.py.

6349  def __del__(self):
6350  Z3_apply_result_dec_ref(self.ctx.ref(), self.result)
6351 
void Z3_API Z3_apply_result_dec_ref(__in Z3_context c, __in Z3_apply_result r)
Decrement the reference counter of the given Z3_apply_result object.
def __del__(self)
Definition: z3py.py:6349

Member Function Documentation

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

6371  def __getitem__(self, idx):
6372  """Return one of the subgoals stored in ApplyResult object `self`.
6373 
6374  >>> a, b = Ints('a b')
6375  >>> g = Goal()
6376  >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
6377  >>> t = Tactic('split-clause')
6378  >>> r = t(g)
6379  >>> r[0]
6380  [a == 0, Or(b == 0, b == 1), a > b]
6381  >>> r[1]
6382  [a == 1, Or(b == 0, b == 1), a > b]
6383  """
6384  if idx >= len(self):
6385  raise IndexError
6386  return Goal(goal=Z3_apply_result_get_subgoal(self.ctx.ref(), self.result, idx), ctx=self.ctx)
6387 
def __getitem__(self, idx)
Definition: z3py.py:6371
Z3_goal Z3_API Z3_apply_result_get_subgoal(__in Z3_context c, __in Z3_apply_result r, __in unsigned i)
Return one of the subgoals in the Z3_apply_result object returned by Z3_tactic_apply.
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 6352 of file z3py.py.

6352  def __len__(self):
6353  """Return the number of subgoals in `self`.
6354 
6355  >>> a, b = Ints('a b')
6356  >>> g = Goal()
6357  >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
6358  >>> t = Tactic('split-clause')
6359  >>> r = t(g)
6360  >>> len(r)
6361  2
6362  >>> t = Then(Tactic('split-clause'), Tactic('split-clause'))
6363  >>> len(t(g))
6364  4
6365  >>> t = Then(Tactic('split-clause'), Tactic('split-clause'), Tactic('propagate-values'))
6366  >>> len(t(g))
6367  1
6368  """
6369  return int(Z3_apply_result_get_num_subgoals(self.ctx.ref(), self.result))
6370 
def __len__(self)
Definition: z3py.py:6352
unsigned Z3_API Z3_apply_result_get_num_subgoals(__in Z3_context c, __in Z3_apply_result r)
Return the number of subgoals in the Z3_apply_result object returned by Z3_tactic_apply.
def __repr__ (   self)

Definition at line 6388 of file z3py.py.

6388  def __repr__(self):
6389  return obj_to_string(self)
6390 
def __repr__(self)
Definition: z3py.py:6388
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 6426 of file z3py.py.

6426  def as_expr(self):
6427  """Return a Z3 expression consisting of all subgoals.
6428 
6429  >>> x = Int('x')
6430  >>> g = Goal()
6431  >>> g.add(x > 1)
6432  >>> g.add(Or(x == 2, x == 3))
6433  >>> r = Tactic('simplify')(g)
6434  >>> r
6435  [[Not(x <= 1), Or(x == 2, x == 3)]]
6436  >>> r.as_expr()
6437  And(Not(x <= 1), Or(x == 2, x == 3))
6438  >>> r = Tactic('split-clause')(g)
6439  >>> r
6440  [[x > 1, x == 2], [x > 1, x == 3]]
6441  >>> r.as_expr()
6442  Or(And(x > 1, x == 2), And(x > 1, x == 3))
6443  """
6444  sz = len(self)
6445  if sz == 0:
6446  return BoolVal(False, self.ctx)
6447  elif sz == 1:
6448  return self[0].as_expr()
6449  else:
6450  return Or([ self[i].as_expr() for i in range(len(self)) ])
6451 
def BoolVal
Definition: z3py.py:1353
def Or(args)
Definition: z3py.py:1509
def as_expr(self)
Definition: z3py.py:6426
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 6395 of file z3py.py.

6395  def convert_model(self, model, idx=0):
6396  """Convert a model for a subgoal into a model for the original goal.
6397 
6398  >>> a, b = Ints('a b')
6399  >>> g = Goal()
6400  >>> g.add(Or(a == 0, a == 1), Or(b == 0, b == 1), a > b)
6401  >>> t = Then(Tactic('split-clause'), Tactic('solve-eqs'))
6402  >>> r = t(g)
6403  >>> r[0]
6404  [Or(b == 0, b == 1), Not(0 <= b)]
6405  >>> r[1]
6406  [Or(b == 0, b == 1), Not(1 <= b)]
6407  >>> # Remark: the subgoal r[0] is unsatisfiable
6408  >>> # Creating a solver for solving the second subgoal
6409  >>> s = Solver()
6410  >>> s.add(r[1])
6411  >>> s.check()
6412  sat
6413  >>> s.model()
6414  [b = 0]
6415  >>> # Model s.model() does not assign a value to `a`
6416  >>> # It is a model for subgoal `r[1]`, but not for goal `g`
6417  >>> # The method convert_model creates a model for `g` from a model for `r[1]`.
6418  >>> r.convert_model(s.model(), 1)
6419  [b = 0, a = 1]
6420  """
6421  if __debug__:
6422  _z3_assert(idx < len(self), "index out of bounds")
6423  _z3_assert(isinstance(model, ModelRef), "Z3 Model expected")
6424  return ModelRef(Z3_apply_result_convert_model(self.ctx.ref(), self.result, idx, model.model), self.ctx)
6425 
Z3_model Z3_API Z3_apply_result_convert_model(__in Z3_context c, __in Z3_apply_result r, __in unsigned i, __in Z3_model m)
Convert a model for the subgoal Z3_apply_result_get_subgoal(c, r, i) into a model for the original go...
def convert_model
Definition: z3py.py:6395
def sexpr (   self)
Return a textual representation of the s-expression representing the set of subgoals in `self`.

Definition at line 6391 of file z3py.py.

6391  def sexpr(self):
6392  """Return a textual representation of the s-expression representing the set of subgoals in `self`."""
6393  return Z3_apply_result_to_string(self.ctx.ref(), self.result)
6394 
def sexpr(self)
Definition: z3py.py:6391
Z3_string Z3_API Z3_apply_result_to_string(__in Z3_context c, __in Z3_apply_result r)
Convert the Z3_apply_result object returned by Z3_tactic_apply into a string.

Field Documentation

ctx
result