Z3 |

Public Member Functions | Data Fields
FuncInterp Class Reference
Inheritance diagram for FuncInterp:

## Public Member Functions
def | __init__ (self, f, ctx)
def | __del__ (self)
def | else_value (self)
def | num_entries (self)
def | arity (self)
def | entry (self, idx)
def | translate (self, other_ctx)
def | __copy__ (self)
def | __deepcopy__ (self, memo={})
def | as_list (self)
def | __repr__ (self)
Public Member Functions inherited from Z3PPObject
def | use_pp (self)

## Data Fields
| f
| ctx

## Detailed Description

    Stores the interpretation of a function in a Z3 model.

Definition at line 6179 of file z3py.py.

## Constructor & Destructor Documentation

## ◆ __init__()

def __init__ | ( |  | self,
|  |  | f,
|  |  | ctx
| ) |  |

Definition at line 6182 of file z3py.py.

6182 def __init__(self, f, ctx):
6183 self.f = f
6184 self.ctx = ctx
6185 if self.f is not None:
6186 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
6187
Z3_func_interp_inc_ref
void Z3_API Z3_func_interp_inc_ref(Z3_context c, Z3_func_interp f)
Increment the reference counter of the given Z3_func_interp object.

## ◆ __del__()

def __del__ | ( |  | self | ) |

Definition at line 6188 of file z3py.py.

6188 def __del__(self):
6189 if self.f is not None and self.ctx.ref() is not None:
6190 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
6191
Z3_func_interp_dec_ref
void Z3_API Z3_func_interp_dec_ref(Z3_context c, Z3_func_interp f)
Decrement the reference counter of the given Z3_func_interp object.

## Member Function Documentation

## ◆ __copy__()

def __copy__ | ( |  | self | ) |

Definition at line 6270 of file z3py.py.

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

## ◆ __deepcopy__()

def __deepcopy__ | ( |  | self,
|  |  | memo = `{}`
| ) |  |

Definition at line 6273 of file z3py.py.

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

## ◆ __repr__()

def __repr__ | ( |  | self | ) |

Definition at line 6293 of file z3py.py.

6293 def __repr__(self):
6294 return obj_to_string(self)
6295
6296

## ◆ arity()

def arity | ( |  | self | ) |

    Return the number of arguments for each entry in the function interpretation `self`.

    >>> f = Function('f', IntSort(), IntSort())
    >>> s = Solver()
    >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
    >>> s.check()
    sat
    >>> m = s.model()
    >>> m[f].arity()
    1

Definition at line 6231 of file z3py.py.

6231 def arity(self):
6232 """Return the number of arguments for each entry in the function interpretation `self`.
6233
6234 >>> f = Function('f', IntSort(), IntSort())
6235 >>> s = Solver()
6236 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6237 >>> s.check()
6238 sat
6239 >>> m = s.model()
6240 >>> m[f].arity()
6241 1
6242 """
6243 return int(Z3_func_interp_get_arity(self.ctx.ref(), self.f))
6244
z3py.IntSort
def IntSort(ctx=None)
Definition: z3py.py:3100
z3py.Function
def Function(name, *sig)
Definition: z3py.py:860
Z3_func_interp_get_arity
unsigned Z3_API Z3_func_interp_get_arity(Z3_context c, Z3_func_interp f)
Return the arity (number of arguments) of the given function interpretation.

Referenced by FuncDeclRef.__call__(), FuncDeclRef.arity(), FuncInterp.arity(), and FuncDeclRef.domain().

## ◆ as_list()

def as_list | ( |  | self | ) |

    Return the function interpretation as a Python list.
    >>> f = Function('f', IntSort(), IntSort())
    >>> s = Solver()
    >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
    >>> s.check()
    sat
    >>> m = s.model()
    >>> m[f]
    [2 -> 0, else -> 1]
    >>> m[f].as_list()
    [[2, 0], 1]

Definition at line 6276 of file z3py.py.

6276 def as_list(self):
6277 """Return the function interpretation as a Python list.
6278 >>> f = Function('f', IntSort(), IntSort())
6279 >>> s = Solver()
6280 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6281 >>> s.check()
6282 sat
6283 >>> m = s.model()
6284 >>> m[f]
6285 [2 -> 0, else -> 1]
6286 >>> m[f].as_list()
6287 [[2, 0], 1]
6288 """
6289 r = [self.entry(i).as_list() for i in range(self.num_entries())]
6290 r.append(self.else_value())
6291 return r
6292
z3::range
expr range(expr const &lo, expr const &hi)
Definition: z3++.h:3725

