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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
f,
ctx )

Definition at line 6371 of file z3py.py.

6371 def __init__(self, f, ctx):
6372 self.f = f
6373 self.ctx = ctx
6374 if self.f is not None:
6375 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
6376
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 6377 of file z3py.py.

6377 def __del__(self):
6378 if self.f is not None and self.ctx.ref() is not None and Z3_func_interp_dec_ref is not None:
6379 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
6380
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 6459 of file z3py.py.

6459 def __copy__(self):
6460 return self.translate(self.ctx)
6461

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6462 of file z3py.py.

6462 def __deepcopy__(self, memo={}):
6463 return self.translate(self.ctx)
6464

◆ __repr__()

__repr__ ( self)

Definition at line 6482 of file z3py.py.

6482 def __repr__(self):
6483 return obj_to_string(self)
6484
6485

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

6420 def arity(self):
6421 """Return the number of arguments for each entry in the function interpretation `self`.
6422
6423 >>> f = Function('f', IntSort(), IntSort())
6424 >>> s = Solver()
6425 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6426 >>> s.check()
6427 sat
6428 >>> m = s.model()
6429 >>> m[f].arity()
6430 1
6431 """
6432 return int(Z3_func_interp_get_arity(self.ctx.ref(), self.f))
6433
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 6465 of file z3py.py.

6465 def as_list(self):
6466 """Return the function interpretation as a Python list.
6467 >>> f = Function('f', IntSort(), IntSort())
6468 >>> s = Solver()
6469 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6470 >>> s.check()
6471 sat
6472 >>> m = s.model()
6473 >>> m[f]
6474 [2 -> 0, else -> 1]
6475 >>> m[f].as_list()
6476 [[2, 0], 1]
6477 """
6478 r = [self.entry(i).as_list() for i in range(self.num_entries())]
6479 r.append(self.else_value())
6480 return r
6481

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

6381 def else_value(self):
6382 """
6383 Return the `else` value for a function interpretation.
6384 Return None if Z3 did not specify the `else` value for
6385 this object.
6386
6387 >>> f = Function('f', IntSort(), IntSort())
6388 >>> s = Solver()
6389 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6390 >>> s.check()
6391 sat
6392 >>> m = s.model()
6393 >>> m[f]
6394 [2 -> 0, else -> 1]
6395 >>> m[f].else_value()
6396 1
6397 """
6398 r = Z3_func_interp_get_else(self.ctx.ref(), self.f)
6399 if r:
6400 return _to_expr_ref(r, self.ctx)
6401 else:
6402 return None
6403
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 6434 of file z3py.py.

6434 def entry(self, idx):
6435 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6436
6437 >>> f = Function('f', IntSort(), IntSort())
6438 >>> s = Solver()
6439 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6440 >>> s.check()
6441 sat
6442 >>> m = s.model()
6443 >>> m[f]
6444 [2 -> 0, else -> 1]
6445 >>> m[f].num_entries()
6446 1
6447 >>> m[f].entry(0)
6448 [2, 0]
6449 """
6450 if idx >= self.num_entries():
6451 raise IndexError
6452 return FuncEntry(Z3_func_interp_get_entry(self.ctx.ref(), self.f, idx), self.ctx)
6453
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 6404 of file z3py.py.

6404 def num_entries(self):
6405 """Return the number of entries/points in the function interpretation `self`.
6406
6407 >>> f = Function('f', IntSort(), IntSort())
6408 >>> s = Solver()
6409 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6410 >>> s.check()
6411 sat
6412 >>> m = s.model()
6413 >>> m[f]
6414 [2 -> 0, else -> 1]
6415 >>> m[f].num_entries()
6416 1
6417 """
6418 return int(Z3_func_interp_get_num_entries(self.ctx.ref(), self.f))
6419
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 6454 of file z3py.py.

6454 def translate(self, other_ctx):
6455 """Copy model 'self' to context 'other_ctx'.
6456 """
6457 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
6458
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 6372 of file z3py.py.

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

◆ model