Z3
 
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
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
 
 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 8536 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  probe,
  ctx = None 
)

Definition at line 8541 of file z3py.py.

8541 def __init__(self, probe, ctx=None):
8542 self.ctx = _get_ctx(ctx)
8543 self.probe = None
8544 if isinstance(probe, ProbeObj):
8545 self.probe = probe
8546 elif isinstance(probe, float):
8547 self.probe = Z3_probe_const(self.ctx.ref(), probe)
8548 elif _is_int(probe):
8549 self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
8550 elif isinstance(probe, bool):
8551 if probe:
8552 self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
8553 else:
8554 self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
8555 else:
8556 if z3_debug():
8557 _z3_assert(isinstance(probe, str), "probe name expected")
8558 try:
8559 self.probe = Z3_mk_probe(self.ctx.ref(), probe)
8560 except Z3Exception:
8561 raise Z3Exception("unknown probe '%s'" % probe)
8562 Z3_probe_inc_ref(self.ctx.ref(), self.probe)
8563
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 8567 of file z3py.py.

8567 def __del__(self):
8568 if self.probe is not None and self.ctx.ref() is not None and Z3_probe_dec_ref is not None:
8569 Z3_probe_dec_ref(self.ctx.ref(), self.probe)
8570
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 8656 of file z3py.py.

8656 def __call__(self, goal):
8657 """Evaluate the probe `self` in the given goal.
8658
8659 >>> p = Probe('size')
8660 >>> x = Int('x')
8661 >>> g = Goal()
8662 >>> g.add(x > 0)
8663 >>> g.add(x < 10)
8664 >>> p(g)
8665 2.0
8666 >>> g.add(x < 20)
8667 >>> p(g)
8668 3.0
8669 >>> p = Probe('num-consts')
8670 >>> p(g)
8671 1.0
8672 >>> p = Probe('is-propositional')
8673 >>> p(g)
8674 0.0
8675 >>> p = Probe('is-qflia')
8676 >>> p(g)
8677 1.0
8678 """
8679 if z3_debug():
8680 _z3_assert(isinstance(goal, (Goal, BoolRef)), "Z3 Goal or Boolean expression expected")
8681 goal = _to_goal(goal)
8682 return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8683
8684
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 8564 of file z3py.py.

8564 def __deepcopy__(self, memo={}):
8565 return Probe(self.probe, self.ctx)
8566

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

8627 def __eq__(self, other):
8628 """Return a probe that evaluates to "true" when the value returned by `self`
8629 is equal to the value returned by `other`.
8630
8631 >>> p = Probe('size') == 2
8632 >>> x = Int('x')
8633 >>> g = Goal()
8634 >>> g.add(x > 0)
8635 >>> g.add(x < 10)
8636 >>> p(g)
8637 1.0
8638 """
8639 return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8640
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 8613 of file z3py.py.

8613 def __ge__(self, other):
8614 """Return a probe that evaluates to "true" when the value returned by `self`
8615 is greater than or equal to the value returned by `other`.
8616
8617 >>> p = Probe('size') >= 2
8618 >>> x = Int('x')
8619 >>> g = Goal()
8620 >>> g.add(x > 0)
8621 >>> g.add(x < 10)
8622 >>> p(g)
8623 1.0
8624 """
8625 return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8626
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 8585 of file z3py.py.

8585 def __gt__(self, other):
8586 """Return a probe that evaluates to "true" when the value returned by `self`
8587 is greater than the value returned by `other`.
8588
8589 >>> p = Probe('size') > 10
8590 >>> x = Int('x')
8591 >>> g = Goal()
8592 >>> g.add(x > 0)
8593 >>> g.add(x < 10)
8594 >>> p(g)
8595 0.0
8596 """
8597 return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8598
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 8599 of file z3py.py.

8599 def __le__(self, other):
8600 """Return a probe that evaluates to "true" when the value returned by `self`
8601 is less than or equal to the value returned by `other`.
8602
8603 >>> p = Probe('size') <= 2
8604 >>> x = Int('x')
8605 >>> g = Goal()
8606 >>> g.add(x > 0)
8607 >>> g.add(x < 10)
8608 >>> p(g)
8609 1.0
8610 """
8611 return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8612
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 8571 of file z3py.py.

8571 def __lt__(self, other):
8572 """Return a probe that evaluates to "true" when the value returned by `self`
8573 is less than the value returned by `other`.
8574
8575 >>> p = Probe('size') < 10
8576 >>> x = Int('x')
8577 >>> g = Goal()
8578 >>> g.add(x > 0)
8579 >>> g.add(x < 10)
8580 >>> p(g)
8581 1.0
8582 """
8583 return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8584
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 8641 of file z3py.py.

8641 def __ne__(self, other):
8642 """Return a probe that evaluates to "true" when the value returned by `self`
8643 is not equal to the value returned by `other`.
8644
8645 >>> p = Probe('size') != 2
8646 >>> x = Int('x')
8647 >>> g = Goal()
8648 >>> g.add(x > 0)
8649 >>> g.add(x < 10)
8650 >>> p(g)
8651 0.0
8652 """
8653 p = self.__eq__(other)
8654 return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8655
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 8542 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(), 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(), Solver.push(), AstVector.push(), 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(), AstVector.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ probe

probe

Definition at line 8543 of file z3py.py.