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

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  stats,
  ctx 
)

Definition at line 6889 of file z3py.py.

6889 def __init__(self, stats, ctx):
6890 self.stats = stats
6891 self.ctx = ctx
6892 Z3_stats_inc_ref(self.ctx.ref(), self.stats)
6893
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 6897 of file z3py.py.

6897 def __del__(self):
6898 if self.ctx.ref() is not None and Z3_stats_dec_ref is not None:
6899 Z3_stats_dec_ref(self.ctx.ref(), self.stats)
6900
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 6894 of file z3py.py.

6894 def __deepcopy__(self, memo={}):
6895 return Statistics(self.stats, self.ctx)
6896

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

6989 def __getattr__(self, name):
6990 """Access the value of statistical using attributes.
6991
6992 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
6993 we should use '_' (e.g., 'nlsat_propagations').
6994
6995 >>> x = Int('x')
6996 >>> s = Then('simplify', 'nlsat').solver()
6997 >>> s.add(x > 0)
6998 >>> s.check()
6999 sat
7000 >>> st = s.statistics()
7001 >>> st.nlsat_propagations
7002 2
7003 >>> st.nlsat_stages
7004 2
7005 """
7006 key = name.replace("_", " ")
7007 try:
7008 return self.get_key_value(key)
7009 except Z3Exception:
7010 raise AttributeError
7011

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

6933 def __getitem__(self, idx):
6934 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6935
6936 >>> x = Int('x')
6937 >>> s = Then('simplify', 'nlsat').solver()
6938 >>> s.add(x > 0)
6939 >>> s.check()
6940 sat
6941 >>> st = s.statistics()
6942 >>> len(st)
6943 7
6944 >>> st[0]
6945 ('nlsat propagations', 2)
6946 >>> st[1]
6947 ('nlsat restarts', 1)
6948 """
6949 if idx >= len(self):
6950 raise IndexError
6951 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6952 val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6953 else:
6954 val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6955 return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
6956
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 6919 of file z3py.py.

6919 def __len__(self):
6920 """Return the number of statistical counters.
6921
6922 >>> x = Int('x')
6923 >>> s = Then('simplify', 'nlsat').solver()
6924 >>> s.add(x > 0)
6925 >>> s.check()
6926 sat
6927 >>> st = s.statistics()
6928 >>> len(st)
6929 7
6930 """
6931 return int(Z3_stats_size(self.ctx.ref(), self.stats))
6932
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 6901 of file z3py.py.

6901 def __repr__(self):
6902 if in_html_mode():
6903 out = io.StringIO()
6904 even = True
6905 out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
6906 for k, v in self:
6907 if even:
6908 out.write(u('<tr style="background-color:#CFCFCF">'))
6909 even = False
6910 else:
6911 out.write(u("<tr>"))
6912 even = True
6913 out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
6914 out.write(u("</table>"))
6915 return out.getvalue()
6916 else:
6917 return Z3_stats_to_string(self.ctx.ref(), self.stats)
6918
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 6969 of file z3py.py.

6969 def get_key_value(self, key):
6970 """Return the value of a particular statistical counter.
6971
6972 >>> x = Int('x')
6973 >>> s = Then('simplify', 'nlsat').solver()
6974 >>> s.add(x > 0)
6975 >>> s.check()
6976 sat
6977 >>> st = s.statistics()
6978 >>> st.get_key_value('nlsat propagations')
6979 2
6980 """
6981 for idx in range(len(self)):
6982 if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
6983 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6984 return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6985 else:
6986 return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6987 raise Z3Exception("unknown key")
6988

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

6957 def keys(self):
6958 """Return the list of statistical counters.
6959
6960 >>> x = Int('x')
6961 >>> s = Then('simplify', 'nlsat').solver()
6962 >>> s.add(x > 0)
6963 >>> s.check()
6964 sat
6965 >>> st = s.statistics()
6966 """
6967 return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
6968

Field Documentation

◆ ctx

ctx

Definition at line 6891 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(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ stats

stats