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

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  stats,
  ctx 
)

Definition at line 7360 of file z3py.py.

7360 def __init__(self, stats, ctx):
7361 self.stats = stats
7362 self.ctx = ctx
7363 Z3_stats_inc_ref(self.ctx.ref(), self.stats)
7364
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 7368 of file z3py.py.

7368 def __del__(self):
7369 if self.ctx.ref() is not None and Z3_stats_dec_ref is not None:
7370 Z3_stats_dec_ref(self.ctx.ref(), self.stats)
7371
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 7365 of file z3py.py.

7365 def __deepcopy__(self, memo={}):
7366 return Statistics(self.stats, self.ctx)
7367

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

7460 def __getattr__(self, name):
7461 """Access the value of statistical using attributes.
7462
7463 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
7464 we should use '_' (e.g., 'nlsat_propagations').
7465
7466 >>> x = Int('x')
7467 >>> s = Then('simplify', 'nlsat').solver()
7468 >>> s.add(x > 0)
7469 >>> s.check()
7470 sat
7471 >>> st = s.statistics()
7472 >>> st.nlsat_propagations
7473 2
7474 >>> st.nlsat_stages
7475 2
7476 """
7477 key = name.replace("_", " ")
7478 try:
7479 return self.get_key_value(key)
7480 except Z3Exception:
7481 raise AttributeError
7482

◆ __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) > 0
True
>>> st[0]
('nlsat propagations', 2)
>>> st[1]
('nlsat restarts', 1)

Definition at line 7404 of file z3py.py.

7404 def __getitem__(self, idx):
7405 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
7406
7407 >>> x = Int('x')
7408 >>> s = Then('simplify', 'nlsat').solver()
7409 >>> s.add(x > 0)
7410 >>> s.check()
7411 sat
7412 >>> st = s.statistics()
7413 >>> len(st) > 0
7414 True
7415 >>> st[0]
7416 ('nlsat propagations', 2)
7417 >>> st[1]
7418 ('nlsat restarts', 1)
7419 """
7420 if idx >= len(self):
7421 raise IndexError
7422 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
7423 val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
7424 else:
7425 val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
7426 return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
7427
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) > 0
True

Definition at line 7390 of file z3py.py.

7390 def __len__(self):
7391 """Return the number of statistical counters.
7392
7393 >>> x = Int('x')
7394 >>> s = Then('simplify', 'nlsat').solver()
7395 >>> s.add(x > 0)
7396 >>> s.check()
7397 sat
7398 >>> st = s.statistics()
7399 >>> len(st) > 0
7400 True
7401 """
7402 return int(Z3_stats_size(self.ctx.ref(), self.stats))
7403
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 7372 of file z3py.py.

7372 def __repr__(self):
7373 if in_html_mode():
7374 out = io.StringIO()
7375 even = True
7376 out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
7377 for k, v in self:
7378 if even:
7379 out.write(u('<tr style="background-color:#CFCFCF">'))
7380 even = False
7381 else:
7382 out.write(u("<tr>"))
7383 even = True
7384 out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
7385 out.write(u("</table>"))
7386 return out.getvalue()
7387 else:
7388 return Z3_stats_to_string(self.ctx.ref(), self.stats)
7389
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 7440 of file z3py.py.

7440 def get_key_value(self, key):
7441 """Return the value of a particular statistical counter.
7442
7443 >>> x = Int('x')
7444 >>> s = Then('simplify', 'nlsat').solver()
7445 >>> s.add(x > 0)
7446 >>> s.check()
7447 sat
7448 >>> st = s.statistics()
7449 >>> st.get_key_value('nlsat propagations')
7450 2
7451 """
7452 for idx in range(len(self)):
7453 if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
7454 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
7455 return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
7456 else:
7457 return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
7458 raise Z3Exception("unknown key")
7459

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

7428 def keys(self):
7429 """Return the list of statistical counters.
7430
7431 >>> x = Int('x')
7432 >>> s = Then('simplify', 'nlsat').solver()
7433 >>> s.add(x > 0)
7434 >>> s.check()
7435 sat
7436 >>> st = s.statistics()
7437 """
7438 return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
7439

Field Documentation

◆ ctx

ctx

Definition at line 7362 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(), FiniteSetSortRef.cast(), 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