Z3
Loading...
Searching...
No Matches
AstVector Class Reference
Inheritance diagram for AstVector:

Public Member Functions

 __init__ (self, v=None, ctx=None)
 __del__ (self)
 __len__ (self)
 __getitem__ (self, i)
 __setitem__ (self, i, v)
 push (self, v)
 resize (self, sz)
 __contains__ (self, item)
 translate (self, other_ctx)
 __copy__ (self)
 __deepcopy__ (self, memo={})
 __repr__ (self)
 sexpr (self)
Public Member Functions inherited from Z3PPObject
 use_pp (self)

Data Fields

 vector = None
 ctx = _get_ctx(ctx)

Additional Inherited Members

Protected Member Functions inherited from Z3PPObject
 _repr_html_ (self)

Detailed Description

A collection (vector) of ASTs.

Definition at line 6475 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
v = None,
ctx = None )

Definition at line 6478 of file z3py.py.

6478 def __init__(self, v=None, ctx=None):
6479 self.vector = None
6480 if v is None:
6481 self.ctx = _get_ctx(ctx)
6482 self.vector = Z3_mk_ast_vector(self.ctx.ref())
6483 else:
6484 self.vector = v
6485 assert ctx is not None
6486 self.ctx = ctx
6487 Z3_ast_vector_inc_ref(self.ctx.ref(), self.vector)
6488
void Z3_API Z3_ast_vector_inc_ref(Z3_context c, Z3_ast_vector v)
Increment the reference counter of the given AST vector.
Z3_ast_vector Z3_API Z3_mk_ast_vector(Z3_context c)
Return an empty AST vector.

◆ __del__()

__del__ ( self)

Definition at line 6489 of file z3py.py.

6489 def __del__(self):
6490 if self.vector is not None and self.ctx.ref() is not None and Z3_ast_vector_dec_ref is not None:
6491 Z3_ast_vector_dec_ref(self.ctx.ref(), self.vector)
6492
void Z3_API Z3_ast_vector_dec_ref(Z3_context c, Z3_ast_vector v)
Decrement the reference counter of the given AST vector.

Member Function Documentation

◆ __contains__()

__contains__ ( self,
item )
Return `True` if the vector contains `item`.

>>> x = Int('x')
>>> A = AstVector()
>>> x in A
False
>>> A.push(x)
>>> x in A
True
>>> (x+1) in A
False
>>> A.push(x+1)
>>> (x+1) in A
True
>>> A
[x, x + 1]

Definition at line 6578 of file z3py.py.

6578 def __contains__(self, item):
6579 """Return `True` if the vector contains `item`.
6580
6581 >>> x = Int('x')
6582 >>> A = AstVector()
6583 >>> x in A
6584 False
6585 >>> A.push(x)
6586 >>> x in A
6587 True
6588 >>> (x+1) in A
6589 False
6590 >>> A.push(x+1)
6591 >>> (x+1) in A
6592 True
6593 >>> A
6594 [x, x + 1]
6595 """
6596 for elem in self:
6597 if elem.eq(item):
6598 return True
6599 return False
6600

◆ __copy__()

__copy__ ( self)

Definition at line 6617 of file z3py.py.

6617 def __copy__(self):
6618 return self.translate(self.ctx)
6619

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6620 of file z3py.py.

6620 def __deepcopy__(self, memo={}):
6621 return self.translate(self.ctx)
6622

◆ __getitem__()

__getitem__ ( self,
i )
Return the AST at position `i`.

>>> A = AstVector()
>>> A.push(Int('x') + 1)
>>> A.push(Int('y'))
>>> A[0]
x + 1
>>> A[1]
y

Definition at line 6506 of file z3py.py.

6506 def __getitem__(self, i):
6507 """Return the AST at position `i`.
6508
6509 >>> A = AstVector()
6510 >>> A.push(Int('x') + 1)
6511 >>> A.push(Int('y'))
6512 >>> A[0]
6513 x + 1
6514 >>> A[1]
6515 y
6516 """
6517
6518 if isinstance(i, int):
6519 if i < 0:
6520 i += self.__len__()
6521
6522 if i >= self.__len__():
6523 raise IndexError
6524 return _to_ast_ref(Z3_ast_vector_get(self.ctx.ref(), self.vector, i), self.ctx)
6525
6526 elif isinstance(i, slice):
6527 result = []
6528 for ii in range(*i.indices(self.__len__())):
6529 result.append(_to_ast_ref(
6530 Z3_ast_vector_get(self.ctx.ref(), self.vector, ii),
6531 self.ctx,
6532 ))
6533 return result
6534
Z3_ast Z3_API Z3_ast_vector_get(Z3_context c, Z3_ast_vector v, unsigned i)
Return the AST at position i in the AST vector v.

◆ __len__()

__len__ ( self)
Return the size of the vector `self`.

>>> A = AstVector()
>>> len(A)
0
>>> A.push(Int('x'))
>>> A.push(Int('x'))
>>> len(A)
2

Definition at line 6493 of file z3py.py.

