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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6089 of file z3py.py.

6089 def __init__(self, v=None, ctx=None):
6090 self.vector = None
6091 if v is None:
6092 self.ctx = _get_ctx(ctx)
6093 self.vector = Z3_mk_ast_vector(self.ctx.ref())
6094 else:
6095 self.vector = v
6096 assert ctx is not None
6097 self.ctx = ctx
6098 Z3_ast_vector_inc_ref(self.ctx.ref(), self.vector)
6099
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 6100 of file z3py.py.

6100 def __del__(self):
6101 if self.vector is not None and self.ctx.ref() is not None and Z3_ast_vector_dec_ref is not None:
6102 Z3_ast_vector_dec_ref(self.ctx.ref(), self.vector)
6103
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 6189 of file z3py.py.

6189 def __contains__(self, item):
6190 """Return `True` if the vector contains `item`.
6191
6192 >>> x = Int('x')
6193 >>> A = AstVector()
6194 >>> x in A
6195 False
6196 >>> A.push(x)
6197 >>> x in A
6198 True
6199 >>> (x+1) in A
6200 False
6201 >>> A.push(x+1)
6202 >>> (x+1) in A
6203 True
6204 >>> A
6205 [x, x + 1]
6206 """
6207 for elem in self:
6208 if elem.eq(item):
6209 return True
6210 return False
6211

◆ __copy__()

__copy__ ( self)

Definition at line 6228 of file z3py.py.

6228 def __copy__(self):
6229 return self.translate(self.ctx)
6230

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6231 of file z3py.py.

6231 def __deepcopy__(self, memo={}):
6232 return self.translate(self.ctx)
6233

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

6117 def __getitem__(self, i):
6118 """Return the AST at position `i`.
6119
6120 >>> A = AstVector()
6121 >>> A.push(Int('x') + 1)
6122 >>> A.push(Int('y'))
6123 >>> A[0]
6124 x + 1
6125 >>> A[1]
6126 y
6127 """
6128
6129 if isinstance(i, int):
6130 if i < 0:
6131 i += self.__len__()
6132
6133 if i >= self.__len__():
6134 raise IndexError
6135 return _to_ast_ref(Z3_ast_vector_get(self.ctx.ref(), self.vector, i), self.ctx)
6136
6137 elif isinstance(i, slice):
6138 result = []
6139 for ii in range(*i.indices(self.__len__())):
6140 result.append(_to_ast_ref(
6141 Z3_ast_vector_get(self.ctx.ref(), self.vector, ii),
6142 self.ctx,
6143 ))
6144 return result
6145
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 6104 of file z3py.py.

6104 def __len__(self):
6105 """Return the size of the vector `self`.
6106
6107 >>> A = AstVector()
6108 >>> len(A)
6109 0
6110 >>> A.push(Int('x'))
6111 >>> A.push(Int('x'))
6112 >>> len(A)
6113 2
6114 """
6115 return int(Z3_ast_vector_size(self.ctx.ref(), self.vector))
6116
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 6234 of file z3py.py.

6234 def __repr__(self):
6235 return obj_to_string(self)
6236

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

6146 def __setitem__(self, i, v):
6147 """Update AST at position `i`.
6148
6149 >>> A = AstVector()
6150 >>> A.push(Int('x') + 1)
6151 >>> A.push(Int('y'))
6152 >>> A[0]
6153 x + 1
6154 >>> A[0] = Int('x')
6155 >>> A[0]
6156 x
6157 """
6158 if i < 0:
6159 i += self.__len__()
6160 if i < 0 or i >= self.__len__():
6161 raise IndexError
6162 Z3_ast_vector_set(self.ctx.ref(), self.vector, i, v.as_ast())
6163
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 6164 of file z3py.py.

6164 def push(self, v):
6165 """Add `v` in the end of the vector.
6166
6167 >>> A = AstVector()
6168 >>> len(A)
6169 0
6170 >>> A.push(Int('x'))
6171 >>> len(A)
6172 1
6173 """
6174 Z3_ast_vector_push(self.ctx.ref(), self.vector, v.as_ast())
6175
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 6176 of file z3py.py.

6176 def resize(self, sz):
6177 """Resize the vector to `sz` elements.
6178
6179 >>> A = AstVector()
6180 >>> A.resize(10)
6181 >>> len(A)
6182 10
6183 >>> for i in range(10): A[i] = Int('x')
6184 >>> A[5]
6185 x
6186 """
6187 Z3_ast_vector_resize(self.ctx.ref(), self.vector, sz)
6188
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 6237 of file z3py.py.

6237 def sexpr(self):
6238 """Return a textual representation of the s-expression representing the vector."""
6239 return Z3_ast_vector_to_string(self.ctx.ref(), self.vector)
6240
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 6212 of file z3py.py.

6212 def translate(self, other_ctx):
6213 """Copy vector `self` to context `other_ctx`.
6214
6215 >>> x = Int('x')
6216 >>> A = AstVector()
6217 >>> A.push(x)
6218 >>> c2 = Context()
6219 >>> B = A.translate(c2)
6220 >>> B
6221 [x]
6222 """
6223 return AstVector(
6224 Z3_ast_vector_translate(self.ctx.ref(), self.vector, other_ctx.ref()),
6225 ctx=other_ctx,
6226 )
6227
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 6090 of file z3py.py.

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