Z3
Public Member Functions | Data Fields
ModelRef Class Reference
+ Inheritance diagram for ModelRef:

Public Member Functions

def __init__ (self, m, ctx)
 
def __del__ (self)
 
def __repr__ (self)
 
def sexpr (self)
 
def eval (self, t, model_completion=False)
 
def evaluate (self, t, model_completion=False)
 
def __len__ (self)
 
def get_interp (self, decl)
 
def num_sorts (self)
 
def get_sort (self, idx)
 
def sorts (self)
 
def get_universe (self, s)
 
def __getitem__ (self, idx)
 
def decls (self)
 
def translate (self, target)
 
def __copy__ (self)
 
def __deepcopy__ (self, memo={})
 
- Public Member Functions inherited from Z3PPObject
def use_pp (self)
 

Data Fields

 model
 
 ctx
 

Detailed Description

Model/Solution of a satisfiability problem (aka system of constraints).

Definition at line 6001 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  m,
  ctx 
)

Definition at line 6004 of file z3py.py.

6004  def __init__(self, m, ctx):
6005  assert ctx is not None
6006  self.model = m
6007  self.ctx = ctx
6008  Z3_model_inc_ref(self.ctx.ref(), self.model)
6009 

◆ __del__()

def __del__ (   self)

Definition at line 6010 of file z3py.py.

6010  def __del__(self):
6011  if self.ctx.ref() is not None:
6012  Z3_model_dec_ref(self.ctx.ref(), self.model)
6013 

Member Function Documentation

◆ __copy__()

def __copy__ (   self)

Definition at line 6271 of file z3py.py.

6271  def __copy__(self):
6272  return self.translate(self.ctx)
6273 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 6274 of file z3py.py.

6274  def __deepcopy__(self, memo={}):
6275  return self.translate(self.ctx)
6276 

◆ __getitem__()

def __getitem__ (   self,
  idx 
)
If `idx` is an integer, then the declaration at position `idx` in the model `self` is returned. If `idx` is a declaration, then the actual interpretation is returned.

The elements can be retrieved using position or the actual declaration.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> s = Solver()
>>> s.add(x > 0, x < 2, f(x) == 0)
>>> s.check()
sat
>>> m = s.model()
>>> len(m)
2
>>> m[0]
x
>>> m[1]
f
>>> m[x]
1
>>> m[f]
[else -> 0]
>>> for d in m: print("%s -> %s" % (d, m[d]))
x -> 1
f -> [else -> 0]

Definition at line 6200 of file z3py.py.

6200  def __getitem__(self, idx):
6201  """If `idx` is an integer, then the declaration at position `idx` in the model `self` is returned. If `idx` is a declaration, then the actual interpretation is returned.
6202 
6203  The elements can be retrieved using position or the actual declaration.
6204 
6205  >>> f = Function('f', IntSort(), IntSort())
6206  >>> x = Int('x')
6207  >>> s = Solver()
6208  >>> s.add(x > 0, x < 2, f(x) == 0)
6209  >>> s.check()
6210  sat
6211  >>> m = s.model()
6212  >>> len(m)
6213  2
6214  >>> m[0]
6215  x
6216  >>> m[1]
6217  f
6218  >>> m[x]
6219  1
6220  >>> m[f]
6221  [else -> 0]
6222  >>> for d in m: print("%s -> %s" % (d, m[d]))
6223  x -> 1
6224  f -> [else -> 0]
6225  """
6226  if _is_int(idx):
6227  if idx >= len(self):
6228  raise IndexError
6229  num_consts = Z3_model_get_num_consts(self.ctx.ref(), self.model)
6230  if (idx < num_consts):
6231  return FuncDeclRef(Z3_model_get_const_decl(self.ctx.ref(), self.model, idx), self.ctx)
6232  else:
6233  return FuncDeclRef(Z3_model_get_func_decl(self.ctx.ref(), self.model, idx - num_consts), self.ctx)
6234  if isinstance(idx, FuncDeclRef):
6235  return self.get_interp(idx)
6236  if is_const(idx):
6237  return self.get_interp(idx.decl())
6238  if isinstance(idx, SortRef):
6239  return self.get_universe(idx)
6240  if z3_debug():
6241  _z3_assert(False, "Integer, Z3 declaration, or Z3 constant expected")
6242  return None
6243 

◆ __len__()

def __len__ (   self)
Return the number of constant and function declarations in the model `self`.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> s = Solver()
>>> s.add(x > 0, f(x) != x)
>>> s.check()
sat
>>> m = s.model()
>>> len(m)
2

Definition at line 6076 of file z3py.py.

