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

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
f,
ctx )

Definition at line 6472 of file z3py.py.

6472 def __init__(self, f, ctx):
6473 self.f = f
6474 self.ctx = ctx
6475 if self.f is not None:
6476 Z3_func_interp_inc_ref(self.ctx.ref(), self.f)
6477
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 6478 of file z3py.py.

6478 def __del__(self):
6479 if self.f is not None and self.ctx.ref() is not None and Z3_func_interp_dec_ref is not None:
6480 Z3_func_interp_dec_ref(self.ctx.ref(), self.f)
6481
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 6560 of file z3py.py.

6560 def __copy__(self):
6561 return self.translate(self.ctx)
6562

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6563 of file z3py.py.

6563 def __deepcopy__(self, memo={}):
6564 return self.translate(self.ctx)
6565

◆ __repr__()

__repr__ ( self)

Definition at line 6583 of file z3py.py.

6583 def __repr__(self):
6584 return obj_to_string(self)
6585
6586

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

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

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

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

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

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

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

6555 def translate(self, other_ctx):
6556 """Copy model 'self' to context 'other_ctx'.
6557 """
6558 return ModelRef(Z3_model_translate(self.ctx.ref(), self.model, other_ctx.ref()), other_ctx)
6559
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 6473 of file z3py.py.

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

◆ model