Referenced by FuncEntry.__repr__(), and FuncInterp.as_list().

## ◆ else_value()

def else_value | ( |  | self | ) |

    Return the `else` value for a function interpretation.
    Return None if Z3 did not specify the `else` value for
    this object.

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

Definition at line 6192 of file z3py.py.

6192 def else_value(self):
6193 """
6194 Return the `else` value for a function interpretation.
6195 Return None if Z3 did not specify the `else` value for
6196 this object.
6197
6198 >>> f = Function('f', IntSort(), IntSort())
6199 >>> s = Solver()
6200 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6201 >>> s.check()
6202 sat
6203 >>> m = s.model()
6204 >>> m[f]
6205 [2 -> 0, else -> 1]
6206 >>> m[f].else_value()
6207 1
6208 """
6209 r = Z3_func_interp_get_else(self.ctx.ref(), self.f)
6210 if r:
6211 return _to_expr_ref(r, self.ctx)
6212 else:
6213 return None
6214
Z3_func_interp_get_else
Z3_ast Z3_API Z3_func_interp_get_else(Z3_context c, Z3_func_interp f)
Return the 'else' value of the given function interpretation.

Referenced by FuncInterp.as_list(), and FuncInterp.else_value().

## ◆ entry()

def entry | ( |  | self,
|  |  | idx
| ) |  |

    Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.

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

Definition at line 6245 of file z3py.py.

