Z3
Loading...
Searching...
No Matches
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 = stats
 ctx = ctx

Detailed Description

Statistics.

Statistics for `Solver.check()`.

Definition at line 6858 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
stats,
ctx )

Definition at line 6861 of file z3py.py.

6861 def __init__(self, stats, ctx):
6862 self.stats = stats
6863 self.ctx = ctx
6864 Z3_stats_inc_ref(self.ctx.ref(), self.stats)
6865
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 6869 of file z3py.py.

6869 def __del__(self):
6870 if self.ctx.ref() is not None and Z3_stats_dec_ref is not None:
6871 Z3_stats_dec_ref(self.ctx.ref(), self.stats)
6872
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 6866 of file z3py.py.

6866 def __deepcopy__(self, memo={}):
6867 return Statistics(self.stats, self.ctx)
6868

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

6961 def __getattr__(self, name):
6962 """Access the value of statistical using attributes.
6963
6964 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
6965 we should use '_' (e.g., 'nlsat_propagations').
6966
6967 >>> x = Int('x')
6968 >>> s = Then('simplify', 'nlsat').solver()
6969 >>> s.add(x > 0)
6970 >>> s.check()
6971 sat
6972 >>> st = s.statistics()
6973 >>> st.nlsat_propagations
6974 2
6975 >>> st.nlsat_stages
6976 2
6977 """
6978 key = name.replace("_", " ")
6979 try:
6980 return self.get_key_value(key)
6981 except Z3Exception:
6982 raise AttributeError
6983

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

6905 def __getitem__(self, idx):
6906 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6907
6908 >>> x = Int('x')
6909 >>> s = Then('simplify', 'nlsat').solver()
6910 >>> s.add(x > 0)
6911 >>> s.check()
6912 sat
6913 >>> st = s.statistics()
6914 >>> len(st)
6915 7
6916 >>> st[0]
6917 ('nlsat propagations', 2)
6918 >>> st[1]
6919 ('nlsat restarts', 1)
6920 """
6921 if idx >= len(self):
6922 raise IndexError
6923 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6924 val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6925 else:
6926 val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6927 return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
6928
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 6891 of file z3py.py.

6891 def __len__(self):
6892 """Return the number of statistical counters.
6893
6894 >>> x = Int('x')
6895 >>> s = Then('simplify', 'nlsat').solver()
6896 >>> s.add(x > 0)
6897 >>> s.check()
6898 sat
6899 >>> st = s.statistics()
6900 >>> len(st)
6901 7
6902 """
6903 return int(Z3_stats_size(self.ctx.ref(), self.stats))
6904
unsigned Z3_API Z3_stats_size(Z3_context c, Z3_stats s)
Return the number of statistical data in s.

◆ __repr__()

__repr__ ( self)

Definition at line 6873 of file z3py.py.

6873 def __repr__(self):
6874 if in_html_mode():
6875 out = io.StringIO()
6876 even = True
6877 out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
6878 for k, v in self:
6879 if even:
6880 out.write(u('<tr style="background-color:#CFCFCF">'))
6881 even = False
6882 else:
6883 out.write(u("<tr>"))
6884 even = True
6885 out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
6886 out.write(u("</table>"))
6887 return out.getvalue()
6888 else:
6889 return Z3_stats_to_string(self.ctx.ref(), self.stats)
6890
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 6941 of file z3py.py.

6941 def get_key_value(self, key):
6942 """Return the value of a particular statistical counter.
6943
6944 >>> x = Int('x')
6945 >>> s = Then('simplify', 'nlsat').solver()
6946 >>> s.add(x > 0)
6947 >>> s.check()
6948 sat
6949 >>> st = s.statistics()
6950 >>> st.get_key_value('nlsat propagations')
6951 2
6952 """
6953 for idx in range(len(self)):
6954 if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
6955 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6956 return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6957 else:
6958 return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6959 raise Z3Exception("unknown key")
6960

Referenced by __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 6929 of file z3py.py.

6929 def keys(self):
6930 """Return the list of statistical counters.
6931
6932 >>> x = Int('x')
6933 >>> s = Then('simplify', 'nlsat').solver()
6934 >>> s.add(x > 0)
6935 >>> s.check()
6936 sat
6937 >>> st = s.statistics()
6938 """
6939 return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
6940

Field Documentation

◆ ctx

◆ stats

stats = stats

Definition at line 6862 of file z3py.py.

Referenced by __deepcopy__(), __del__(), __getitem__(), __len__(), __repr__(), get_key_value(), and keys().