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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 5948 of file z3py.py.

5948 def __init__(self, v=None, ctx=None):
5949 self.vector = None
5950 if v is None:
5951 self.ctx = _get_ctx(ctx)
5952 self.vector = Z3_mk_ast_vector(self.ctx.ref())
5953 else:
5954 self.vector = v
5955 assert ctx is not None
5956 self.ctx = ctx
5957 Z3_ast_vector_inc_ref(self.ctx.ref(), self.vector)
5958
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 5959 of file z3py.py.

5959 def __del__(self):
5960 if self.vector is not None and self.ctx.ref() is not None and Z3_ast_vector_dec_ref is not None:
5961 Z3_ast_vector_dec_ref(self.ctx.ref(), self.vector)
5962
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 6046 of file z3py.py.

6046 def __contains__(self, item):
6047 """Return `True` if the vector contains `item`.
6048
6049 >>> x = Int('x')
6050 >>> A = AstVector()
6051 >>> x in A
6052 False
6053 >>> A.push(x)
6054 >>> x in A
6055 True
6056 >>> (x+1) in A
6057 False
6058 >>> A.push(x+1)
6059 >>> (x+1) in A
6060 True
6061 >>> A
6062 [x, x + 1]
6063 """
6064 for elem in self:
6065 if elem.eq(item):
6066 return True
6067 return False
6068

◆ __copy__()

__copy__ ( self)

Definition at line 6085 of file z3py.py.

6085 def __copy__(self):
6086 return self.translate(self.ctx)
6087

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6088 of file z3py.py.

6088 def __deepcopy__(self, memo={}):
6089 return self.translate(self.ctx)
6090

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

5976 def __getitem__(self, i):
5977 """Return the AST at position `i`.
5978
5979 >>> A = AstVector()
5980 >>> A.push(Int('x') + 1)
5981 >>> A.push(Int('y'))
5982 >>> A[0]
5983 x + 1
5984 >>> A[1]
5985 y
5986 """
5987
5988 if isinstance(i, int):
5989 if i < 0:
5990 i += self.__len__()
5991
5992 if i >= self.__len__():
5993 raise IndexError
5994 return _to_ast_ref(Z3_ast_vector_get(self.ctx.ref(), self.vector, i), self.ctx)
5995
5996 elif isinstance(i, slice):
5997 result = []
5998 for ii in range(*i.indices(self.__len__())):
5999 result.append(_to_ast_ref(
6000 Z3_ast_vector_get(self.ctx.ref(), self.vector, ii),
6001 self.ctx,
6002 ))
6003 return result
6004
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 5963 of file z3py.py.

5963 def __len__(self):
5964 """Return the size of the vector `self`.
5965
5966 >>> A = AstVector()
5967 >>> len(A)
5968 0
5969 >>> A.push(Int('x'))
5970 >>> A.push(Int('x'))
5971 >>> len(A)
5972 2
5973 """
5974 return int(Z3_ast_vector_size(self.ctx.ref(), self.vector))
5975
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 6091 of file z3py.py.

6091 def __repr__(self):
6092 return obj_to_string(self)
6093

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

6005 def __setitem__(self, i, v):
6006 """Update AST at position `i`.
6007
6008 >>> A = AstVector()
6009 >>> A.push(Int('x') + 1)
6010 >>> A.push(Int('y'))
6011 >>> A[0]
6012 x + 1
6013 >>> A[0] = Int('x')
6014 >>> A[0]
6015 x
6016 """
6017 if i >= self.__len__():
6018 raise IndexError
6019 Z3_ast_vector_set(self.ctx.ref(), self.vector, i, v.as_ast())
6020
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 6021 of file z3py.py.

6021 def push(self, v):
6022 """Add `v` in the end of the vector.
6023
6024 >>> A = AstVector()
6025 >>> len(A)
6026 0
6027 >>> A.push(Int('x'))
6028 >>> len(A)
6029 1
6030 """
6031 Z3_ast_vector_push(self.ctx.ref(), self.vector, v.as_ast())
6032
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 6033 of file z3py.py.

6033 def resize(self, sz):
6034 """Resize the vector to `sz` elements.
6035
6036 >>> A = AstVector()
6037 >>> A.resize(10)
6038 >>> len(A)
6039 10
6040 >>> for i in range(10): A[i] = Int('x')
6041 >>> A[5]
6042 x
6043 """
6044 Z3_ast_vector_resize(self.ctx.ref(), self.vector, sz)
6045
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 6094 of file z3py.py.

6094 def sexpr(self):
6095 """Return a textual representation of the s-expression representing the vector."""
6096 return Z3_ast_vector_to_string(self.ctx.ref(), self.vector)
6097
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 6069 of file z3py.py.

6069 def translate(self, other_ctx):
6070 """Copy vector `self` to context `other_ctx`.
6071
6072 >>> x = Int('x')
6073 >>> A = AstVector()
6074 >>> A.push(x)
6075 >>> c2 = Context()
6076 >>> B = A.translate(c2)
6077 >>> B
6078 [x]
6079 """
6080 return AstVector(
6081 Z3_ast_vector_translate(self.ctx.ref(), self.vector, other_ctx.ref()),
6082 ctx=other_ctx,
6083 )
6084
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 5949 of file z3py.py.

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