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

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  probe,
  ctx = None 
)

Definition at line 7925 of file z3py.py.

7925  def __init__(self, probe, ctx=None):
7926  self.ctx = _get_ctx(ctx)
7927  self.probe = None
7928  if isinstance(probe, ProbeObj):
7929  self.probe = probe
7930  elif isinstance(probe, float):
7931  self.probe = Z3_probe_const(self.ctx.ref(), probe)
7932  elif _is_int(probe):
7933  self.probe = Z3_probe_const(self.ctx.ref(), float(probe))
7934  elif isinstance(probe, bool):
7935  if probe:
7936  self.probe = Z3_probe_const(self.ctx.ref(), 1.0)
7937  else:
7938  self.probe = Z3_probe_const(self.ctx.ref(), 0.0)
7939  else:
7940  if z3_debug():
7941  _z3_assert(isinstance(probe, str), "probe name expected")
7942  try:
7943  self.probe = Z3_mk_probe(self.ctx.ref(), probe)
7944  except Z3Exception:
7945  raise Z3Exception("unknown probe '%s'" % probe)
7946  Z3_probe_inc_ref(self.ctx.ref(), self.probe)
7947 

◆ __del__()

def __del__ (   self)

Definition at line 7951 of file z3py.py.

7951  def __del__(self):
7952  if self.probe is not None and self.ctx.ref() is not None:
7953  Z3_probe_dec_ref(self.ctx.ref(), self.probe)
7954 

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

8034  def __call__(self, goal):
8035  """Evaluate the probe `self` in the given goal.
8036 
8037  >>> p = Probe('size')
8038  >>> x = Int('x')
8039  >>> g = Goal()
8040  >>> g.add(x > 0)
8041  >>> g.add(x < 10)
8042  >>> p(g)
8043  2.0
8044  >>> g.add(x < 20)
8045  >>> p(g)
8046  3.0
8047  >>> p = Probe('num-consts')
8048  >>> p(g)
8049  1.0
8050  >>> p = Probe('is-propositional')
8051  >>> p(g)
8052  0.0
8053  >>> p = Probe('is-qflia')
8054  >>> p(g)
8055  1.0
8056  """
8057  if z3_debug():
8058  _z3_assert(isinstance(goal, Goal) or isinstance(goal, BoolRef), "Z3 Goal or Boolean expression expected")
8059  goal = _to_goal(goal)
8060  return Z3_probe_apply(self.ctx.ref(), self.probe, goal.goal)
8061 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 7948 of file z3py.py.

7948  def __deepcopy__(self, memo={}):
7949  return Probe(self.probe, self.ctx)
7950 

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

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

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

7994  def __ge__(self, other):
7995  """Return a probe that evaluates to "true" when the value returned by `self` is greater than or equal to the value returned by `other`.
7996 
7997  >>> p = Probe('size') >= 2
7998  >>> x = Int('x')
7999  >>> g = Goal()
8000  >>> g.add(x > 0)
8001  >>> g.add(x < 10)
8002  >>> p(g)
8003  1.0
8004  """
8005  return Probe(Z3_probe_ge(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
8006 

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

7968  def __gt__(self, other):
7969  """Return a probe that evaluates to "true" when the value returned by `self` is greater than the value returned by `other`.
7970 
7971  >>> p = Probe('size') > 10
7972  >>> x = Int('x')
7973  >>> g = Goal()
7974  >>> g.add(x > 0)
7975  >>> g.add(x < 10)
7976  >>> p(g)
7977  0.0
7978  """
7979  return Probe(Z3_probe_gt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
7980 

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

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

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

7955  def __lt__(self, other):
7956  """Return a probe that evaluates to "true" when the value returned by `self` is less than the value returned by `other`.
7957 
7958  >>> p = Probe('size') < 10
7959  >>> x = Int('x')
7960  >>> g = Goal()
7961  >>> g.add(x > 0)
7962  >>> g.add(x < 10)
7963  >>> p(g)
7964  1.0
7965  """
7966  return Probe(Z3_probe_lt(self.ctx.ref(), self.probe, _to_probe(other, self.ctx).probe), self.ctx)
7967 

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

8020  def __ne__(self, other):
8021  """Return a probe that evaluates to "true" when the value returned by `self` is not equal to the value returned by `other`.
8022 
8023  >>> p = Probe('size') != 2
8024  >>> x = Int('x')
8025  >>> g = Goal()
8026  >>> g.add(x > 0)
8027  >>> g.add(x < 10)
8028  >>> p(g)
8029  0.0
8030  """
8031  p = self.__eq__(other)
8032  return Probe(Z3_probe_not(self.ctx.ref(), p.probe), self.ctx)
8033 

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...