Z3
 
Loading...
Searching...
No Matches
Probe Class Reference

Public Member Functions

 __init__ (self, probe, ctx=None)
 
 __deepcopy__ (self, memo={})
 
 __del__ (self)
 
 __lt__ (self, other)
 
 __gt__ (self, other)
 
 __le__ (self, other)
 
 __ge__ (self, other)
 
 __eq__ (self, other)
 
 __ne__ (self, other)
 
 __call__ (self, goal)
 

Data Fields

 ctx = _get_ctx(ctx)
 
 probe = None
 

Detailed Description

Probes are used to inspect a goal (aka problem) and collect information that may be used
to decide which solver and/or preprocessing step will be used.

Definition at line 8621 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
probe,
ctx = None )

Definition at line 8626 of file z3py.py.

8626 def __init__(self, probe, ctx=None):
8627 self.ctx = _get_ctx(ctx)
8628 self.probe = None
8629 if isinstance(probe, ProbeObj):
8630 self.probe = probe
8631 elif isinstance(probe, float):
8632 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8633 elif _is_int(probe):
8634 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8635 elif isinstance(probe, bool):
8636 if probe:
8637 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8638 else:
8639 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8640 else:
8641 if z3_debug():
8642 _z3_assert(isinstance(probe, str), "probe name expected")
8643 try:
8644 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8645 except Z3Exception:
8646 raise Z3Exception("unknown probe '%s'" % probe)
8647 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8648
Z3_probe Z3_API Z3_mk_probe(Z3_context c, Z3_string name)
Return a probe associated with the given name. The complete list of probes may be obtained using the ...
void Z3_API Z3_probe_inc_ref(Z3_context c, Z3_probe p)
Increment the reference counter of the given probe.
Z3_probe Z3_API Z3_probe_const(Z3_context x, double val)
Return a probe that always evaluates to val.

◆ __del__()

__del__ ( self)

Definition at line 8652 of file z3py.py.

8652 def __del__(self):
8653 if self.probe is not None and self.ctx.ref() is not None and Z3_probe_dec_ref is not None:
8654 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8655
void Z3_API Z3_probe_dec_ref(Z3_context c, Z3_probe p)
Decrement the reference counter of the given probe.

Member Function Documentation

◆ __call__()

__call__ ( self,
goal )
Evaluate the probe `self` in the given goal.

>>> p = Probe('size')
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
2.0
>>> g.add(x < 20)
>>> p(g)
3.0
>>> p = Probe('num-consts')
>>> p(g)
1.0
>>> p = Probe('is-propositional')
>>> p(g)
0.0
>>> p = Probe('is-qflia')
>>> p(g)
1.0

Definition at line 8741 of file z3py.py.

8741 def __call__(self, goal):
8742 """Evaluate the probe `self` in the given goal.
8743
8744 >>> p = Probe('size')
8745 >>> x = Int('x')
8746 >>> g = Goal()
8747 >>> g.add(x > 0)
8748 >>> g.add(x < 10)
8749 >>> p(g)
8750 2.0
8751 >>> g.add(x < 20)
8752 >>> p(g)
8753 3.0
8754 >>> p = Probe('num-consts')
8755 >>> p(g)
8756 1.0
8757 >>> p = Probe('is-propositional')
8758 >>> p(g)
8759 0.0
8760 >>> p = Probe('is-qflia')
8761 >>> p(g)
8762 1.0
8763 """
8764 if z3_debug():
8765 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
8766 goal = _to_goal(goal)
8767 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8768
8769
double Z3_API Z3_probe_apply(Z3_context c, Z3_probe p, Z3_goal g)
Execute the probe over the goal. The probe always produce a double value. "Boolean" probes return 0....

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 8649 of file z3py.py.

8649 def __deepcopy__(self, memo={}):
8650 return Probe(self.probe, self.ctx)
8651

◆ __eq__()

__eq__ ( self,
other )
Return a probe that evaluates to "true" when the value returned by `self`
is equal to the value returned by `other`.

>>> p = Probe('size') == 2
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
1.0

Definition at line 8712 of file z3py.py.

8712 def __eq__(self, other):
8713 """Return a probe that evaluates to "true" when the value returned by `self`
8714 is equal to the value returned by `other`.
8715
8716 >>> p = Probe('size') == 2
8717 >>> x = Int('x')
8718 >>> g = Goal()
8719 >>> g.add(x > 0)
8720 >>> g.add(x < 10)
8721 >>> p(g)
8722 1.0
8723 """
8724 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8725
Z3_probe Z3_API Z3_probe_eq(Z3_context x, Z3_probe p1, Z3_probe p2)
Return a probe that evaluates to "true" when the value returned by p1 is equal to the value returned ...

Referenced by CheckSatResult.__ne__().

◆ __ge__()

__ge__ ( self,
other )
Return a probe that evaluates to "true" when the value returned by `self`
is greater than or equal to the value returned by `other`.

>>> p = Probe('size') >= 2
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
1.0

Definition at line 8698 of file z3py.py.