6493 def __len__(self):
6494 """Return the size of the vector `self`.
6495
6496 >>> A = AstVector()
6497 >>> len(A)
6498 0
6499 >>> A.push(Int('x'))
6500 >>> A.push(Int('x'))
6501 >>> len(A)
6502 2
6503 """
6504 return int(Z3_ast_vector_size(self.ctx.ref(), self.vector))
6505
unsigned Z3_API Z3_ast_vector_size(Z3_context c, Z3_ast_vector v)
Return the size of the given AST vector.

Referenced by __getitem__(), and __setitem__().

◆ __repr__()

__repr__ ( self)

Definition at line 6623 of file z3py.py.

6623 def __repr__(self):
6624 return obj_to_string(self)
6625

◆ __setitem__()

__setitem__ ( self,
i,
v )
Update AST at position `i`.

>>> A = AstVector()
>>> A.push(Int('x') + 1)
>>> A.push(Int('y'))
>>> A[0]
x + 1
>>> A[0] = Int('x')
>>> A[0]
x

Definition at line 6535 of file z3py.py.

6535 def __setitem__(self, i, v):
6536 """Update AST at position `i`.
6537
6538 >>> A = AstVector()
6539 >>> A.push(Int('x') + 1)
6540 >>> A.push(Int('y'))
6541 >>> A[0]
6542 x + 1
6543 >>> A[0] = Int('x')
6544 >>> A[0]
6545 x
6546 """
6547 if i < 0:
6548 i += self.__len__()
6549 if i < 0 or i >= self.__len__():
6550 raise IndexError
6551 Z3_ast_vector_set(self.ctx.ref(), self.vector, i, v.as_ast())
6552
void Z3_API Z3_ast_vector_set(Z3_context c, Z3_ast_vector v, unsigned i, Z3_ast a)
Update position i of the AST vector v with the AST a.

◆ push()

push ( self,
v )
Add `v` in the end of the vector.

>>> A = AstVector()
>>> len(A)
0
>>> A.push(Int('x'))
>>> len(A)
1

Definition at line 6553 of file z3py.py.

6553 def push(self, v):
6554 """Add `v` in the end of the vector.
6555
6556 >>> A = AstVector()
6557 >>> len(A)
6558 0
6559 >>> A.push(Int('x'))
6560 >>> len(A)
6561 1
6562 """
6563 Z3_ast_vector_push(self.ctx.ref(), self.vector, v.as_ast())
6564
void Z3_API Z3_ast_vector_push(Z3_context c, Z3_ast_vector v, Z3_ast a)
Add the AST a in the end of the AST vector v. The size of v is increased by one.

Referenced by Solver.__enter__().

◆ resize()

resize ( self,
sz )
Resize the vector to `sz` elements.

>>> A = AstVector()
>>> A.resize(10)
>>> len(A)
10
>>> for i in range(10): A[i] = Int('x')
>>> A[5]
x

Definition at line 6565 of file z3py.py.

6565 def resize(self, sz):
6566 """Resize the vector to `sz` elements.
6567
6568 >>> A = AstVector()
6569 >>> A.resize(10)
6570 >>> len(A)
6571 10
6572 >>> for i in range(10): A[i] = Int('x')
6573 >>> A[5]
6574 x
6575 """
6576 Z3_ast_vector_resize(self.ctx.ref(), self.vector, sz)
6577
void Z3_API Z3_ast_vector_resize(Z3_context c, Z3_ast_vector v, unsigned n)
Resize the AST vector v.

◆ sexpr()

sexpr ( self)
Return a textual representation of the s-expression representing the vector.

Definition at line 6626 of file z3py.py.

6626 def sexpr(self):
6627 """Return a textual representation of the s-expression representing the vector."""
6628 return Z3_ast_vector_to_string(self.ctx.ref(), self.vector)
6629
Z3_string Z3_API Z3_ast_vector_to_string(Z3_context c, Z3_ast_vector v)
Convert AST vector into a string.

◆ translate()

translate ( self,
other_ctx )
Copy vector `self` to context `other_ctx`.

>>> x = Int('x')
>>> A = AstVector()
>>> A.push(x)
>>> c2 = Context()
>>> B = A.translate(c2)
>>> B
[x]

Definition at line 6601 of file z3py.py.

6601 def translate(self, other_ctx):
6602 """Copy vector `self` to context `other_ctx`.
6603
6604 >>> x = Int('x')
6605 >>> A = AstVector()
6606 >>> A.push(x)
6607 >>> c2 = Context()
6608 >>> B = A.translate(c2)
6609 >>> B
6610 [x]
6611 """
6612 return AstVector(
6613 Z3_ast_vector_translate(self.ctx.ref(), self.vector, other_ctx.ref()),
6614 ctx=other_ctx,
6615 )
6616
Z3_ast_vector Z3_API Z3_ast_vector_translate(Z3_context s, Z3_ast_vector v, Z3_context t)
Translate the AST vector v from context s into an AST vector in context t.

Referenced by __copy__(), FuncInterp.__copy__(), ModelRef.__copy__(), __deepcopy__(), FuncInterp.__deepcopy__(), and ModelRef.__deepcopy__().

Field Documentation

◆ ctx

◆ vector

vector = None

Definition at line 6479 of file z3py.py.

Referenced by __del__(), __getitem__(), __len__(), __setitem__(), push(), resize(), sexpr(), and translate().