Z3
Public Member Functions | Data Fields
Tactic Class Reference

Public Member Functions

def __init__ (self, tactic, ctx=None)
 
def __deepcopy__ (self, memo={})
 
def __del__ (self)
 
def solver (self, logFile=None)
 
def apply (self, goal, *arguments, **keywords)
 
def __call__ (self, goal, *arguments, **keywords)
 
def help (self)
 
def param_descrs (self)
 

Data Fields

 ctx
 
 tactic
 

Detailed Description

Tactics transform, solver and/or simplify sets of constraints (Goal). A Tactic can be converted into a Solver using the method solver().

Several combinators are available for creating new tactics using the built-in ones: Then(), OrElse(), FailIf(), Repeat(), When(), Cond().

Definition at line 7698 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  tactic,
  ctx = None 
)

Definition at line 7703 of file z3py.py.

7703  def __init__(self, tactic, ctx=None):
7704  self.ctx = _get_ctx(ctx)
7705  self.tactic = None
7706  if isinstance(tactic, TacticObj):
7707  self.tactic = tactic
7708  else:
7709  if z3_debug():
7710  _z3_assert(isinstance(tactic, str), "tactic name expected")
7711  try:
7712  self.tactic = Z3_mk_tactic(self.ctx.ref(), str(tactic))
7713  except Z3Exception:
7714  raise Z3Exception("unknown tactic '%s'" % tactic)
7715  Z3_tactic_inc_ref(self.ctx.ref(), self.tactic)
7716 

◆ __del__()

def __del__ (   self)

Definition at line 7720 of file z3py.py.

7720  def __del__(self):
7721  if self.tactic is not None and self.ctx.ref() is not None:
7722  Z3_tactic_dec_ref(self.ctx.ref(), self.tactic)
7723 

Member Function Documentation

◆ __call__()

def __call__ (   self,
  goal,
arguments,
**  keywords 
)
Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.

>>> x, y = Ints('x y')
>>> t = Tactic('solve-eqs')
>>> t(And(x == 0, y >= x + 1))
[[y >= 1]]

Definition at line 7758 of file z3py.py.

7758  def __call__(self, goal, *arguments, **keywords):
7759  """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
7760 
7761  >>> x, y = Ints('x y')
7762  >>> t = Tactic('solve-eqs')
7763  >>> t(And(x == 0, y >= x + 1))
7764  [[y >= 1]]
7765  """
7766  return self.apply(goal, *arguments, **keywords)
7767 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 7717 of file z3py.py.

7717  def __deepcopy__(self, memo={}):
7718  return Tactic(self.tactic, self.ctx)
7719 

◆ apply()

def apply (   self,
  goal,
arguments,
**  keywords 
)
Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.

>>> x, y = Ints('x y')
>>> t = Tactic('solve-eqs')
>>> t.apply(And(x == 0, y >= x + 1))
[[y >= 1]]

Definition at line 7741 of file z3py.py.

7741  def apply(self, goal, *arguments, **keywords):
7742  """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
7743 
7744  >>> x, y = Ints('x y')
7745  >>> t = Tactic('solve-eqs')
7746  >>> t.apply(And(x == 0, y >= x + 1))
7747  [[y >= 1]]
7748  """
7749  if z3_debug():
7750  _z3_assert(isinstance(goal, Goal) or isinstance(goal, BoolRef), "Z3 Goal or Boolean expressions expected")
7751  goal = _to_goal(goal)
7752  if len(arguments) > 0 or len(keywords) > 0:
7753  p = args2params(arguments, keywords, self.ctx)
7754  return ApplyResult(Z3_tactic_apply_ex(self.ctx.ref(), self.tactic, goal.goal, p.params), self.ctx)
7755  else:
7756  return ApplyResult(Z3_tactic_apply(self.ctx.ref(), self.tactic, goal.goal), self.ctx)
7757 

Referenced by Tactic.__call__().

◆ help()

