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

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  probe,
  ctx = None 
)

Definition at line 7948 of file z3py.py.

7948  def __init__(self, probe, ctx=None):
7949  self.ctx = _get_ctx(ctx)
7950  self.probe = None
7951  if isinstance(probe, ProbeObj):
7952  self.probe = probe
7953  elif isinstance(probe, float):
7954  self.probe = Z3_probe_const(self.ctx.ref(), probe)
7955  elif _is_int(probe):
7956  self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
7957  elif isinstance(probe, bool):
7958  if probe:
7959  self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
7960  else:
7961  self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
7962  else:
7963  if z3_debug():
7964  _z3_assert(isinstance(probe, str), "probe name expected")
7965  try:
7966  self.probe = Z3_mk_probe(self.ctx.ref(), probe)
7967  except Z3Exception:
7968  raise Z3Exception("unknown probe '%s'" % probe)
7969  Z3_probe_inc_ref(self.ctx.ref(), self.probe)
7970 

◆ __del__()

def __del__ (   self)

Definition at line 7974 of file z3py.py.

7974  def __del__(self):
7975  if self.probe is not None and self.ctx.ref() is not None:
7976  Z3_probe_dec_ref(self.ctx.ref(), self.probe)
7977 

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

8057  def __call__(self, goal):
8058  """Evaluate the probe `self` in the given goal.
8059 
8060  >>> p = Probe('size')
8061  >>> x = Int('x')
8062  >>> g = Goal()
8063  >>> g.add(x > 0)
8064  >>> g.add(x < 10)
8065  >>> p(g)
8066  2.0
8067  >>> g.add(x < 20)
8068  >>> p(g)
8069  3.0
8070  >>> p = Probe('num-consts')
8071  >>> p(g)
8072  1.0
8073  >>> p = Probe('is-propositional')
8074  >>> p(g)
8075  0.0
8076  >>> p = Probe('is-qflia')
8077  >>> p(g)
8078  1.0
8079  """
8080  if z3_debug():
8081  _z3_assert(isinstance(goal, Goal) or isinstance(goal, BoolRef), "Z3 Goal or Boolean expression expected")
8082  goal = _to_goal(goal)
8083  return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8084 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 7971 of file z3py.py.

7971  def __deepcopy__(self, memo={}):
7972  return Probe(self.probe, self.ctx)
7973 

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

8030  def __eq__(self, other):
8031  """Return a probe that evaluates to "true" when the value returned by `self` is equal to the value returned by `other`.
8032 
8033  >>> p = Probe('size') == 2
8034  >>> x = Int('x')
8035  >>> g = Goal()
8036  >>> g.add(x > 0)
8037  >>> g.add(x < 10)
8038  >>> p(g)
8039  1.0
8040  """
8041  return Probe(Z3_probe_eq(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8042 

Referenced by 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 8017 of file z3py.py.

8017  def __ge__(self, other):
8018  """Return a probe that evaluates to "true" when the value returned by `self` is greater than or equal to the value returned by `other`.
8019 
8020  >>> p = Probe('size') >= 2
8021  >>> x = Int('x')
8022  >>> g = Goal()
8023  >>> g.add(x > 0)
8024  >>> g.add(x < 10)
8025  >>> p(g)
8026  1.0
8027  """
8028  return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8029 

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

7991  def __gt__(self, other):
7992  """Return a probe that evaluates to "true" when the value returned by `self` is greater than the value returned by `other`.
7993 
7994  >>> p = Probe('size') > 10
7995  >>> x = Int('x')
7996  >>> g = Goal()
7997  >>> g.add(x > 0)
7998  >>> g.add(x < 10)
7999  >>> p(g)
8000  0.0
8001  """
8002  return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8003 

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

8004  def __le__(self, other):
8005  """Return a probe that evaluates to "true" when the value returned by `self` is less than or equal to the value returned by `other`.
8006 
8007  >>> p = Probe('size') <= 2
8008  >>> x = Int('x')
8009  >>> g = Goal()
8010  >>> g.add(x > 0)
8011  >>> g.add(x < 10)
8012  >>> p(g)
8013  1.0
8014  """
8015  return Probe(Z3_probe_le(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8016 

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

7978  def __lt__(self, other):
7979  """Return a probe that evaluates to "true" when the value returned by `self` is less than the value returned by `other`.
7980 
7981  >>> p = Probe('size') < 10
7982  >>> x = Int('x')
7983  >>> g = Goal()
7984  >>> g.add(x > 0)
7985  >>> g.add(x < 10)
7986  >>> p(g)
7987  1.0
7988  """
7989  return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
7990 

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

8043  def __ne__(self, other):
8044  """Return a probe that evaluates to "true" when the value returned by `self` is not equal to the value returned by `other`.
8045 
8046  >>> p = Probe('size') != 2
8047  >>> x = Int('x')
8048  >>> g = Goal()
8049  >>> g.add(x > 0)
8050  >>> g.add(x < 10)
8051  >>> p(g)
8052  0.0
8053  """
8054  p = self.__eq__(other)
8055  return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8056 

Field Documentation

◆ ctx

ctx

◆ probe

probe
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.
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...
Z3_probe_const
Z3_probe Z3_API Z3_probe_const(Z3_context x, double val)
Return a probe that always evaluates to val.
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.
z3py.z3_debug
def z3_debug()
Definition: z3py.py:56
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...
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 ...
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....
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...
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_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.
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...