Z3 |

Public Member Functions | Data Fields
Statistics Class Reference

Statistics. More...

## Public Member Functions
def | __init__ (self, stats, ctx)
def | __deepcopy__ (self, memo={})
def | __del__ (self)
def | __repr__ (self)
def | __len__ (self)
def | __getitem__ (self, idx)
def | keys (self)
def | get_key_value (self, key)
def | __getattr__ (self, name)

## Data Fields
| stats
| ctx

## Detailed Description

Statistics.

    Statistics for `Solver.check()`.

Definition at line 6602 of file z3py.py.

## Constructor & Destructor Documentation

## ◆ __init__()

def __init__ | ( |  | self,
|  |  | stats,
|  |  | ctx
| ) |  |

Definition at line 6605 of file z3py.py.

6605 def __init__(self, stats, ctx):
6606 self.stats = stats
6607 self.ctx = ctx
6608 Z3_stats_inc_ref(self.ctx.ref(), self.stats)
6609
Z3_stats_inc_ref
void Z3_API Z3_stats_inc_ref(Z3_context c, Z3_stats s)
Increment the reference counter of the given statistics object.

## ◆ __del__()

def __del__ | ( |  | self | ) |

Definition at line 6613 of file z3py.py.

6613 def __del__(self):
6614 if self.ctx.ref() is not None:
6615 Z3_stats_dec_ref(self.ctx.ref(), self.stats)
6616
Z3_stats_dec_ref
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__()

def __deepcopy__ | ( |  | self,
|  |  | memo = `{}`
| ) |  |

Definition at line 6610 of file z3py.py.

6610 def __deepcopy__(self, memo={}):
6611 return Statistics(self.stats, self.ctx)
6612

## ◆ __getattr__()

def __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 6705 of file z3py.py.

6705 def __getattr__(self, name):
6706 """Access the value of statistical using attributes.
6707
6708 Remark: to access a counter containing blank spaces (e.g., 'nlsat propagations'),
6709 we should use '_' (e.g., 'nlsat_propagations').
6710
6711 >>> x = Int('x')
6712 >>> s = Then('simplify', 'nlsat').solver()
6713 >>> s.add(x > 0)
6714 >>> s.check()
6715 sat
6716 >>> st = s.statistics()
6717 >>> st.nlsat_propagations
6718 2
6719 >>> st.nlsat_stages
6720 2
6721 """
6722 key = name.replace("_", " ")
6723 try:
6724 return self.get_key_value(key)
6725 except Z3Exception:
6726 raise AttributeError
6727
z3py.Then
def Then(*ts, **ks)
Definition: z3py.py:8191
z3py.Int
def Int(name, ctx=None)
Definition: z3py.py:3210

## ◆ __getitem__()

def __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)
    6
    >>> st[0]
    ('nlsat propagations', 2)
    >>> st[1]
    ('nlsat stages', 2)

Definition at line 6649 of file z3py.py.

6649 def __getitem__(self, idx):
6650 """Return the value of statistical counter at position `idx`. The result is a pair (key, value).
6651
6652 >>> x = Int('x')
6653 >>> s = Then('simplify', 'nlsat').solver()
6654 >>> s.add(x > 0)
6655 >>> s.check()
6656 sat
6657 >>> st = s.statistics()
6658 >>> len(st)
6659 6
6660 >>> st[0]
6661 ('nlsat propagations', 2)
6662 >>> st[1]
6663 ('nlsat stages', 2)
6664 """
6665 if idx >= len(self):
6666 raise IndexError
6667 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6668 val = int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6669 else:
6670 val = Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6671 return (Z3_stats_get_key(self.ctx.ref(), self.stats, idx), val)
6672
Z3_stats_is_uint
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.
Z3_stats_get_uint_value
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.
Z3_stats_get_double_value
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_stats_get_key
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__()

def __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)
    6

Definition at line 6635 of file z3py.py.

6635 def __len__(self):
6636 """Return the number of statistical counters.
6637
6638 >>> x = Int('x')
6639 >>> s = Then('simplify', 'nlsat').solver()
6640 >>> s.add(x > 0)
6641 >>> s.check()
6642 sat
6643 >>> st = s.statistics()
6644 >>> len(st)
6645 6
6646 """
6647 return int(Z3_stats_size(self.ctx.ref(), self.stats))
6648
Z3_stats_size
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__()

def __repr__ | ( |  | self | ) |

Definition at line 6617 of file z3py.py.

6617 def __repr__(self):
6618 if in_html_mode():
6619 out = io.StringIO()
6620 even = True
6621 out.write(u('<table border="1" cellpadding="2" cellspacing="0">'))
6622 for k, v in self:
6623 if even:
6624 out.write(u('<tr style="background-color:#CFCFCF">'))
6625 even = False
6626 else:
6627 out.write(u("<tr>"))
6628 even = True
6629 out.write(u("<td>%s</td><td>%s</td></tr>" % (k, v)))
6630 out.write(u("</table>"))
6631 return out.getvalue()
6632 else:
6633 return Z3_stats_to_string(self.ctx.ref(), self.stats)
6634
Z3_stats_to_string
Z3_string Z3_API Z3_stats_to_string(Z3_context c, Z3_stats s)
Convert a statistics into a string.

## ◆ get_key_value()

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