6076  def __len__(self):
6077  """Return the number of constant and function declarations in the model `self`.
6078 
6079  >>> f = Function('f', IntSort(), IntSort())
6080  >>> x = Int('x')
6081  >>> s = Solver()
6082  >>> s.add(x > 0, f(x) != x)
6083  >>> s.check()
6084  sat
6085  >>> m = s.model()
6086  >>> len(m)
6087  2
6088  """
6089  return int(Z3_model_get_num_consts(self.ctx.ref(), self.model)) + int(Z3_model_get_num_funcs(self.ctx.ref(), self.model))
6090 

◆ __repr__()

def __repr__ (   self)

Definition at line 6014 of file z3py.py.

6014  def __repr__(self):
6015  return obj_to_string(self)
6016 

◆ decls()

def decls (   self)
Return a list with all symbols that have an interpretation in the model `self`.
>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> s = Solver()
>>> s.add(x > 0, x < 2, f(x) == 0)
>>> s.check()
sat
>>> m = s.model()
>>> m.decls()
[x, f]

Definition at line 6244 of file z3py.py.

6244  def decls(self):
6245  """Return a list with all symbols that have an interpretation in the model `self`.
6246  >>> f = Function('f', IntSort(), IntSort())
6247  >>> x = Int('x')
6248  >>> s = Solver()
6249  >>> s.add(x > 0, x < 2, f(x) == 0)
6250  >>> s.check()
6251  sat
6252  >>> m = s.model()
6253  >>> m.decls()
6254  [x, f]
6255  """
6256  r = []
6257  for i in range(Z3_model_get_num_consts(self.ctx.ref(), self.model)):
6258  r.append(FuncDeclRef(Z3_model_get_const_decl(self.ctx.ref(), self.model, i), self.ctx))
6259  for i in range(Z3_model_get_num_funcs(self.ctx.ref(), self.model)):
6260  r.append(FuncDeclRef(Z3_model_get_func_decl(self.ctx.ref(), self.model, i), self.ctx))
6261  return r
6262 

◆ eval()

def eval (   self,
  t,
  model_completion = False 
)
Evaluate the expression `t` in the model `self`. If `model_completion` is enabled, then a default interpretation is automatically added for symbols that do not have an interpretation in the model `self`.

>>> x = Int('x')
>>> s = Solver()
>>> s.add(x > 0, x < 2)
>>> s.check()
sat
>>> m = s.model()
>>> m.eval(x + 1)
2
>>> m.eval(x == 1)
True
>>> y = Int('y')
>>> m.eval(y + x)
1 + y
>>> m.eval(y)
y
>>> m.eval(y, model_completion=True)
0
>>> # Now, m contains an interpretation for y
>>> m.eval(y + x)
1

Definition at line 6021 of file z3py.py.

6021  def eval(self, t, model_completion=False):
6022  """Evaluate the expression `t` in the model `self`. If `model_completion` is enabled, then a default interpretation is automatically added for symbols that do not have an interpretation in the model `self`.
6023 
6024  >>> x = Int('x')
6025  >>> s = Solver()
6026  >>> s.add(x > 0, x < 2)
6027  >>> s.check()
6028  sat
6029  >>> m = s.model()
6030  >>> m.eval(x + 1)
6031  2
6032  >>> m.eval(x == 1)
6033  True
6034  >>> y = Int('y')
6035  >>> m.eval(y + x)
6036  1 + y
6037  >>> m.eval(y)
6038  y
6039  >>> m.eval(y, model_completion=True)
6040  0
6041  >>> # Now, m contains an interpretation for y
6042  >>> m.eval(y + x)
6043  1
6044  """
6045  r = (Ast * 1)()
6046  if Z3_model_eval(self.ctx.ref(), self.model, t.as_ast(), model_completion, r):
6047  return _to_expr_ref(r[0], self.ctx)
6048  raise Z3Exception("failed to evaluate expression in the model")
6049 

Referenced by ModelRef.evaluate().

◆ evaluate()

def evaluate (   self,
  t,
  model_completion = False 
)
Alias for `eval`.

>>> x = Int('x')
>>> s = Solver()
>>> s.add(x > 0, x < 2)
>>> s.check()
sat
>>> m = s.model()
>>> m.evaluate(x + 1)
2
>>> m.evaluate(x == 1)
True
>>> y = Int('y')
>>> m.evaluate(y + x)
1 + y
>>> m.evaluate(y)
y
>>> m.evaluate(y, model_completion=True)
0
>>> # Now, m contains an interpretation for y
>>> m.evaluate(y + x)
1

Definition at line 6050 of file z3py.py.

