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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
f,
ctx )

Definition at line 6868 of file z3py.py.

6868 def __init__(self, f, ctx):
6869 self.f = f
6870 self.ctx = ctx
6871 if self.f is not None:
6872 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
6873
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 6874 of file z3py.py.

6874 def __del__(self):
6875 if self.f is not None and self.ctx.ref() is not None and Z3_func_interp_dec_ref is not None:
6876 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
6877
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 6956 of file z3py.py.

6956 def __copy__(self):
6957 return self.translate(self.ctx)
6958

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6959 of file z3py.py.

6959 def __deepcopy__(self, memo={}):
6960 return self.translate(self.ctx)
6961

◆ __repr__()

__repr__ ( self)

Definition at line 6979 of file z3py.py.

6979 def __repr__(self):
6980 return obj_to_string(self)
6981
6982

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

6917 def arity(self):
6918 """Return the number of arguments for each entry in the function interpretation `self`.
6919
6920 >>> f = Function('f', IntSort(), IntSort())
6921 >>> s = Solver()
6922 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6923 >>> s.check()
6924 sat
6925 >>> m = s.model()
6926 >>> m[f].arity()
6927 1
6928 """
6929 return int(Z3_func_interp_get_arity(self.ctx.ref(), self.f))
6930
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 6962 of file z3py.py.

6962 def as_list(self):
6963 """Return the function interpretation as a Python list.
6964 >>> f = Function('f', IntSort(), IntSort())
6965 >>> s = Solver()
6966 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6967 >>> s.check()
6968 sat
6969 >>> m = s.model()
6970 >>> m[f]
6971 [2 -> 0, else -> 1]
6972 >>> m[f].as_list()
6973 [[2, 0], 1]
6974 """
6975 r = [self.entry(i).as_list() for i in range(self.num_entries())]
6976 r.append(self.else_value())
6977 return r
6978

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

6878 def else_value(self):
6879 """
6880 Return the `else` value for a function interpretation.
6881 Return None if Z3 did not specify the `else` value for
6882 this object.
6883
6884 >>> f = Function('f', IntSort(), IntSort())
6885 >>> s = Solver()
6886 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6887 >>> s.check()
6888 sat
6889 >>> m = s.model()
6890 >>> m[f]
6891 [2 -> 0, else -> 1]
6892 >>> m[f].else_value()
6893 1
6894 """
6895 r = Z3_func_interp_get_else(self.ctx.ref(), self.f)
6896 if r:
6897 return _to_expr_ref(r, self.ctx)
6898 else:
6899 return None
6900
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 6931 of file z3py.py.

6931 def entry(self, idx):
6932 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6933
6934 >>> f = Function('f', IntSort(), IntSort())
6935 >>> s = Solver()
6936 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6937 >>> s.check()
6938 sat
6939 >>> m = s.model()
6940 >>> m[f]
6941 [2 -> 0, else -> 1]
6942 >>> m[f].num_entries()
6943 1
6944 >>> m[f].entry(0)
6945 [2, 0]
6946 """
6947 if idx >= self.num_entries():
6948 raise IndexError
6949 return FuncEntry(Z3_func_interp_get_entry(self.ctx.ref(), self.f, idx), self.ctx)
6950
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 6901 of file z3py.py.

6901 def num_entries(self):
6902 """Return the number of entries/points in the function interpretation `self`.
6903
6904 >>> f = Function('f', IntSort(), IntSort())
6905 >>> s = Solver()
6906 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6907 >>> s.check()
6908 sat
6909 >>> m = s.model()
6910 >>> m[f]
6911 [2 -> 0, else -> 1]
6912 >>> m[f].num_entries()
6913 1
6914 """
6915 return int(Z3_func_interp_get_num_entries(self.ctx.ref(), self.f))
6916
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 6951 of file z3py.py.

6951 def translate(self, other_ctx):
6952 """Copy model 'self' to context 'other_ctx'.
6953 """
6954 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
6955
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 6869 of file z3py.py.

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

◆ model