8698 def __ge__(self, other):
8699 """Return a probe that evaluates to "true" when the value returned by `self`
8700 is greater than or equal to the value returned by `other`.
8701
8702 >>> p = Probe('size') >= 2
8703 >>> x = Int('x')
8704 >>> g = Goal()
8705 >>> g.add(x > 0)
8706 >>> g.add(x < 10)
8707 >>> p(g)
8708 1.0
8709 """
8710 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8711
Z3_probe Z3_API Z3_probe_ge(Z3_context x, Z3_probe p1, Z3_probe p2)
Return a probe that evaluates to "true" when the value returned by p1 is greater than or equal to the...

◆ __gt__()

__gt__ ( self,
other )
Return a probe that evaluates to "true" when the value returned by `self`
is greater than the value returned by `other`.

>>> p = Probe('size') > 10
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
0.0

Definition at line 8670 of file z3py.py.

8670 def __gt__(self, other):
8671 """Return a probe that evaluates to "true" when the value returned by `self`
8672 is greater than the value returned by `other`.
8673
8674 >>> p = Probe('size') > 10
8675 >>> x = Int('x')
8676 >>> g = Goal()
8677 >>> g.add(x > 0)
8678 >>> g.add(x < 10)
8679 >>> p(g)
8680 0.0
8681 """
8682 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8683
Z3_probe Z3_API Z3_probe_gt(Z3_context x, Z3_probe p1, Z3_probe p2)
Return a probe that evaluates to "true" when the value returned by p1 is greater than the value retur...

◆ __le__()

__le__ ( self,
other )
Return a probe that evaluates to "true" when the value returned by `self`
is less than or equal to the value returned by `other`.

>>> p = Probe('size') <= 2
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
1.0

Definition at line 8684 of file z3py.py.

8684 def __le__(self, other):
8685 """Return a probe that evaluates to "true" when the value returned by `self`
8686 is less than or equal to the value returned by `other`.
8687
8688 >>> p = Probe('size') <= 2
8689 >>> x = Int('x')
8690 >>> g = Goal()
8691 >>> g.add(x > 0)
8692 >>> g.add(x < 10)
8693 >>> p(g)
8694 1.0
8695 """
8696 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8697
Z3_probe Z3_API Z3_probe_le(Z3_context x, Z3_probe p1, Z3_probe p2)
Return a probe that evaluates to "true" when the value returned by p1 is less than or equal to the va...

◆ __lt__()

__lt__ ( self,
other )
Return a probe that evaluates to "true" when the value returned by `self`
is less than the value returned by `other`.

>>> p = Probe('size') < 10
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
1.0

Definition at line 8656 of file z3py.py.

8656 def __lt__(self, other):
8657 """Return a probe that evaluates to "true" when the value returned by `self`
8658 is less than the value returned by `other`.
8659
8660 >>> p = Probe('size') < 10
8661 >>> x = Int('x')
8662 >>> g = Goal()
8663 >>> g.add(x > 0)
8664 >>> g.add(x < 10)
8665 >>> p(g)
8666 1.0
8667 """
8668 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8669
Z3_probe Z3_API Z3_probe_lt(Z3_context x, Z3_probe p1, Z3_probe p2)
Return a probe that evaluates to "true" when the value returned by p1 is less than the value returned...

◆ __ne__()

__ne__ ( self,
other )
Return a probe that evaluates to "true" when the value returned by `self`
is not equal to the value returned by `other`.

>>> p = Probe('size') != 2
>>> x = Int('x')
>>> g = Goal()
>>> g.add(x > 0)
>>> g.add(x < 10)
>>> p(g)
0.0

Definition at line 8726 of file z3py.py.

8726 def __ne__(self, other):
8727 """Return a probe that evaluates to "true" when the value returned by `self`
8728 is not equal to the value returned by `other`.
8729
8730 >>> p = Probe('size') != 2
8731 >>> x = Int('x')
8732 >>> g = Goal()
8733 >>> g.add(x > 0)
8734 >>> g.add(x < 10)
8735 >>> p(g)
8736 0.0
8737 """
8738 p = self.__eq__(other)
8739 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8740
Z3_probe Z3_API Z3_probe_not(Z3_context x, Z3_probe p)
Return a probe that evaluates to "true" when p does not evaluate to true.

Field Documentation

◆ ctx

ctx = _get_ctx(ctx)

Definition at line 8627 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), Goal.__copy__(), ModelRef.__copy__(), AstMap.__deepcopy__(), AstRef.__deepcopy__(), AstVector.__deepcopy__(), Datatype.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), Goal.__deepcopy__(), ModelRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), ParamsRef.__deepcopy__(), Statistics.__deepcopy__(), AstMap.__del__(), AstRef.__del__(), AstVector.__del__(), Context.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), Goal.__del__(), ModelRef.__del__(), ParamDescrsRef.__del__(), ParamsRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), Solver.__del__(), Statistics.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstMap.__getitem__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstMap.__len__(), AstVector.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), BoolRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), AstMap.__repr__(), ParamDescrsRef.__repr__(), ParamsRef.__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__(), AstMap.__setitem__(), AstVector.__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(), AstVector.push(), Solver.push(), QuantifierRef.qid(), ArraySortRef.range(), FuncDeclRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), ParamsRef.set(), Solver.set(), AstVector.sexpr(), Goal.sexpr(), ModelRef.sexpr(), Goal.size(), ParamDescrsRef.size(), QuantifierRef.skolem_id(), AstRef.translate(), AstVector.translate(), Goal.translate(), ModelRef.translate(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ probe

probe = None

Definition at line 8628 of file z3py.py.