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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6076 of file z3py.py.

6076 def __init__(self, v=None, ctx=None):
6077 self.vector = None
6078 if v is None:
6079 self.ctx = _get_ctx(ctx)
6080 self.vector = Z3_mk_ast_vector(self.ctx.ref())
6081 else:
6082 self.vector = v
6083 assert ctx is not None
6084 self.ctx = ctx
6085 Z3_ast_vector_inc_ref(self.ctx.ref(), self.vector)
6086
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 6087 of file z3py.py.

6087 def __del__(self):
6088 if self.vector is not None and self.ctx.ref() is not None and Z3_ast_vector_dec_ref is not None:
6089 Z3_ast_vector_dec_ref(self.ctx.ref(), self.vector)
6090
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 6176 of file z3py.py.

6176 def __contains__(self, item):
6177 """Return `True` if the vector contains `item`.
6178
6179 >>> x = Int('x')
6180 >>> A = AstVector()
6181 >>> x in A
6182 False
6183 >>> A.push(x)
6184 >>> x in A
6185 True
6186 >>> (x+1) in A
6187 False
6188 >>> A.push(x+1)
6189 >>> (x+1) in A
6190 True
6191 >>> A
6192 [x, x + 1]
6193 """
6194 for elem in self:
6195 if elem.eq(item):
6196 return True
6197 return False
6198

◆ __copy__()

__copy__ ( self)

Definition at line 6215 of file z3py.py.

6215 def __copy__(self):
6216 return self.translate(self.ctx)
6217

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6218 of file z3py.py.

6218 def __deepcopy__(self, memo={}):
6219 return self.translate(self.ctx)
6220

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

6104 def __getitem__(self, i):
6105 """Return the AST at position `i`.
6106
6107 >>> A = AstVector()
6108 >>> A.push(Int('x') + 1)
6109 >>> A.push(Int('y'))
6110 >>> A[0]
6111 x + 1
6112 >>> A[1]
6113 y
6114 """
6115
6116 if isinstance(i, int):
6117 if i < 0:
6118 i += self.__len__()
6119
6120 if i >= self.__len__():
6121 raise IndexError
6122 return _to_ast_ref(Z3_ast_vector_get(self.ctx.ref(), self.vector, i), self.ctx)
6123
6124 elif isinstance(i, slice):
6125 result = []
6126 for ii in range(*i.indices(self.__len__())):
6127 result.append(_to_ast_ref(
6128 Z3_ast_vector_get(self.ctx.ref(), self.vector, ii),
6129 self.ctx,
6130 ))
6131 return result
6132
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 6091 of file z3py.py.

6091 def __len__(self):
6092 """Return the size of the vector `self`.
6093
6094 >>> A = AstVector()
6095 >>> len(A)
6096 0
6097 >>> A.push(Int('x'))
6098 >>> A.push(Int('x'))
6099 >>> len(A)
6100 2
6101 """
6102 return int(Z3_ast_vector_size(self.ctx.ref(), self.vector))
6103
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 6221 of file z3py.py.

6221 def __repr__(self):
6222 return obj_to_string(self)
6223

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

6133 def __setitem__(self, i, v):
6134 """Update AST at position `i`.
6135
6136 >>> A = AstVector()
6137 >>> A.push(Int('x') + 1)
6138 >>> A.push(Int('y'))
6139 >>> A[0]
6140 x + 1
6141 >>> A[0] = Int('x')
6142 >>> A[0]
6143 x
6144 """
6145 if i < 0:
6146 i += self.__len__()
6147 if i < 0 or i >= self.__len__():
6148 raise IndexError
6149 Z3_ast_vector_set(self.ctx.ref(), self.vector, i, v.as_ast())
6150
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 6151 of file z3py.py.

6151 def push(self, v):
6152 """Add `v` in the end of the vector.
6153
6154 >>> A = AstVector()
6155 >>> len(A)
6156 0
6157 >>> A.push(Int('x'))
6158 >>> len(A)
6159 1
6160 """
6161 Z3_ast_vector_push(self.ctx.ref(), self.vector, v.as_ast())
6162
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 6163 of file z3py.py.

6163 def resize(self, sz):
6164 """Resize the vector to `sz` elements.
6165
6166 >>> A = AstVector()
6167 >>> A.resize(10)
6168 >>> len(A)
6169 10
6170 >>> for i in range(10): A[i] = Int('x')
6171 >>> A[5]
6172 x
6173 """
6174 Z3_ast_vector_resize(self.ctx.ref(), self.vector, sz)
6175
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 6224 of file z3py.py.

6224 def sexpr(self):
6225 """Return a textual representation of the s-expression representing the vector."""
6226 return Z3_ast_vector_to_string(self.ctx.ref(), self.vector)
6227
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 6199 of file z3py.py.

6199 def translate(self, other_ctx):
6200 """Copy vector `self` to context `other_ctx`.
6201
6202 >>> x = Int('x')
6203 >>> A = AstVector()
6204 >>> A.push(x)
6205 >>> c2 = Context()
6206 >>> B = A.translate(c2)
6207 >>> B
6208 [x]
6209 """
6210 return AstVector(
6211 Z3_ast_vector_translate(self.ctx.ref(), self.vector, other_ctx.ref()),
6212 ctx=other_ctx,
6213 )
6214
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 6077 of file z3py.py.

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