Z3
Loading...
Searching...
No Matches
FuncInterp Class Reference
Inheritance diagram for FuncInterp:

Public Member Functions

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

Data Fields

 f = f
 ctx = ctx
 model

Additional Inherited Members

Protected Member Functions inherited from Z3PPObject
 _repr_html_ (self)

Detailed Description

Stores the interpretation of a function in a Z3 model.

Definition at line 7004 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
f,
ctx )

Definition at line 7007 of file z3py.py.

7007 def __init__(self, f, ctx):
7008 self.f = f
7009 self.ctx = ctx
7010 if self.f is not None:
7011 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
7012
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__()

__del__ ( self)

Definition at line 7013 of file z3py.py.

7013 def __del__(self):
7014 if self.f is not None and self.ctx.ref() is not None and Z3_func_interp_dec_ref is not None:
7015 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
7016
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__()

__copy__ ( self)

Definition at line 7095 of file z3py.py.

7095 def __copy__(self):
7096 return self.translate(self.ctx)
7097

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 7098 of file z3py.py.

7098 def __deepcopy__(self, memo={}):
7099 return self.translate(self.ctx)
7100

◆ __repr__()

__repr__ ( self)

Definition at line 7118 of file z3py.py.

7118 def __repr__(self):
7119 return obj_to_string(self)
7120
7121

◆ arity()

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

7056 def arity(self):
7057 """Return the number of arguments for each entry in the function interpretation `self`.
7058
7059 >>> f = Function('f', IntSort(), IntSort())
7060 >>> s = Solver()
7061 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
7062 >>> s.check()
7063 sat
7064 >>> m = s.model()
7065 >>> m[f].arity()
7066 1
7067 """
7068 return int(Z3_func_interp_get_arity(self.ctx.ref(), self.f))
7069
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.

◆ as_list()

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

7101 def as_list(self):
7102 """Return the function interpretation as a Python list.
7103 >>> f = Function('f', IntSort(), IntSort())
7104 >>> s = Solver()
7105 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
7106 >>> s.check()
7107 sat
7108 >>> m = s.model()
7109 >>> m[f]
7110 [2 -> 0, else -> 1]
7111 >>> m[f].as_list()
7112 [[2, 0], 1]
7113 """
7114 r = [self.entry(i).as_list() for i in range(self.num_entries())]
7115 r.append(self.else_value())
7116 return r
7117

Referenced by as_list().

◆ else_value()

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

7017 def else_value(self):
7018 """
7019 Return the `else` value for a function interpretation.
7020 Return None if Z3 did not specify the `else` value for
7021 this object.
7022
7023 >>> f = Function('f', IntSort(), IntSort())
7024 >>> s = Solver()
7025 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
7026 >>> s.check()
7027 sat
7028 >>> m = s.model()
7029 >>> m[f]
7030 [2 -> 0, else -> 1]
7031 >>> m[f].else_value()
7032 1
7033 """
7034 r = Z3_func_interp_get_else(self.ctx.ref(), self.f)
7035 if r:
7036 return _to_expr_ref(r, self.ctx)
7037 else:
7038 return None
7039
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 as_list().

◆ entry()

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

7070 def entry(self, idx):
7071 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
7072
7073 >>> f = Function('f', IntSort(), IntSort())
7074 >>> s = Solver()
7075 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
7076 >>> s.check()
7077 sat
7078 >>> m = s.model()
7079 >>> m[f]
7080 [2 -> 0, else -> 1]
7081 >>> m[f].num_entries()
7082 1
7083 >>> m[f].entry(0)
7084 [2, 0]
7085 """
7086 if idx >= self.num_entries():
7087 raise IndexError
7088 return FuncEntry(Z3_func_interp_get_entry(self.ctx.ref(), self.f, idx), self.ctx)
7089
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 as_list().

◆ num_entries()

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

7040 def num_entries(self):
7041 """Return the number of entries/points in the function interpretation `self`.
7042
7043 >>> f = Function('f', IntSort(), IntSort())
7044 >>> s = Solver()
7045 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
7046 >>> s.check()
7047 sat
7048 >>> m = s.model()
7049 >>> m[f]
7050 [2 -> 0, else -> 1]
7051 >>> m[f].num_entries()
7052 1
7053 """
7054 return int(Z3_func_interp_get_num_entries(self.ctx.ref(), self.f))
7055
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 as_list(), and entry().

◆ translate()

translate ( self,
other_ctx )
Copy model 'self' to context 'other_ctx'.

Definition at line 7090 of file z3py.py.

7090 def translate(self, other_ctx):
7091 """Copy model 'self' to context 'other_ctx'.
7092 """
7093 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
7094
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 __copy__(), ModelRef.__copy__(), __deepcopy__(), and ModelRef.__deepcopy__().

Field Documentation

◆ ctx

◆ f

f = f

Definition at line 7008 of file z3py.py.

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

◆ model