def help (   self)
Display a string containing a description of the available options for the `self` tactic.

Definition at line 7768 of file z3py.py.

7768  def help(self):
7769  """Display a string containing a description of the available options for the `self` tactic."""
7770  print(Z3_tactic_get_help(self.ctx.ref(), self.tactic))
7771 

◆ param_descrs()

def param_descrs (   self)
Return the parameter description set.

Definition at line 7772 of file z3py.py.

7772  def param_descrs(self):
7773  """Return the parameter description set."""
7774  return ParamDescrsRef(Z3_tactic_get_param_descrs(self.ctx.ref(), self.tactic), self.ctx)
7775 

◆ solver()

def solver (   self,
  logFile = None 
)
Create a solver using the tactic `self`.

The solver supports the methods `push()` and `pop()`, but it
will always solve each `check()` from scratch.

>>> t = Then('simplify', 'nlsat')
>>> s = t.solver()
>>> x = Real('x')
>>> s.add(x**2 == 2, x > 0)
>>> s.check()
sat
>>> s.model()
[x = 1.4142135623?]

Definition at line 7724 of file z3py.py.

7724  def solver(self, logFile=None):
7725  """Create a solver using the tactic `self`.
7726 
7727  The solver supports the methods `push()` and `pop()`, but it
7728  will always solve each `check()` from scratch.
7729 
7730  >>> t = Then('simplify', 'nlsat')
7731  >>> s = t.solver()
7732  >>> x = Real('x')
7733  >>> s.add(x**2 == 2, x > 0)
7734  >>> s.check()
7735  sat
7736  >>> s.model()
7737  [x = 1.4142135623?]
7738  """
7739  return Solver(Z3_mk_solver_from_tactic(self.ctx.ref(), self.tactic), self.ctx, logFile)
7740 

Field Documentation

◆ ctx

ctx

◆ tactic

tactic
Z3_mk_solver_from_tactic
Z3_solver Z3_API Z3_mk_solver_from_tactic(Z3_context c, Z3_tactic t)
Create a new solver that is implemented using the given tactic. The solver supports the commands Z3_s...
z3py.UserPropagateBase.__init__
def __init__(self, s, ctx=None)
Definition: z3py.py:10597
Z3_tactic_inc_ref
void Z3_API Z3_tactic_inc_ref(Z3_context c, Z3_tactic t)
Increment the reference counter of the given tactic.
Z3_mk_tactic
Z3_tactic Z3_API Z3_mk_tactic(Z3_context c, Z3_string name)
Return a tactic associated with the given name. The complete list of tactics may be obtained using th...
Z3_tactic_dec_ref
void Z3_API Z3_tactic_dec_ref(Z3_context c, Z3_tactic g)
Decrement the reference counter of the given tactic.
z3py.UserPropagateBase.__del__
def __del__(self)
Definition: z3py.py:10622
Z3_tactic_apply
Z3_apply_result Z3_API Z3_tactic_apply(Z3_context c, Z3_tactic t, Z3_goal g)
Apply tactic t to the goal g.
z3py.z3_debug
def z3_debug()
Definition: z3py.py:56
z3py.UserPropagateBase.solver
solver
Definition: z3py.py:10600
Z3_tactic_get_param_descrs
Z3_param_descrs Z3_API Z3_tactic_get_param_descrs(Z3_context c, Z3_tactic t)
Return the parameter description set for the given tactic object.
Z3_tactic_get_help
Z3_string Z3_API Z3_tactic_get_help(Z3_context c, Z3_tactic t)
Return a string containing a description of parameters accepted by the given tactic.
Z3_tactic_apply_ex
Z3_apply_result Z3_API Z3_tactic_apply_ex(Z3_context c, Z3_tactic t, Z3_goal g, Z3_params p)
Apply tactic t to the goal g using the parameter set p.
z3py.args2params
def args2params(arguments, keywords, ctx=None)
Definition: z3py.py:5111