6685 def get_key_value(self, key):
6686 """Return the value of a particular statistical counter.
6687
6688 >>> x = Int('x')
6689 >>> s = Then('simplify', 'nlsat').solver()
6690 >>> s.add(x > 0)
6691 >>> s.check()
6692 sat
6693 >>> st = s.statistics()
6694 >>> st.get_key_value('nlsat propagations')
6695 2
6696 """
6697 for idx in range(len(self)):
6698 if key == Z3_stats_get_key(self.ctx.ref(), self.stats, idx):
6699 if Z3_stats_is_uint(self.ctx.ref(), self.stats, idx):
6700 return int(Z3_stats_get_uint_value(self.ctx.ref(), self.stats, idx))
6701 else:
6702 return Z3_stats_get_double_value(self.ctx.ref(), self.stats, idx)
6703 raise Z3Exception("unknown key")
6704
z3::range
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:3725

Referenced by Statistics.__getattr__().

## ◆ keys()

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

6673 def keys(self):
6674 """Return the list of statistical counters.
6675
6676 >>> x = Int('x')
6677 >>> s = Then('simplify', 'nlsat').solver()
6678 >>> s.add(x > 0)
6679 >>> s.check()
6680 sat
6681 >>> st = s.statistics()
6682 """
6683 return [Z3_stats_get_key(self.ctx.ref(), self.stats, idx) for idx in range(len(self))]
6684

## Field Documentation

## ◆ ctx

ctx

Definition at line 6607 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), FPRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), Probe.__call__(), AstMap.__contains__(), AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), Solver.__copy__(), AstRef.__deepcopy__(), Datatype.__deepcopy__(), ParamsRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Solver.__deepcopy__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__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__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), ArithRef.__div__(), BitVecRef.__div__(), FPRef.__div__(), ExprRef.__eq__(), Probe.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), Probe.__ge__(), FPRef.__ge__(), SeqRef.__ge__(), QuantifierRef.__getitem__(), ArrayRef.__getitem__(), AstVector.__getitem__(), SeqRef.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ApplyResult.__getitem__(), AstMap.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), Probe.__gt__(), FPRef.__gt__(), SeqRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), Probe.__le__(), FPRef.__le__(), SeqRef.__le__(), AstVector.__len__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), ApplyResult.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), Probe.__lt__(), FPRef.__lt__(), SeqRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), FPRef.__mul__(), ExprRef.__ne__(), Probe.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), FPRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), FPRef.__rdiv__(), ParamsRef.__repr__(), ParamDescrsRef.__repr__(), AstMap.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), FPRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), FPRef.__rsub__(), BitVecRef.__rxor__(), AstVector.__setitem__(), AstMap.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), FPRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), AlgebraicNumRef.approx(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), ApplyResult.as_expr(), FPNumRef.as_string(), Solver.assert_and_track(), Optimize.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Solver.assertions(), Optimize.assertions(), SeqRef.at(), SeqSortRef.basis(), ReSortRef.basis(), QuantifierRef.body(), BoolSortRef.cast(), Solver.check(), Optimize.check(), UserPropagateBase.conflict(), Solver.consequences(), DatatypeSortRef.constructor(), Goal.convert_model(), AstRef.ctx_ref(), UserPropagateBase.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), Solver.dimacs(), ArraySortRef.domain(), FuncDeclRef.domain(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), FPNumRef.exponent(), FPNumRef.exponent_as_bv(), FPNumRef.exponent_as_long(), Solver.from_file(), Optimize.from_file(), Solver.from_string(), Optimize.from_string(), Goal.get(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), ParamDescrsRef.get_documentation(), Fixedpoint.get_ground_sat_answer(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), Fixedpoint.get_num_levels(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), ModelRef.get_sort(), ModelRef.get_universe(), Solver.help(), Fixedpoint.help(), Optimize.help(), Tactic.help(), Solver.import_model_converter(), Goal.inconsistent(), FPNumRef.isInf(), FPNumRef.isNaN(), FPNumRef.isNegative(), FPNumRef.isNormal(), FPNumRef.isPositive(), FPNumRef.isSubnormal(), FPNumRef.isZero(), AstMap.keys(), Statistics.keys(), SortRef.kind(), Optimize.maximize(), Optimize.minimize(), Solver.model(), Optimize.model(), SortRef.name(), FuncDeclRef.name(), QuantifierRef.no_pattern(), Solver.non_units(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), RatNumRef.numerator(), Optimize.objectives(), Solver.param_descrs(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), FuncDeclRef.params(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Optimize.pop(), Solver.pop(), Goal.prec(), Solver.proof(), Solver.push(), Optimize.push(), AstVector.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), FuncDeclRef.range(), ArraySortRef.range(), Solver.reason_unknown(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), DatatypeSortRef.recognizer(), Context.ref(), Fixedpoint.register_relation(), AstMap.reset(), Solver.reset(), AstVector.resize(), Solver.set(), Fixedpoint.set(), Optimize.set(), ParamsRef.set(), Optimize.set_on_model(), Fixedpoint.set_predicate_representation(), Goal.sexpr(), AstVector.sexpr(), ModelRef.sexpr(), Solver.sexpr(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), FPNumRef.sign(), FPNumRef.sign_as_bv(), FPNumRef.significand(), FPNumRef.significand_as_bv(), FPNumRef.significand_as_long(), ParamDescrsRef.size(), Goal.size(), Tactic.solver(), ExprRef.sort(), BoolRef.sort(), QuantifierRef.sort(), ArithRef.sort(), BitVecRef.sort(), ArrayRef.sort(), DatatypeRef.sort(), FiniteDomainRef.sort(), FPRef.sort(), SeqRef.sort(), Solver.statistics(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Solver.trail(), Solver.trail_levels(), AstVector.translate(), FuncInterp.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), Solver.translate(), Solver.units(), Solver.unsat_core(), Optimize.unsat_core(), Fixedpoint.update_rule(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

## ◆ stats

stats

Definition at line 6606 of file z3py.py.

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