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

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  tactic,
  ctx = None 
)

Definition at line 8065 of file z3py.py.

8065  def __init__(self, tactic, ctx=None):
8066  self.ctx = _get_ctx(ctx)
8067  self.tactic = None
8068  if isinstance(tactic, TacticObj):
8069  self.tactic = tactic
8070  else:
8071  if z3_debug():
8072  _z3_assert(isinstance(tactic, str), "tactic name expected")
8073  try:
8074  self.tactic = Z3_mk_tactic(self.ctx.ref(), str(tactic))
8075  except Z3Exception:
8076  raise Z3Exception("unknown tactic '%s'" % tactic)
8077  Z3_tactic_inc_ref(self.ctx.ref(), self.tactic)
8078 

◆ __del__()

def __del__ (   self)

Definition at line 8082 of file z3py.py.

8082  def __del__(self):
8083  if self.tactic is not None and self.ctx.ref() is not None:
8084  Z3_tactic_dec_ref(self.ctx.ref(), self.tactic)
8085 

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

8120  def __call__(self, goal, *arguments, **keywords):
8121  """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8122 
8123  >>> x, y = Ints('x y')
8124  >>> t = Tactic('solve-eqs')
8125  >>> t(And(x == 0, y >= x + 1))
8126  [[y >= 1]]
8127  """
8128  return self.apply(goal, *arguments, **keywords)
8129 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 8079 of file z3py.py.

8079  def __deepcopy__(self, memo={}):
8080  return Tactic(self.tactic, self.ctx)
8081 

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

8103  def apply(self, goal, *arguments, **keywords):
8104  """Apply tactic `self` to the given goal or Z3 Boolean expression using the given options.
8105 
8106  >>> x, y = Ints('x y')
8107  >>> t = Tactic('solve-eqs')
8108  >>> t.apply(And(x == 0, y >= x + 1))
8109  [[y >= 1]]
8110  """
8111  if z3_debug():
8112  _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expressions expected")
8113  goal = _to_goal(goal)
8114  if len(arguments) > 0 or len(keywords) > 0:
8115  p = args2params(arguments, keywords, self.ctx)
8116  return ApplyResult(Z3_tactic_apply_ex(self.ctx.ref(), self.tactic, goal.goal, p.params), self.ctx)
8117  else:
8118  return ApplyResult(Z3_tactic_apply(self.ctx.ref(), self.tactic, goal.goal), self.ctx)
8119 

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

8130  def help(self):
8131  """Display a string containing a description of the available options for the `self` tactic."""
8132  print(Z3_tactic_get_help(self.ctx.ref(), self.tactic))
8133 

◆ param_descrs()

def param_descrs (   self)
Return the parameter description set.

Definition at line 8134 of file z3py.py.

8134  def param_descrs(self):
8135  """Return the parameter description set."""
8136  return ParamDescrsRef(Z3_tactic_get_param_descrs(self.ctx.ref(), self.tactic), self.ctx)
8137 
8138 

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

8086  def solver(self, logFile=None):
8087  """Create a solver using the tactic `self`.
8088 
8089  The solver supports the methods `push()` and `pop()`, but it
8090  will always solve each `check()` from scratch.
8091 
8092  >>> t = Then('simplify', 'nlsat')
8093  >>> s = t.solver()
8094  >>> x = Real('x')
8095  >>> s.add(x**2 == 2, x > 0)
8096  >>> s.check()
8097  sat
8098  >>> s.model()
8099  [x = 1.4142135623?]
8100  """
8101  return Solver(Z3_mk_solver_from_tactic(self.ctx.ref(), self.tactic), self.ctx, logFile)
8102 

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:11177
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:11202
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:64
z3py.UserPropagateBase.solver
solver
Definition: z3py.py:11180
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:5396