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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
stats,
ctx )

Definition at line 6832 of file z3py.py.

6832 def __init__(self, stats, ctx):
6833 self.stats = stats
6834 self.ctx = ctx
6835 Z3_stats_inc_ref(self.ctx.ref(), self.stats)
6836
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 6840 of file z3py.py.

6840 def __del__(self):
6841 if self.ctx.ref() is not None and Z3_stats_dec_ref is not None:
6842 Z3_stats_dec_ref(self.ctx.ref(), self.stats)
6843
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 6837 of file z3py.py.

6837 def __deepcopy__(self, memo={}):
6838 return Statistics(self.stats, self.ctx)
6839

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

6932 def __getattr__(self, name):
6933 """Access the value of statistical using attributes.
6934
6935 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
6936 we should use '_' (e.g., 'nlsat_propagations').
6937
6938 >>> x = Int('x')
6939 >>> s = Then('simplify', 'nlsat').solver()
6940 >>> s.add(x > 0)
6941 >>> s.check()
6942 sat
6943 >>> st = s.statistics()
6944 >>> st.nlsat_propagations
6945 2
6946 >>> st.nlsat_stages
6947 2
6948 """
6949 key = name.replace("_", " ")
6950 try:
6951 return self.get_key_value(key)
6952 except Z3Exception:
6953 raise AttributeError
6954

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

6876 def __getitem__(self, idx):
6877 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6878
6879 >>> x = Int('x')
6880 >>> s = Then('simplify', 'nlsat').solver()
6881 >>> s.add(x > 0)
6882 >>> s.check()
6883 sat
6884 >>> st = s.statistics()
6885 >>> len(st)
6886 7
6887 >>> st[0]
6888 ('nlsat propagations', 2)
6889 >>> st[1]
6890 ('nlsat restarts', 1)
6891 """
6892 if idx >= len(self):
6893 raise IndexError
6894 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6895 val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6896 else:
6897 val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6898 return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
6899
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 6862 of file z3py.py.

6862 def __len__(self):
6863 """Return the number of statistical counters.
6864
6865 >>> x = Int('x')
6866 >>> s = Then('simplify', 'nlsat').solver()
6867 >>> s.add(x > 0)
6868 >>> s.check()
6869 sat
6870 >>> st = s.statistics()
6871 >>> len(st)
6872 7
6873 """
6874 return int(Z3_stats_size(self.ctx.ref(), self.stats))
6875
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 6844 of file z3py.py.

6844 def __repr__(self):
6845 if in_html_mode():
6846 out = io.StringIO()
6847 even = True
6848 out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
6849 for k, v in self:
6850 if even:
6851 out.write(u('<tr style="background-color:#CFCFCF">'))
6852 even = False
6853 else:
6854 out.write(u("<tr>"))
6855 even = True
6856 out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
6857 out.write(u("</table>"))
6858 return out.getvalue()
6859 else:
6860 return Z3_stats_to_string(self.ctx.ref(), self.stats)
6861
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 6912 of file z3py.py.

6912 def get_key_value(self, key):
6913 """Return the value of a particular statistical counter.
6914
6915 >>> x = Int('x')
6916 >>> s = Then('simplify', 'nlsat').solver()
6917 >>> s.add(x > 0)
6918 >>> s.check()
6919 sat
6920 >>> st = s.statistics()
6921 >>> st.get_key_value('nlsat propagations')
6922 2
6923 """
6924 for idx in range(len(self)):
6925 if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
6926 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6927 return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6928 else:
6929 return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6930 raise Z3Exception("unknown key")
6931

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

6900 def keys(self):
6901 """Return the list of statistical counters.
6902
6903 >>> x = Int('x')
6904 >>> s = Then('simplify', 'nlsat').solver()
6905 >>> s.add(x > 0)
6906 >>> s.check()
6907 sat
6908 >>> st = s.statistics()
6909 """
6910 return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
6911

Field Documentation

◆ ctx

◆ stats

stats = stats

Definition at line 6833 of file z3py.py.

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