Z3
Public Member Functions | Data Fields
Statistics Class Reference

Statistics. More...

Public Member Functions

def __init__ (self, stats, ctx)
 
def __deepcopy__
 
def __del__ (self)
 
def __repr__ (self)
 
def __len__ (self)
 
def __getitem__ (self, idx)
 
def keys (self)
 
def get_key_value (self, key)
 
def __getattr__ (self, name)
 

Data Fields

 stats
 
 ctx
 

Detailed Description

Statistics.

Statistics for `Solver.check()`.

Definition at line 6974 of file z3py.py.

Constructor & Destructor Documentation

def __init__ (   self,
  stats,
  ctx 
)

Definition at line 6977 of file z3py.py.

6977  def __init__(self, stats, ctx):
6978  self.stats = stats
6979  self.ctx = ctx
6980  Z3_stats_inc_ref(self.ctx.ref(), self.stats)
6981 
void Z3_API Z3_stats_inc_ref(Z3_context c, Z3_stats s)
Increment the reference counter of the given statistics object.
def __init__(self, stats, ctx)
Definition: z3py.py:6977
def __del__ (   self)

Definition at line 6985 of file z3py.py.

6985  def __del__(self):
6986  if self.ctx.ref() is not None and Z3_stats_dec_ref is not None:
6987  Z3_stats_dec_ref(self.ctx.ref(), self.stats)
6988 
void Z3_API Z3_stats_dec_ref(Z3_context c, Z3_stats s)
Decrement the reference counter of the given statistics object.
def __del__(self)
Definition: z3py.py:6985

Member Function Documentation

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 6982 of file z3py.py.

6982  def __deepcopy__(self, memo={}):
6983  return Statistics(self.stats, self.ctx)
6984 
def __deepcopy__
Definition: z3py.py:6982
Statistics.
Definition: z3py.py:6974
def __getattr__ (   self,
  name 
)
Access the value of statistical using attributes.

Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
we should use '_' (e.g., 'nlsat_propagations').

>>> x = Int('x')
>>> s = Then('simplify', 'nlsat').solver()
>>> s.add(x > 0)
>>> s.check()
sat
>>> st = s.statistics()
>>> st.nlsat_propagations
2
>>> st.nlsat_stages
2

Definition at line 7077 of file z3py.py.

7077  def __getattr__(self, name):
7078  """Access the value of statistical using attributes.
7079 
7080  Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
7081  we should use '_' (e.g., 'nlsat_propagations').
7082 
7083  >>> x = Int('x')
7084  >>> s = Then('simplify', 'nlsat').solver()
7085  >>> s.add(x > 0)
7086  >>> s.check()
7087  sat
7088  >>> st = s.statistics()
7089  >>> st.nlsat_propagations
7090  2
7091  >>> st.nlsat_stages
7092  2
7093  """
7094  key = name.replace("_", " ")
7095  try:
7096  return self.get_key_value(key)
7097  except Z3Exception:
7098  raise AttributeError
7099 
def __getattr__(self, name)
Definition: z3py.py:7077
def get_key_value(self, key)
Definition: z3py.py:7057
def __getitem__ (   self,
  idx 
)
Return the value of statistical counter at position `idx`. The result is a pair (key, value).

>>> x = Int('x')
>>> s = Then('simplify', 'nlsat').solver()
>>> s.add(x > 0)
>>> s.check()
sat
>>> st = s.statistics()
>>> len(st)
7
>>> st[0]
('nlsat propagations', 2)
>>> st[1]
('nlsat restarts', 1)

Definition at line 7021 of file z3py.py.

7021  def __getitem__(self, idx):
7022  """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
7023 
7024  >>> x = Int('x')
7025  >>> s = Then('simplify', 'nlsat').solver()
7026  >>> s.add(x > 0)
7027  >>> s.check()
7028  sat
7029  >>> st = s.statistics()
7030  >>> len(st)
7031  7
7032  >>> st[0]
7033  ('nlsat propagations', 2)
7034  >>> st[1]
7035  ('nlsat restarts', 1)
7036  """
7037  if idx >= len(self):
7038  raise IndexError
7039  if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
7040  val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
7041  else:
7042  val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
7043  return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
7044 
bool Z3_API Z3_stats_is_uint(Z3_context c, Z3_stats s, unsigned idx)
Return true if the given statistical data is a unsigned integer.
Z3_string Z3_API Z3_stats_get_key(Z3_context c, Z3_stats s, unsigned idx)
Return the key (a string) for a particular statistical data.
unsigned Z3_API Z3_stats_get_uint_value(Z3_context c, Z3_stats s, unsigned idx)
Return the unsigned value of the given statistical data.
double Z3_API Z3_stats_get_double_value(Z3_context c, Z3_stats s, unsigned idx)
Return the double value of the given statistical data.
def __getitem__(self, idx)
Definition: z3py.py:7021
def __len__ (   self)
Return the number of statistical counters.

>>> x = Int('x')
>>> s = Then('simplify', 'nlsat').solver()
>>> s.add(x > 0)
>>> s.check()
sat
>>> st = s.statistics()
>>> len(st)
7

Definition at line 7007 of file z3py.py.

