Z3 |

Public Member Functions | Data Fields
Probe Class Reference

## Public Member Functions
def | __init__ (self, probe, ctx=None)
def | __deepcopy__ (self, memo={})
def | __del__ (self)
def | __lt__ (self, other)
def | __gt__ (self, other)
def | __le__ (self, other)
def | __ge__ (self, other)
def | __eq__ (self, other)
def | __ne__ (self, other)
def | __call__ (self, goal)

## Data Fields
| ctx
| probe

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

## Constructor & Destructor Documentation

## ◆ __init__()

def __init__ | ( |  | self,
|  |  | probe,
|  |  | ctx = `None`
| ) |  |

Definition at line 8367 of file z3py.py.

8367 def __init__(self, probe, ctx=None):
8368 self.ctx = _get_ctx(ctx)
8369 self.probe = None
8370 if isinstance(probe, ProbeObj):
8371 self.probe = probe
8372 elif isinstance(probe, float):
8373 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8374 elif _is_int(probe):
8375 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8376 elif isinstance(probe, bool):
8377 if probe:
8378 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8379 else:
8380 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8381 else:
8382 if z3_debug():
8383 _z3_assert(isinstance(probe, str), "probe name expected")
8384 try:
8385 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8386 except Z3Exception:
8387 raise Z3Exception("unknown probe '%s'" % probe)
8388 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8389
z3py.z3_debug
def z3_debug()
Definition: z3py.py:64
Z3_mk_probe
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 ...
Z3_probe_inc_ref
void Z3_API Z3_probe_inc_ref(Z3_context c, Z3_probe p)
Increment the reference counter of the given probe.
Z3_probe_const
Z3_probe Z3_API Z3_probe_const(Z3_context x, double val)
Return a probe that always evaluates to val.

## ◆ __del__()

def __del__ | ( |  | self | ) |

Definition at line 8393 of file z3py.py.

8393 def __del__(self):
8394 if self.probe is not None and self.ctx.ref() is not None:
8395 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8396
Z3_probe_dec_ref
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__()

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

8482 def __call__(self, goal):
8483 """Evaluate the probe `self` in the given goal.
8484
8485 >>> p = Probe('size')
8486 >>> x = Int('x')
8487 >>> g = Goal()
8488 >>> g.add(x > 0)
8489 >>> g.add(x < 10)
8490 >>> p(g)
8491 2.0
8492 >>> g.add(x < 20)
8493 >>> p(g)
8494 3.0
8495 >>> p = Probe('num-consts')
8496 >>> p(g)
8497 1.0
8498 >>> p = Probe('is-propositional')
8499 >>> p(g)
8500 0.0
8501 >>> p = Probe('is-qflia')
8502 >>> p(g)
8503 1.0
8504 """
8505 if z3_debug():
8506 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
8507 goal = _to_goal(goal)
8508 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8509
8510
z3py.Int
def Int(name, ctx=None)
Definition: z3py.py:3210
Z3_probe_apply
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__()

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

Definition at line 8390 of file z3py.py.

8390 def __deepcopy__(self, memo={}):
8391 return Probe(self.probe, self.ctx)
8392

## ◆ __eq__()

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

8453 def __eq__(self, other):
8454 """Return a probe that evaluates to "true" when the value returned by `self`
8455 is equal to the value returned by `other`.
8456
8457 >>> p = Probe('size') == 2
8458 >>> x = Int('x')
8459 >>> g = Goal()
8460 >>> g.add(x > 0)
8461 >>> g.add(x < 10)
8462 >>> p(g)
8463 1.0
8464 """
8465 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8466
Z3_probe_eq
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__(), and Probe.__ne__().

## ◆ __ge__()

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

8439 def __ge__(self, other):
8440 """Return a probe that evaluates to "true" when the value returned by `self`
8441 is greater than or equal to the value returned by `other`.
8442
8443 >>> p = Probe('size') >= 2
8444 >>> x = Int('x')
8445 >>> g = Goal()
8446 >>> g.add(x > 0)
8447 >>> g.add(x < 10)
8448 >>> p(g)
8449 1.0
8450 """
8451 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8452
Z3_probe_ge
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__()

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

8411 def __gt__(self, other):
8412 """Return a probe that evaluates to "true" when the value returned by `self`
8413 is greater than the value returned by `other`.
8414
8415 >>> p = Probe('size') > 10
8416 >>> x = Int('x')
8417 >>> g = Goal()
8418 >>> g.add(x > 0)
8419 >>> g.add(x < 10)
8420 >>> p(g)
8421 0.0
8422 """
8423 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8424
Z3_probe_gt
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__()

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

8425 def __le__(self, other):
8426 """Return a probe that evaluates to "true" when the value returned by `self`
8427 is less than or equal to the value returned by `other`.
8428
8429 >>> p = Probe('size') <= 2
8430 >>> x = Int('x')
8431 >>> g = Goal()
8432 >>> g.add(x > 0)
8433 >>> g.add(x < 10)
8434 >>> p(g)
8435 1.0
8436 """
8437 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8438
Z3_probe_le
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__()

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

8397 def __lt__(self, other):
8398 """Return a probe that evaluates to "true" when the value returned by `self`
8399 is less than the value returned by `other`.
8400
8401 >>> p = Probe('size') < 10
8402 >>> x = Int('x')
8403 >>> g = Goal()
8404 >>> g.add(x > 0)
8405 >>> g.add(x < 10)
8406 >>> p(g)
8407 1.0
8408 """
8409 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8410
Z3_probe_lt
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__()

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

8467 def __ne__(self, other):
8468 """Return a probe that evaluates to "true" when the value returned by `self`
8469 is not equal to the value returned by `other`.
8470
8471 >>> p = Probe('size') != 2
8472 >>> x = Int('x')
8473 >>> g = Goal()
8474 >>> g.add(x > 0)
8475 >>> g.add(x < 10)
8476 >>> p(g)
8477 0.0
8478 """
8479 p = self.__eq__(other)
8480 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8481
Z3_probe_not
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

Definition at line 8368 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().

## ◆ probe

probe

Definition at line 8369 of file z3py.py.

Referenced by Probe.__call__(), Probe.__deepcopy__(), Probe.__del__(), Probe.__eq__(), Probe.__ge__(), Probe.__gt__(), Probe.__le__(), and Probe.__lt__().