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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 5977 of file z3py.py.

5977 def __init__(self, v=None, ctx=None):
5978 self.vector = None
5979 if v is None:
5980 self.ctx = _get_ctx(ctx)
5981 self.vector = Z3_mk_ast_vector(self.ctx.ref())
5982 else:
5983 self.vector = v
5984 assert ctx is not None
5985 self.ctx = ctx
5986 Z3_ast_vector_inc_ref(self.ctx.ref(), self.vector)
5987
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 5988 of file z3py.py.

5988 def __del__(self):
5989 if self.vector is not None and self.ctx.ref() is not None and Z3_ast_vector_dec_ref is not None:
5990 Z3_ast_vector_dec_ref(self.ctx.ref(), self.vector)
5991
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 6075 of file z3py.py.

6075 def __contains__(self, item):
6076 """Return `True` if the vector contains `item`.
6077
6078 >>> x = Int('x')
6079 >>> A = AstVector()
6080 >>> x in A
6081 False
6082 >>> A.push(x)
6083 >>> x in A
6084 True
6085 >>> (x+1) in A
6086 False
6087 >>> A.push(x+1)
6088 >>> (x+1) in A
6089 True
6090 >>> A
6091 [x, x + 1]
6092 """
6093 for elem in self:
6094 if elem.eq(item):
6095 return True
6096 return False
6097

◆ __copy__()

__copy__ ( self)

Definition at line 6114 of file z3py.py.

6114 def __copy__(self):
6115 return self.translate(self.ctx)
6116

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6117 of file z3py.py.

6117 def __deepcopy__(self, memo={}):
6118 return self.translate(self.ctx)
6119

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

6005 def __getitem__(self, i):
6006 """Return the 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[1]
6014 y
6015 """
6016
6017 if isinstance(i, int):
6018 if i < 0:
6019 i += self.__len__()
6020
6021 if i >= self.__len__():
6022 raise IndexError
6023 return _to_ast_ref(Z3_ast_vector_get(self.ctx.ref(), self.vector, i), self.ctx)
6024
6025 elif isinstance(i, slice):
6026 result = []
6027 for ii in range(*i.indices(self.__len__())):
6028 result.append(_to_ast_ref(
6029 Z3_ast_vector_get(self.ctx.ref(), self.vector, ii),
6030 self.ctx,
6031 ))
6032 return result
6033
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 5992 of file z3py.py.

5992 def __len__(self):
5993 """Return the size of the vector `self`.
5994
5995 >>> A = AstVector()
5996 >>> len(A)
5997 0
5998 >>> A.push(Int('x'))
5999 >>> A.push(Int('x'))
6000 >>> len(A)
6001 2
6002 """
6003 return int(Z3_ast_vector_size(self.ctx.ref(), self.vector))
6004
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 6120 of file z3py.py.

6120 def __repr__(self):
6121 return obj_to_string(self)
6122

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

6034 def __setitem__(self, i, v):
6035 """Update AST at position `i`.
6036
6037 >>> A = AstVector()
6038 >>> A.push(Int('x') + 1)
6039 >>> A.push(Int('y'))
6040 >>> A[0]
6041 x + 1
6042 >>> A[0] = Int('x')
6043 >>> A[0]
6044 x
6045 """
6046 if i >= self.__len__():
6047 raise IndexError
6048 Z3_ast_vector_set(self.ctx.ref(), self.vector, i, v.as_ast())
6049
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 6050 of file z3py.py.

6050 def push(self, v):
6051 """Add `v` in the end of the vector.
6052
6053 >>> A = AstVector()
6054 >>> len(A)
6055 0
6056 >>> A.push(Int('x'))
6057 >>> len(A)
6058 1
6059 """
6060 Z3_ast_vector_push(self.ctx.ref(), self.vector, v.as_ast())
6061
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 6062 of file z3py.py.

6062 def resize(self, sz):
6063 """Resize the vector to `sz` elements.
6064
6065 >>> A = AstVector()
6066 >>> A.resize(10)
6067 >>> len(A)
6068 10
6069 >>> for i in range(10): A[i] = Int('x')
6070 >>> A[5]
6071 x
6072 """
6073 Z3_ast_vector_resize(self.ctx.ref(), self.vector, sz)
6074
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 6123 of file z3py.py.

6123 def sexpr(self):
6124 """Return a textual representation of the s-expression representing the vector."""
6125 return Z3_ast_vector_to_string(self.ctx.ref(), self.vector)
6126
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 6098 of file z3py.py.

6098 def translate(self, other_ctx):
6099 """Copy vector `self` to context `other_ctx`.
6100
6101 >>> x = Int('x')
6102 >>> A = AstVector()
6103 >>> A.push(x)
6104 >>> c2 = Context()
6105 >>> B = A.translate(c2)
6106 >>> B
6107 [x]
6108 """
6109 return AstVector(
6110 Z3_ast_vector_translate(self.ctx.ref(), self.vector, other_ctx.ref()),
6111 ctx=other_ctx,
6112 )
6113
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 5978 of file z3py.py.

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