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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
f,
ctx )

Definition at line 6466 of file z3py.py.

6466 def __init__(self, f, ctx):
6467 self.f = f
6468 self.ctx = ctx
6469 if self.f is not None:
6470 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
6471
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 6472 of file z3py.py.

6472 def __del__(self):
6473 if self.f is not None and self.ctx.ref() is not None and Z3_func_interp_dec_ref is not None:
6474 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
6475
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 6554 of file z3py.py.

6554 def __copy__(self):
6555 return self.translate(self.ctx)
6556

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6557 of file z3py.py.

6557 def __deepcopy__(self, memo={}):
6558 return self.translate(self.ctx)
6559

◆ __repr__()

__repr__ ( self)

Definition at line 6577 of file z3py.py.

6577 def __repr__(self):
6578 return obj_to_string(self)
6579
6580

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

6515 def arity(self):
6516 """Return the number of arguments for each entry in the function interpretation `self`.
6517
6518 >>> f = Function('f', IntSort(), IntSort())
6519 >>> s = Solver()
6520 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6521 >>> s.check()
6522 sat
6523 >>> m = s.model()
6524 >>> m[f].arity()
6525 1
6526 """
6527 return int(Z3_func_interp_get_arity(self.ctx.ref(), self.f))
6528
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 6560 of file z3py.py.

6560 def as_list(self):
6561 """Return the function interpretation as a Python list.
6562 >>> f = Function('f', IntSort(), IntSort())
6563 >>> s = Solver()
6564 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6565 >>> s.check()
6566 sat
6567 >>> m = s.model()
6568 >>> m[f]
6569 [2 -> 0, else -> 1]
6570 >>> m[f].as_list()
6571 [[2, 0], 1]
6572 """
6573 r = [self.entry(i).as_list() for i in range(self.num_entries())]
6574 r.append(self.else_value())
6575 return r
6576

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

6476 def else_value(self):
6477 """
6478 Return the `else` value for a function interpretation.
6479 Return None if Z3 did not specify the `else` value for
6480 this object.
6481
6482 >>> f = Function('f', IntSort(), IntSort())
6483 >>> s = Solver()
6484 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6485 >>> s.check()
6486 sat
6487 >>> m = s.model()
6488 >>> m[f]
6489 [2 -> 0, else -> 1]
6490 >>> m[f].else_value()
6491 1
6492 """
6493 r = Z3_func_interp_get_else(self.ctx.ref(), self.f)
6494 if r:
6495 return _to_expr_ref(r, self.ctx)
6496 else:
6497 return None
6498
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 6529 of file z3py.py.

6529 def entry(self, idx):
6530 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6531
6532 >>> f = Function('f', IntSort(), IntSort())
6533 >>> s = Solver()
6534 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6535 >>> s.check()
6536 sat
6537 >>> m = s.model()
6538 >>> m[f]
6539 [2 -> 0, else -> 1]
6540 >>> m[f].num_entries()
6541 1
6542 >>> m[f].entry(0)
6543 [2, 0]
6544 """
6545 if idx >= self.num_entries():
6546 raise IndexError
6547 return FuncEntry(Z3_func_interp_get_entry(self.ctx.ref(), self.f, idx), self.ctx)
6548
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 6499 of file z3py.py.

6499 def num_entries(self):
6500 """Return the number of entries/points in the function interpretation `self`.
6501
6502 >>> f = Function('f', IntSort(), IntSort())
6503 >>> s = Solver()
6504 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6505 >>> s.check()
6506 sat
6507 >>> m = s.model()
6508 >>> m[f]
6509 [2 -> 0, else -> 1]
6510 >>> m[f].num_entries()
6511 1
6512 """
6513 return int(Z3_func_interp_get_num_entries(self.ctx.ref(), self.f))
6514
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 6549 of file z3py.py.

6549 def translate(self, other_ctx):
6550 """Copy model 'self' to context 'other_ctx'.
6551 """
6552 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
6553
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 6467 of file z3py.py.

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

◆ model