6050  def evaluate(self, t, model_completion=False):
6051  """Alias for `eval`.
6052 
6053  >>> x = Int('x')
6054  >>> s = Solver()
6055  >>> s.add(x > 0, x < 2)
6056  >>> s.check()
6057  sat
6058  >>> m = s.model()
6059  >>> m.evaluate(x + 1)
6060  2
6061  >>> m.evaluate(x == 1)
6062  True
6063  >>> y = Int('y')
6064  >>> m.evaluate(y + x)
6065  1 + y
6066  >>> m.evaluate(y)
6067  y
6068  >>> m.evaluate(y, model_completion=True)
6069  0
6070  >>> # Now, m contains an interpretation for y
6071  >>> m.evaluate(y + x)
6072  1
6073  """
6074  return self.eval(t, model_completion)
6075 

◆ get_interp()

def get_interp (   self,
  decl 
)
Return the interpretation for a given declaration or constant.

>>> f = Function('f', IntSort(), IntSort())
>>> x = Int('x')
>>> s = Solver()
>>> s.add(x > 0, x < 2, f(x) == 0)
>>> s.check()
sat
>>> m = s.model()
>>> m[x]
1
>>> m[f]
[else -> 0]

Definition at line 6091 of file z3py.py.

6091  def get_interp(self, decl):
6092  """Return the interpretation for a given declaration or constant.
6093 
6094  >>> f = Function('f', IntSort(), IntSort())
6095  >>> x = Int('x')
6096  >>> s = Solver()
6097  >>> s.add(x > 0, x < 2, f(x) == 0)
6098  >>> s.check()
6099  sat
6100  >>> m = s.model()
6101  >>> m[x]
6102  1
6103  >>> m[f]
6104  [else -> 0]
6105  """
6106  if z3_debug():
6107  _z3_assert(isinstance(decl, FuncDeclRef) or is_const(decl), "Z3 declaration expected")
6108  if is_const(decl):
6109  decl = decl.decl()
6110  try:
6111  if decl.arity() == 0:
6112  _r = Z3_model_get_const_interp(self.ctx.ref(), self.model, decl.ast)
6113  if _r.value is None:
6114  return None
6115  r = _to_expr_ref(_r, self.ctx)
6116  if is_as_array(r):
6117  return self.get_interp(get_as_array_func(r))
6118  else:
6119  return r
6120  else:
6121  return FuncInterp(Z3_model_get_func_interp(self.ctx.ref(), self.model, decl.ast), self.ctx)
6122  except Z3Exception:
6123  return None
6124 

Referenced by ModelRef.__getitem__(), and ModelRef.get_interp().

◆ get_sort()

def get_sort (   self,
  idx 
)
Return the uninterpreted sort at position `idx` < self.num_sorts().

>>> A = DeclareSort('A')
>>> B = DeclareSort('B')
>>> a1, a2 = Consts('a1 a2', A)
>>> b1, b2 = Consts('b1 b2', B)
>>> s = Solver()
>>> s.add(a1 != a2, b1 != b2)
>>> s.check()
sat
>>> m = s.model()
>>> m.num_sorts()
2
>>> m.get_sort(0)
A
>>> m.get_sort(1)
B

Definition at line 6140 of file z3py.py.

6140  def get_sort(self, idx):
6141  """Return the uninterpreted sort at position `idx` < self.num_sorts().
6142 
6143  >>> A = DeclareSort('A')
6144  >>> B = DeclareSort('B')
6145  >>> a1, a2 = Consts('a1 a2', A)
6146  >>> b1, b2 = Consts('b1 b2', B)
6147  >>> s = Solver()
6148  >>> s.add(a1 != a2, b1 != b2)
6149  >>> s.check()
6150  sat
6151  >>> m = s.model()
6152  >>> m.num_sorts()
6153  2
6154  >>> m.get_sort(0)
6155  A
6156  >>> m.get_sort(1)
6157  B
6158  """
6159  if idx >= self.num_sorts():
6160  raise IndexError
6161  return _to_sort_ref(Z3_model_get_sort(self.ctx.ref(), self.model, idx), self.ctx)
6162 

Referenced by ModelRef.sorts().

◆ get_universe()

def get_universe (   self,
  s 
)
Return the interpretation for the uninterpreted sort `s` in the model `self`.

>>> A = DeclareSort('A')
>>> a, b = Consts('a b', A)
>>> s = Solver()
>>> s.add(a != b)
>>> s.check()
sat
>>> m = s.model()
>>> m.get_universe(A)
[A!val!0, A!val!1]

Definition at line 6180 of file z3py.py.