6245 def entry(self, idx):
6246 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6247
6248 >>> f = Function('f', IntSort(), IntSort())
6249 >>> s = Solver()
6250 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6251 >>> s.check()
6252 sat
6253 >>> m = s.model()
6254 >>> m[f]
6255 [2 -> 0, else -> 1]
6256 >>> m[f].num_entries()
6257 1
6258 >>> m[f].entry(0)
6259 [2, 0]
6260 """
6261 if idx >= self.num_entries():
6262 raise IndexError
6263 return FuncEntry(Z3_func_interp_get_entry(self.ctx.ref(), self.f, idx), self.ctx)
6264
Z3_func_interp_get_entry
Z3_func_entry Z3_API Z3_func_interp_get_entry(Z3_context c, Z3_func_interp f, unsigned i)
Return a "point" of the given function interpretation. It represents the value of f in a particular p...

Referenced by FuncEntry.__deepcopy__(), FuncEntry.__del__(), FuncEntry.arg_value(), FuncInterp.as_list(), FuncInterp.entry(), FuncEntry.num_args(), and FuncEntry.value().

## ◆ num_entries()

def num_entries | ( |  | self | ) |

    Return the number of entries/points in the function interpretation `self`.

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

Definition at line 6215 of file z3py.py.

6215 def num_entries(self):
6216 """Return the number of entries/points in the function interpretation `self`.
6217
6218 >>> f = Function('f', IntSort(), IntSort())
6219 >>> s = Solver()
6220 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6221 >>> s.check()
6222 sat
6223 >>> m = s.model()
6224 >>> m[f]
6225 [2 -> 0, else -> 1]
6226 >>> m[f].num_entries()
6227 1
6228 """
6229 return int(Z3_func_interp_get_num_entries(self.ctx.ref(), self.f))
6230
Z3_func_interp_get_num_entries
unsigned Z3_API Z3_func_interp_get_num_entries(Z3_context c, Z3_func_interp f)
Return the number of entries in the given function interpretation.

Referenced by FuncInterp.as_list(), FuncInterp.entry(), and FuncInterp.num_entries().

## ◆ translate()

def translate | ( |  | self,
|  |  | other_ctx
| ) |  |

    Copy model 'self' to context 'other_ctx'.

Definition at line 6265 of file z3py.py.

6265 def translate(self, other_ctx):
6266 """Copy model 'self' to context 'other_ctx'.
6267 """
6268 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
6269
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.

Referenced by AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), Solver.__copy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), and Solver.__deepcopy__().

## Field Documentation

## ◆ ctx

ctx

Definition at line 6184 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), FPRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), Probe.__call__(), AstMap.__contains__(), AstRef.__copy__(), Goal.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), Solver.__copy__(), AstRef.__deepcopy__(), Datatype.__deepcopy__(), ParamsRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), Goal.__deepcopy__(), AstVector.__deepcopy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Solver.__deepcopy__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__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__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), ArithRef.__div__(), BitVecRef.__div__(), FPRef.__div__(), ExprRef.__eq__(), Probe.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), Probe.__ge__(), FPRef.__ge__(), SeqRef.__ge__(), QuantifierRef.__getitem__(), ArrayRef.__getitem__(), AstVector.__getitem__(), SeqRef.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ApplyResult.__getitem__(), AstMap.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), Probe.__gt__(), FPRef.__gt__(), SeqRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), Probe.__le__(), FPRef.__le__(), SeqRef.__le__(), AstVector.__len__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), ApplyResult.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), Probe.__lt__(), FPRef.__lt__(), SeqRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), FPRef.__mul__(), ExprRef.__ne__(), Probe.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), FPRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), FPRef.__rdiv__(), ParamsRef.__repr__(), ParamDescrsRef.__repr__(), AstMap.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), FPRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), FPRef.__rsub__(), BitVecRef.__rxor__(), AstVector.__setitem__(), AstMap.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), FPRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), AlgebraicNumRef.approx(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), ApplyResult.as_expr(), FPNumRef.as_string(), Solver.assert_and_track(), Optimize.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Solver.assertions(), Optimize.assertions(), SeqRef.at(), SeqSortRef.basis(), ReSortRef.basis(), QuantifierRef.body(), BoolSortRef.cast(), Solver.check(), Optimize.check(), UserPropagateBase.conflict(), Solver.consequences(), DatatypeSortRef.constructor(), Goal.convert_model(), AstRef.ctx_ref(), UserPropagateBase.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), Solver.dimacs(), ArraySortRef.domain(), FuncDeclRef.domain(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), FPNumRef.exponent(), FPNumRef.exponent_as_bv(), FPNumRef.exponent_as_long(), Solver.from_file(), Optimize.from_file(), Solver.from_string(), Optimize.from_string(), Goal.get(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), ParamDescrsRef.get_documentation(), Fixedpoint.get_ground_sat_answer(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), 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(), Goal.inconsistent(), FPNumRef.isInf(), FPNumRef.isNaN(), FPNumRef.isNegative(), FPNumRef.isNormal(), FPNumRef.isPositive(), FPNumRef.isSubnormal(), FPNumRef.isZero(), AstMap.keys(), Statistics.keys(), SortRef.kind(), Optimize.maximize(), Optimize.minimize(), Solver.model(), Optimize.model(), SortRef.name(), FuncDeclRef.name(), QuantifierRef.no_pattern(), Solver.non_units(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), RatNumRef.numerator(), Optimize.objectives(), Solver.param_descrs(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), FuncDeclRef.params(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Optimize.pop(), Solver.pop(), Goal.prec(), Solver.proof(), Solver.push(), Optimize.push(), AstVector.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), FuncDeclRef.range(), ArraySortRef.range(), Solver.reason_unknown(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), DatatypeSortRef.recognizer(), Context.ref(), Fixedpoint.register_relation(), AstMap.reset(), Solver.reset(), AstVector.resize(), Solver.set(), Fixedpoint.set(), Optimize.set(), ParamsRef.set(), Optimize.set_on_model(), Fixedpoint.set_predicate_representation(), Goal.sexpr(), AstVector.sexpr(), ModelRef.sexpr(), Solver.sexpr(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), FPNumRef.sign(), FPNumRef.sign_as_bv(), FPNumRef.significand(), FPNumRef.significand_as_bv(), FPNumRef.significand_as_long(), ParamDescrsRef.size(), Goal.size(), Tactic.solver(), ExprRef.sort(), BoolRef.sort(), QuantifierRef.sort(), ArithRef.sort(), BitVecRef.sort(), ArrayRef.sort(), DatatypeRef.sort(), FiniteDomainRef.sort(), FPRef.sort(), SeqRef.sort(), Solver.statistics(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Solver.trail(), Solver.trail_levels(), AstVector.translate(), FuncInterp.translate(), AstRef.translate(), Goal.translate(), ModelRef.translate(), Solver.translate(), Solver.units(), Solver.unsat_core(), Optimize.unsat_core(), Fixedpoint.update_rule(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

## ◆ f

f

Definition at line 6183 of file z3py.py.

Referenced by FuncInterp.__del__(), FuncInterp.arity(), FuncInterp.as_list(), FuncInterp.else_value(), FuncInterp.entry(), and FuncInterp.num_entries().