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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
f,
ctx )

Definition at line 6485 of file z3py.py.

6485 def __init__(self, f, ctx):
6486 self.f = f
6487 self.ctx = ctx
6488 if self.f is not None:
6489 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
6490
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 6491 of file z3py.py.

6491 def __del__(self):
6492 if self.f is not None and self.ctx.ref() is not None and Z3_func_interp_dec_ref is not None:
6493 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
6494
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 6573 of file z3py.py.

6573 def __copy__(self):
6574 return self.translate(self.ctx)
6575

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6576 of file z3py.py.

6576 def __deepcopy__(self, memo={}):
6577 return self.translate(self.ctx)
6578

◆ __repr__()

__repr__ ( self)

Definition at line 6596 of file z3py.py.

6596 def __repr__(self):
6597 return obj_to_string(self)
6598
6599

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

6534 def arity(self):
6535 """Return the number of arguments for each entry in the function interpretation `self`.
6536
6537 >>> f = Function('f', IntSort(), IntSort())
6538 >>> s = Solver()
6539 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6540 >>> s.check()
6541 sat
6542 >>> m = s.model()
6543 >>> m[f].arity()
6544 1
6545 """
6546 return int(Z3_func_interp_get_arity(self.ctx.ref(), self.f))
6547
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 6579 of file z3py.py.

6579 def as_list(self):
6580 """Return the function interpretation as a Python list.
6581 >>> f = Function('f', IntSort(), IntSort())
6582 >>> s = Solver()
6583 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6584 >>> s.check()
6585 sat
6586 >>> m = s.model()
6587 >>> m[f]
6588 [2 -> 0, else -> 1]
6589 >>> m[f].as_list()
6590 [[2, 0], 1]
6591 """
6592 r = [self.entry(i).as_list() for i in range(self.num_entries())]
6593 r.append(self.else_value())
6594 return r
6595

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

6495 def else_value(self):
6496 """
6497 Return the `else` value for a function interpretation.
6498 Return None if Z3 did not specify the `else` value for
6499 this object.
6500
6501 >>> f = Function('f', IntSort(), IntSort())
6502 >>> s = Solver()
6503 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6504 >>> s.check()
6505 sat
6506 >>> m = s.model()
6507 >>> m[f]
6508 [2 -> 0, else -> 1]
6509 >>> m[f].else_value()
6510 1
6511 """
6512 r = Z3_func_interp_get_else(self.ctx.ref(), self.f)
6513 if r:
6514 return _to_expr_ref(r, self.ctx)
6515 else:
6516 return None
6517
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 6548 of file z3py.py.

6548 def entry(self, idx):
6549 """Return an entry at position `idx < self.num_entries()` in the function interpretation `self`.
6550
6551 >>> f = Function('f', IntSort(), IntSort())
6552 >>> s = Solver()
6553 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6554 >>> s.check()
6555 sat
6556 >>> m = s.model()
6557 >>> m[f]
6558 [2 -> 0, else -> 1]
6559 >>> m[f].num_entries()
6560 1
6561 >>> m[f].entry(0)
6562 [2, 0]
6563 """
6564 if idx >= self.num_entries():
6565 raise IndexError
6566 return FuncEntry(Z3_func_interp_get_entry(self.ctx.ref(), self.f, idx), self.ctx)
6567
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 6518 of file z3py.py.

6518 def num_entries(self):
6519 """Return the number of entries/points in the function interpretation `self`.
6520
6521 >>> f = Function('f', IntSort(), IntSort())
6522 >>> s = Solver()
6523 >>> s.add(f(0) == 1, f(1) == 1, f(2) == 0)
6524 >>> s.check()
6525 sat
6526 >>> m = s.model()
6527 >>> m[f]
6528 [2 -> 0, else -> 1]
6529 >>> m[f].num_entries()
6530 1
6531 """
6532 return int(Z3_func_interp_get_num_entries(self.ctx.ref(), self.f))
6533
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 6568 of file z3py.py.

6568 def translate(self, other_ctx):
6569 """Copy model 'self' to context 'other_ctx'.
6570 """
6571 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
6572
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 6486 of file z3py.py.

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

◆ model