6180  def get_universe(self, s):
6181  """Return the interpretation for the uninterpreted sort `s` in the model `self`.
6182 
6183  >>> A = DeclareSort('A')
6184  >>> a, b = Consts('a b', A)
6185  >>> s = Solver()
6186  >>> s.add(a != b)
6187  >>> s.check()
6188  sat
6189  >>> m = s.model()
6190  >>> m.get_universe(A)
6191  [A!val!0, A!val!1]
6192  """
6193  if z3_debug():
6194  _z3_assert(isinstance(s, SortRef), "Z3 sort expected")
6195  try:
6196  return AstVector(Z3_model_get_sort_universe(self.ctx.ref(), self.model, s.ast), self.ctx)
6197  except Z3Exception:
6198  return None
6199 

Referenced by ModelRef.__getitem__().

◆ num_sorts()

def num_sorts (   self)
Return the number of uninterpreted sorts that contain an interpretation in the model `self`.

>>> A = DeclareSort('A')
>>> a, b = Consts('a b', A)
>>> s = Solver()
>>> s.add(a != b)
>>> s.check()
sat
>>> m = s.model()
>>> m.num_sorts()
1

Definition at line 6125 of file z3py.py.

6125  def num_sorts(self):
6126  """Return the number of uninterpreted sorts that contain an interpretation in the model `self`.
6127 
6128  >>> A = DeclareSort('A')
6129  >>> a, b = Consts('a b', A)
6130  >>> s = Solver()
6131  >>> s.add(a != b)
6132  >>> s.check()
6133  sat
6134  >>> m = s.model()
6135  >>> m.num_sorts()
6136  1
6137  """
6138  return int(Z3_model_get_num_sorts(self.ctx.ref(), self.model))
6139 

Referenced by ModelRef.get_sort(), and ModelRef.sorts().

◆ sexpr()

def sexpr (   self)
Return a textual representation of the s-expression representing the model.

Definition at line 6017 of file z3py.py.

6017  def sexpr(self):
6018  """Return a textual representation of the s-expression representing the model."""
6019  return Z3_model_to_string(self.ctx.ref(), self.model)
6020 

Referenced by Fixedpoint.__repr__(), and Optimize.__repr__().

◆ sorts()

def sorts (   self)
Return all uninterpreted sorts that have an interpretation in the model `self`.

>>> A = DeclareSort('A')
>>> B = DeclareSort('B')
>>> a1, a2 = Consts('a1 a2', A)
>>> b1, b2 = Consts('b1 b2', B)
>>> s = Solver()
>>> s.add(a1 != a2, b1 != b2)
>>> s.check()
sat
>>> m = s.model()
>>> m.sorts()
[A, B]

Definition at line 6163 of file z3py.py.

6163  def sorts(self):
6164  """Return all uninterpreted sorts that have an interpretation in the model `self`.
6165 
6166  >>> A = DeclareSort('A')
6167  >>> B = DeclareSort('B')
6168  >>> a1, a2 = Consts('a1 a2', A)
6169  >>> b1, b2 = Consts('b1 b2', B)
6170  >>> s = Solver()
6171  >>> s.add(a1 != a2, b1 != b2)
6172  >>> s.check()
6173  sat
6174  >>> m = s.model()
6175  >>> m.sorts()
6176  [A, B]
6177  """
6178  return [ self.get_sort(i) for i in range(self.num_sorts()) ]
6179 

◆ translate()

def translate (   self,
  target 
)
Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.

Definition at line 6263 of file z3py.py.

6263  def translate(self, target):
6264  """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
6265  """
6266  if z3_debug():
6267  _z3_assert(isinstance(target, Context), "argument must be a Z3 context")
6268  model = Z3_model_translate(self.ctx.ref(), self.model, target.ref())
6269  return ModelRef(model, target)
6270 

Referenced by ModelRef.__copy__(), Solver.__copy__(), ModelRef.__deepcopy__(), and Solver.__deepcopy__().

Field Documentation

◆ ctx

ctx

Definition at line 6007 of file z3py.py.

