Z3
 
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
Statistics Class Reference

Statistics. More...

Public Member Functions

 __init__ (self, stats, ctx)
 
 __deepcopy__ (self, memo={})
 
 __del__ (self)
 
 __repr__ (self)
 
 __len__ (self)
 
 __getitem__ (self, idx)
 
 keys (self)
 
 get_key_value (self, key)
 
 __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

◆ __init__()

__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.

◆ __del__()

__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.

Member Function Documentation

◆ __deepcopy__()

__deepcopy__ (   self,
  memo = {} 
)

Definition at line 6982 of file z3py.py.

6982 def __deepcopy__(self, memo={}):
6983 return Statistics(self.stats, self.ctx)
6984

◆ __getattr__()

__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

◆ __getitem__()

__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.
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.
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.

◆ __len__()

__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.

Referenced by AstVector.__getitem__(), and AstVector.__setitem__().

◆ __repr__()

__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
Z3_string Z3_API Z3_stats_to_string(Z3_context c, Z3_stats s)
Convert a statistics into a string.

◆ get_key_value()

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.

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

Referenced by Statistics.__getattr__().

◆ keys()

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

Field Documentation

◆ ctx

ctx

Definition at line 6979 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), AstRef.__deepcopy__(), Datatype.__deepcopy__(), ParamsRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Context.__del__(), AstRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), ParamsRef.__del__(), ParamDescrsRef.__del__(), Goal.__del__(), AstVector.__del__(), AstMap.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), ModelRef.__del__(), Statistics.__del__(), Solver.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), AstMap.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstVector.__len__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), BoolRef.__mul__(), ArithRef.__mul__(), BitVecRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), ParamsRef.__repr__(), ParamDescrsRef.__repr__(), AstMap.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), AstVector.__setitem__(), AstMap.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), Solver.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), QuantifierRef.body(), Solver.check(), Goal.convert_model(), AstRef.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), FuncDeclRef.domain(), ArraySortRef.domain_n(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), Goal.get(), ParamDescrsRef.get_documentation(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), ModelRef.get_sort(), ModelRef.get_universe(), Goal.inconsistent(), AstMap.keys(), Statistics.keys(), Solver.model(), SortRef.name(), QuantifierRef.no_pattern(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Solver.pop(), Goal.prec(), ModelRef.project(), ModelRef.project_with_witness(), Solver.push(), AstVector.push(), QuantifierRef.qid(), FuncDeclRef.range(), ArraySortRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), Solver.set(), ParamsRef.set(), Goal.sexpr(), AstVector.sexpr(), ModelRef.sexpr(), ParamDescrsRef.size(), Goal.size(), QuantifierRef.skolem_id(), AstVector.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), ExprRef.update(), DatatypeRef.update_field(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ stats

stats