7007  def __len__(self):
7008  """Return the number of statistical counters.
7009 
7010  >>> x = Int('x')
7011  >>> s = Then('simplify', 'nlsat').solver()
7012  >>> s.add(x > 0)
7013  >>> s.check()
7014  sat
7015  >>> st = s.statistics()
7016  >>> len(st)
7017  7
7018  """
7019  return int(Z3_stats_size(self.ctx.ref(), self.stats))
7020 
unsigned Z3_API Z3_stats_size(Z3_context c, Z3_stats s)
Return the number of statistical data in s.
def __len__(self)
Definition: z3py.py:7007
def __repr__ (   self)

Definition at line 6989 of file z3py.py.

6989  def __repr__(self):
6990  if in_html_mode():
6991  out = io.StringIO()
6992  even = True
6993  out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
6994  for k, v in self:
6995  if even:
6996  out.write(u('<tr style="background-color:#CFCFCF">'))
6997  even = False
6998  else:
6999  out.write(u("<tr>"))
7000  even = True
7001  out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
7002  out.write(u("</table>"))
7003  return out.getvalue()
7004  else:
7005  return Z3_stats_to_string(self.ctx.ref(), self.stats)
7006 
def __repr__(self)
Definition: z3py.py:6989
Z3_string Z3_API Z3_stats_to_string(Z3_context c, Z3_stats s)
Convert a statistics into a string.
def get_key_value (   self,
  key 
)
Return the value of a particular statistical counter.

>>> x = Int('x')
>>> s = Then('simplify', 'nlsat').solver()
>>> s.add(x > 0)
>>> s.check()
sat
>>> st = s.statistics()
>>> st.get_key_value('nlsat propagations')
2

Definition at line 7057 of file z3py.py.

Referenced by Statistics.__getattr__().

7057  def get_key_value(self, key):
7058  """Return the value of a particular statistical counter.
7059 
7060  >>> x = Int('x')
7061  >>> s = Then('simplify', 'nlsat').solver()
7062  >>> s.add(x > 0)
7063  >>> s.check()
7064  sat
7065  >>> st = s.statistics()
7066  >>> st.get_key_value('nlsat propagations')
7067  2
7068  """
7069  for idx in range(len(self)):
7070  if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
7071  if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
7072  return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
7073  else:
7074  return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
7075  raise Z3Exception("unknown key")
7076 
bool Z3_API Z3_stats_is_uint(Z3_context c, Z3_stats s, unsigned idx)
Return true if the given statistical data is a unsigned integer.
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:4343
Z3_string Z3_API Z3_stats_get_key(Z3_context c, Z3_stats s, unsigned idx)
Return the key (a string) for a particular statistical data.
def get_key_value(self, key)
Definition: z3py.py:7057
unsigned Z3_API Z3_stats_get_uint_value(Z3_context c, Z3_stats s, unsigned idx)
Return the unsigned value of the given statistical data.
double Z3_API Z3_stats_get_double_value(Z3_context c, Z3_stats s, unsigned idx)
Return the double value of the given statistical data.
def keys (   self)
Return the list of statistical counters.

>>> x = Int('x')
>>> s = Then('simplify', 'nlsat').solver()
>>> s.add(x > 0)
>>> s.check()
sat
>>> st = s.statistics()

Definition at line 7045 of file z3py.py.

7045  def keys(self):
7046  """Return the list of statistical counters.
7047 
7048  >>> x = Int('x')
7049  >>> s = Then('simplify', 'nlsat').solver()
7050  >>> s.add(x > 0)
7051  >>> s.check()
7052  sat
7053  >>> st = s.statistics()
7054  """
7055  return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
7056 
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:4343
Z3_string Z3_API Z3_stats_get_key(Z3_context c, Z3_stats s, unsigned idx)
Return the key (a string) for a particular statistical data.
def keys(self)
Definition: z3py.py:7045

Field Documentation

ctx

Definition at line 6979 of file z3py.py.

Referenced by Solver.__copy__(), Statistics.__deepcopy__(), Solver.__deepcopy__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Simplifier.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), Probe.__eq__(), Probe.__ge__(), ApplyResult.__getitem__(), Probe.__gt__(), Probe.__le__(), Probe.__lt__(), Probe.__ne__(), Simplifier.add(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), ApplyResult.as_expr(), Solver.assert_and_track(), Optimize.assert_and_track(), Solver.assert_exprs(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Solver.assertions(), Optimize.assertions(), Solver.check(), Solver.consequences(), Solver.explain_congruent(), ParserContext.from_string(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), Fixedpoint.get_ground_sat_answer(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), Solver.model(), Optimize.model(), Solver.next(), Solver.non_units(), Optimize.objectives(), Solver.param_descrs(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Simplifier.param_descrs(), Tactic.param_descrs(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), Solver.proof(), Fixedpoint.query(), Solver.root(), Solver.set(), Fixedpoint.set(), Optimize.set(), Optimize.set_on_model(), Solver.solve_for(), Tactic.solver(), Solver.statistics(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Solver.trail(), Solver.units(), Solver.unsat_core(), Optimize.unsat_core(), Fixedpoint.update_rule(), and Simplifier.using_params().

stats