Referenced by Probe.__call__(), ModelRef.__copy__(), Solver.__copy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Solver.__deepcopy__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), ModelRef.__del__(), Statistics.__del__(), Solver.__del__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), Probe.__eq__(), Probe.__ge__(), ModelRef.__getitem__(), Statistics.__getitem__(), ApplyResult.__getitem__(), Probe.__gt__(), Probe.__le__(), ModelRef.__len__(), Statistics.__len__(), ApplyResult.__len__(), Probe.__lt__(), Probe.__ne__(), Statistics.__repr__(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), ApplyResult.as_expr(), Solver.assert_and_track(), Optimize.assert_and_track(), Solver.assert_exprs(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Solver.assertions(), Optimize.assertions(), Solver.check(), Optimize.check(), UserPropagateBase.conflict(), Solver.consequences(), UserPropagateBase.ctx_ref(), ModelRef.decls(), Solver.dimacs(), ModelRef.eval(), Solver.from_file(), Optimize.from_file(), Solver.from_string(), Optimize.from_string(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), Fixedpoint.get_ground_sat_answer(), ModelRef.get_interp(), Statistics.get_key_value(), 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(), Statistics.keys(), Optimize.maximize(), Optimize.minimize(), Solver.model(), Optimize.model(), Solver.non_units(), Solver.num_scopes(), ModelRef.num_sorts(), Optimize.objectives(), Solver.param_descrs(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), Solver.pop(), Optimize.pop(), Solver.proof(), Solver.push(), Optimize.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), Solver.reason_unknown(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), Fixedpoint.register_relation(), Solver.reset(), Solver.set(), Fixedpoint.set(), Optimize.set(), Fixedpoint.set_predicate_representation(), ModelRef.sexpr(), Solver.sexpr(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), Tactic.solver(), Solver.statistics(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Solver.trail(), Solver.trail_levels(), ModelRef.translate(), Solver.translate(), Solver.units(), Solver.unsat_core(), Optimize.unsat_core(), and Fixedpoint.update_rule().

◆ model

model
Z3_model_get_func_interp
Z3_func_interp Z3_API Z3_model_get_func_interp(Z3_context c, Z3_model m, Z3_func_decl f)
Return the interpretation of the function f in the model m. Return NULL, if the model does not assign...
Z3_model_eval
Z3_bool Z3_API Z3_model_eval(Z3_context c, Z3_model m, Z3_ast t, bool model_completion, Z3_ast *v)
Evaluate the AST node t in the given model. Return true if succeeded, and store the result in v.
Z3_model_dec_ref
void Z3_API Z3_model_dec_ref(Z3_context c, Z3_model m)
Decrement the reference counter of the given model.
Z3_model_translate
Z3_model Z3_API Z3_model_translate(Z3_context c, Z3_model m, Z3_context dst)
translate model from context c to context dst.
z3py.UserPropagateBase.__init__
def __init__(self, s, ctx=None)
Definition: z3py.py:10582
Z3_model_get_sort
Z3_sort Z3_API Z3_model_get_sort(Z3_context c, Z3_model m, unsigned i)
Return a uninterpreted sort that m assigns an interpretation.
z3::range
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:3515
Z3_model_get_const_decl
Z3_func_decl Z3_API Z3_model_get_const_decl(Z3_context c, Z3_model m, unsigned i)
Return the i-th constant in the given model.
z3py.UserPropagateBase.__del__
def __del__(self)
Definition: z3py.py:10607
z3py.get_as_array_func
def get_as_array_func(n)
Definition: z3py.py:6285
z3py.is_const
def is_const(a)
Definition: z3py.py:1182
Z3_model_get_const_interp
Z3_ast Z3_API Z3_model_get_const_interp(Z3_context c, Z3_model m, Z3_func_decl a)
Return the interpretation (i.e., assignment) of constant a in the model m. Return NULL,...
z3py.z3_debug
def z3_debug()
Definition: z3py.py:56
Z3_model_get_num_funcs
unsigned Z3_API Z3_model_get_num_funcs(Z3_context c, Z3_model m)
Return the number of function interpretations in the given model.
z3py.is_as_array
def is_as_array(n)
Definition: z3py.py:6281
Z3_model_get_sort_universe
Z3_ast_vector Z3_API Z3_model_get_sort_universe(Z3_context c, Z3_model m, Z3_sort s)
Return the finite set of distinct values that represent the interpretation for sort s.
Z3_model_inc_ref
void Z3_API Z3_model_inc_ref(Z3_context c, Z3_model m)
Increment the reference counter of the given model.
Z3_model_to_string
Z3_string Z3_API Z3_model_to_string(Z3_context c, Z3_model m)
Convert the given model into a string.
Z3_model_get_num_sorts
unsigned Z3_API Z3_model_get_num_sorts(Z3_context c, Z3_model m)
Return the number of uninterpreted sorts that m assigns an interpretation to.
Z3_model_get_func_decl
Z3_func_decl Z3_API Z3_model_get_func_decl(Z3_context c, Z3_model m, unsigned i)
Return the declaration of the i-th function in the given model.
Z3_model_get_num_consts
unsigned Z3_API Z3_model_get_num_consts(Z3_context c, Z3_model m)
Return the number of constants assigned by the given model.