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

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  m,
  ctx 
)

Definition at line 5986 of file z3py.py.

5986  def __init__(self, m, ctx):
5987  assert ctx is not None
5988  self.model = m
5989  self.ctx = ctx
5990  Z3_model_inc_ref(self.ctx.ref(), self.model)
5991 

◆ __del__()

def __del__ (   self)

Definition at line 5992 of file z3py.py.

5992  def __del__(self):
5993  if self.ctx.ref() is not None:
5994  Z3_model_dec_ref(self.ctx.ref(), self.model)
5995 

Member Function Documentation

◆ __copy__()

def __copy__ (   self)

Definition at line 6253 of file z3py.py.

6253  def __copy__(self):
6254  return self.translate(self.ctx)
6255 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 6256 of file z3py.py.

6256  def __deepcopy__(self, memo={}):
6257  return self.translate(self.ctx)
6258 

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

6182  def __getitem__(self, idx):
6183  """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.
6184 
6185  The elements can be retrieved using position or the actual declaration.
6186 
6187  >>> f = Function('f', IntSort(), IntSort())
6188  >>> x = Int('x')
6189  >>> s = Solver()
6190  >>> s.add(x > 0, x < 2, f(x) == 0)
6191  >>> s.check()
6192  sat
6193  >>> m = s.model()
6194  >>> len(m)
6195  2
6196  >>> m[0]
6197  x
6198  >>> m[1]
6199  f
6200  >>> m[x]
6201  1
6202  >>> m[f]
6203  [else -> 0]
6204  >>> for d in m: print("%s -> %s" % (d, m[d]))
6205  x -> 1
6206  f -> [else -> 0]
6207  """
6208  if _is_int(idx):
6209  if idx >= len(self):
6210  raise IndexError
6211  num_consts = Z3_model_get_num_consts(self.ctx.ref(), self.model)
6212  if (idx < num_consts):
6213  return FuncDeclRef(Z3_model_get_const_decl(self.ctx.ref(), self.model, idx), self.ctx)
6214  else:
6215  return FuncDeclRef(Z3_model_get_func_decl(self.ctx.ref(), self.model, idx - num_consts), self.ctx)
6216  if isinstance(idx, FuncDeclRef):
6217  return self.get_interp(idx)
6218  if is_const(idx):
6219  return self.get_interp(idx.decl())
6220  if isinstance(idx, SortRef):
6221  return self.get_universe(idx)
6222  if z3_debug():
6223  _z3_assert(False, "Integer, Z3 declaration, or Z3 constant expected")
6224  return None
6225 

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

6058  def __len__(self):
6059  """Return the number of constant and function declarations in the model `self`.
6060 
6061  >>> f = Function('f', IntSort(), IntSort())
6062  >>> x = Int('x')
6063  >>> s = Solver()
6064  >>> s.add(x > 0, f(x) != x)
6065  >>> s.check()
6066  sat
6067  >>> m = s.model()
6068  >>> len(m)
6069  2
6070  """
6071  return int(Z3_model_get_num_consts(self.ctx.ref(), self.model)) + int(Z3_model_get_num_funcs(self.ctx.ref(), self.model))
6072 

◆ __repr__()

def __repr__ (   self)

Definition at line 5996 of file z3py.py.

5996  def __repr__(self):
5997  return obj_to_string(self)
5998 

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

6226  def decls(self):
6227  """Return a list with all symbols that have an interpretation in the model `self`.
6228  >>> f = Function('f', IntSort(), IntSort())
6229  >>> x = Int('x')
6230  >>> s = Solver()
6231  >>> s.add(x > 0, x < 2, f(x) == 0)
6232  >>> s.check()
6233  sat
6234  >>> m = s.model()
6235  >>> m.decls()
6236  [x, f]
6237  """
6238  r = []
6239  for i in range(Z3_model_get_num_consts(self.ctx.ref(), self.model)):
6240  r.append(FuncDeclRef(Z3_model_get_const_decl(self.ctx.ref(), self.model, i), self.ctx))
6241  for i in range(Z3_model_get_num_funcs(self.ctx.ref(), self.model)):
6242  r.append(FuncDeclRef(Z3_model_get_func_decl(self.ctx.ref(), self.model, i), self.ctx))
6243  return r
6244 

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

6003  def eval(self, t, model_completion=False):
6004  """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`.
6005 
6006  >>> x = Int('x')
6007  >>> s = Solver()
6008  >>> s.add(x > 0, x < 2)
6009  >>> s.check()
6010  sat
6011  >>> m = s.model()
6012  >>> m.eval(x + 1)
6013  2
6014  >>> m.eval(x == 1)
6015  True
6016  >>> y = Int('y')
6017  >>> m.eval(y + x)
6018  1 + y
6019  >>> m.eval(y)
6020  y
6021  >>> m.eval(y, model_completion=True)
6022  0
6023  >>> # Now, m contains an interpretation for y
6024  >>> m.eval(y + x)
6025  1
6026  """
6027  r = (Ast * 1)()
6028  if Z3_model_eval(self.ctx.ref(), self.model, t.as_ast(), model_completion, r):
6029  return _to_expr_ref(r[0], self.ctx)
6030  raise Z3Exception("failed to evaluate expression in the model")
6031 

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

