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

Constructor & Destructor Documentation

def __init__ (   self,
  stats,
  ctx 
)

Definition at line 6707 of file z3py.py.

6707  def __init__(self, stats, ctx):
6708  self.stats = stats
6709  self.ctx = ctx
6710  Z3_stats_inc_ref(self.ctx.ref(), self.stats)
6711 
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:6707
def __del__ (   self)

Definition at line 6715 of file z3py.py.

6715  def __del__(self):
6716  if self.ctx.ref() is not None and Z3_stats_dec_ref is not None:
6717  Z3_stats_dec_ref(self.ctx.ref(), self.stats)
6718 
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:6715

Member Function Documentation

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 6712 of file z3py.py.

6712  def __deepcopy__(self, memo={}):
6713  return Statistics(self.stats, self.ctx)
6714 
def __deepcopy__
Definition: z3py.py:6712
Statistics.
Definition: z3py.py:6704
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 6807 of file z3py.py.

6807  def __getattr__(self, name):
6808  """Access the value of statistical using attributes.
6809 
6810  Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
6811  we should use '_' (e.g., 'nlsat_propagations').
6812 
6813  >>> x = Int('x')
6814  >>> s = Then('simplify', 'nlsat').solver()
6815  >>> s.add(x > 0)
6816  >>> s.check()
6817  sat
6818  >>> st = s.statistics()
6819  >>> st.nlsat_propagations
6820  2
6821  >>> st.nlsat_stages
6822  2
6823  """
6824  key = name.replace("_", " ")
6825  try:
6826  return self.get_key_value(key)
6827  except Z3Exception:
6828  raise AttributeError
6829 
def __getattr__(self, name)
Definition: z3py.py:6807
def get_key_value(self, key)
Definition: z3py.py:6787
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)
6
>>> st[0]
('nlsat propagations', 2)
>>> st[1]
('nlsat stages', 2)

Definition at line 6751 of file z3py.py.

6751  def __getitem__(self, idx):
6752  """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6753 
6754  >>> x = Int('x')
6755  >>> s = Then('simplify', 'nlsat').solver()
6756  >>> s.add(x > 0)
6757  >>> s.check()
6758  sat
6759  >>> st = s.statistics()
6760  >>> len(st)
6761  6
6762  >>> st[0]
6763  ('nlsat propagations', 2)
6764  >>> st[1]
6765  ('nlsat stages', 2)
6766  """
6767  if idx >= len(self):
6768  raise IndexError
6769  if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6770  val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6771  else:
6772  val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6773  return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
6774 
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:6751
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)
6

Definition at line 6737 of file z3py.py.

6737  def __len__(self):
6738  """Return the number of statistical counters.
6739 
6740  >>> x = Int('x')
6741  >>> s = Then('simplify', 'nlsat').solver()
6742  >>> s.add(x > 0)
6743  >>> s.check()
6744  sat
6745  >>> st = s.statistics()
6746  >>> len(st)
6747  6
6748  """
6749  return int(Z3_stats_size(self.ctx.ref(), self.stats))
6750 
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:6737
def __repr__ (   self)

Definition at line 6719 of file z3py.py.

6719  def __repr__(self):
6720  if in_html_mode():
6721  out = io.StringIO()
6722  even = True
6723  out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
6724  for k, v in self:
6725  if even:
6726  out.write(u('<tr style="background-color:#CFCFCF">'))
6727  even = False
6728  else:
6729  out.write(u("<tr>"))
6730  even = True
6731  out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
6732  out.write(u("</table>"))
6733  return out.getvalue()
6734  else:
6735  return Z3_stats_to_string(self.ctx.ref(), self.stats)
6736 
def __repr__(self)
Definition: z3py.py:6719
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 6787 of file z3py.py.

Referenced by Statistics.__getattr__().

6787  def get_key_value(self, key):
6788  """Return the value of a particular statistical counter.
6789 
6790  >>> x = Int('x')
6791  >>> s = Then('simplify', 'nlsat').solver()
6792  >>> s.add(x > 0)
6793  >>> s.check()
6794  sat
6795  >>> st = s.statistics()
6796  >>> st.get_key_value('nlsat propagations')
6797  2
6798  """
6799  for idx in range(len(self)):
6800  if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
6801  if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6802  return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6803  else:
6804  return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6805  raise Z3Exception("unknown key")
6806 
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:4085
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:6787
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 6775 of file z3py.py.

6775  def keys(self):
6776  """Return the list of statistical counters.
6777 
6778  >>> x = Int('x')
6779  >>> s = Then('simplify', 'nlsat').solver()
6780  >>> s.add(x > 0)
6781  >>> s.check()
6782  sat
6783  >>> st = s.statistics()
6784  """
6785  return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
6786 
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:4085
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:6775

Field Documentation

ctx

Definition at line 6709 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(), 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(), 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