6032  def evaluate(self, t, model_completion=False):
6033  """Alias for `eval`.
6034 
6035  >>> x = Int('x')
6036  >>> s = Solver()
6037  >>> s.add(x > 0, x < 2)
6038  >>> s.check()
6039  sat
6040  >>> m = s.model()
6041  >>> m.evaluate(x + 1)
6042  2
6043  >>> m.evaluate(x == 1)
6044  True
6045  >>> y = Int('y')
6046  >>> m.evaluate(y + x)
6047  1 + y
6048  >>> m.evaluate(y)
6049  y
6050  >>> m.evaluate(y, model_completion=True)
6051  0
6052  >>> # Now, m contains an interpretation for y
6053  >>> m.evaluate(y + x)
6054  1
6055  """
6056  return self.eval(t, model_completion)
6057 

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

6073  def get_interp(self, decl):
6074  """Return the interpretation for a given declaration or constant.
6075 
6076  >>> f = Function('f', IntSort(), IntSort())
6077  >>> x = Int('x')
6078  >>> s = Solver()
6079  >>> s.add(x > 0, x < 2, f(x) == 0)
6080  >>> s.check()
6081  sat
6082  >>> m = s.model()
6083  >>> m[x]
6084  1
6085  >>> m[f]
6086  [else -> 0]
6087  """
6088  if z3_debug():
6089  _z3_assert(isinstance(decl, FuncDeclRef) or is_const(decl), "Z3 declaration expected")
6090  if is_const(decl):
6091  decl = decl.decl()
6092  try:
6093  if decl.arity() == 0:
6094  _r = Z3_model_get_const_interp(self.ctx.ref(), self.model, decl.ast)
6095  if _r.value is None:
6096  return None
6097  r = _to_expr_ref(_r, self.ctx)
6098  if is_as_array(r):
6099  return self.get_interp(get_as_array_func(r))
6100  else:
6101  return r
6102  else:
6103  return FuncInterp(Z3_model_get_func_interp(self.ctx.ref(), self.model, decl.ast), self.ctx)
6104  except Z3Exception:
6105  return None
6106 

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

6122  def get_sort(self, idx):
6123  """Return the uninterpreted sort at position `idx` < self.num_sorts().
6124 
6125  >>> A = DeclareSort('A')
6126  >>> B = DeclareSort('B')
6127  >>> a1, a2 = Consts('a1 a2', A)
6128  >>> b1, b2 = Consts('b1 b2', B)
6129  >>> s = Solver()
6130  >>> s.add(a1 != a2, b1 != b2)
6131  >>> s.check()
6132  sat
6133  >>> m = s.model()
6134  >>> m.num_sorts()
6135  2
6136  >>> m.get_sort(0)
6137  A
6138  >>> m.get_sort(1)
6139  B
6140  """
6141  if idx >= self.num_sorts():
6142  raise IndexError
6143  return _to_sort_ref(Z3_model_get_sort(self.ctx.ref(), self.model, idx), self.ctx)
6144 

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

6162  def get_universe(self, s):
6163  """Return the interpretation for the uninterpreted sort `s` in the model `self`.
6164 
6165  >>> A = DeclareSort('A')
6166  >>> a, b = Consts('a b', A)
6167  >>> s = Solver()
6168  >>> s.add(a != b)
6169  >>> s.check()
6170  sat
6171  >>> m = s.model()
6172  >>> m.get_universe(A)
6173  [A!val!0, A!val!1]
6174  """
6175  if z3_debug():
6176  _z3_assert(isinstance(s, SortRef), "Z3 sort expected")
6177  try:
6178  return AstVector(Z3_model_get_sort_universe(self.ctx.ref(), self.model, s.ast), self.ctx)
6179  except Z3Exception:
6180  return None
6181 

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

6107  def num_sorts(self):
6108  """Return the number of uninterpreted sorts that contain an interpretation in the model `self`.
6109 
6110  >>> A = DeclareSort('A')
6111  >>> a, b = Consts('a b', A)
6112  >>> s = Solver()
6113  >>> s.add(a != b)
6114  >>> s.check()
6115  sat
6116  >>> m = s.model()
6117  >>> m.num_sorts()
6118  1
6119  """
6120  return int(Z3_model_get_num_sorts(self.ctx.ref(), self.model))
6121 

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

5999  def sexpr(self):
6000  """Return a textual representation of the s-expression representing the model."""
6001  return Z3_model_to_string(self.ctx.ref(), self.model)
6002 

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

6145  def sorts(self):
6146  """Return all uninterpreted sorts that have an interpretation in the model `self`.
6147 
6148  >>> A = DeclareSort('A')
6149  >>> B = DeclareSort('B')
6150  >>> a1, a2 = Consts('a1 a2', A)
6151  >>> b1, b2 = Consts('b1 b2', B)
6152  >>> s = Solver()
6153  >>> s.add(a1 != a2, b1 != b2)
6154  >>> s.check()
6155  sat
6156  >>> m = s.model()
6157  >>> m.sorts()
6158  [A, B]
6159  """
6160  return [ self.get_sort(i) for i in range(self.num_sorts()) ]
6161 

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

6245  def translate(self, target):
6246  """Translate `self` to the context `target`. That is, return a copy of `self` in the context `target`.
6247  """
6248  if z3_debug():
6249  _z3_assert(isinstance(target, Context), "argument must be a Z3 context")
6250  model = Z3_model_translate(self.ctx.ref(), self.model, target.ref())
6251  return Model(model, target)
6252 

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

Field Documentation

◆ ctx

ctx

Definition at line 5989 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(), Solver.consequences(), 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.
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:3488
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.get_as_array_func
def get_as_array_func(n)
Definition: z3py.py:6267
z3py.is_const
def is_const(a)
Definition: z3py.py:1182
z3py.Model
def Model(ctx=None)
Definition: z3py.py:6259
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:6263
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.