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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6012 of file z3py.py.

6012 def __init__(self, v=None, ctx=None):
6013 self.vector = None
6014 if v is None:
6015 self.ctx = _get_ctx(ctx)
6016 self.vector = Z3_mk_ast_vector(self.ctx.ref())
6017 else:
6018 self.vector = v
6019 assert ctx is not None
6020 self.ctx = ctx
6021 Z3_ast_vector_inc_ref(self.ctx.ref(), self.vector)
6022
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 6023 of file z3py.py.

6023 def __del__(self):
6024 if self.vector is not None and self.ctx.ref() is not None and Z3_ast_vector_dec_ref is not None:
6025 Z3_ast_vector_dec_ref(self.ctx.ref(), self.vector)
6026
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 6110 of file z3py.py.

6110 def __contains__(self, item):
6111 """Return `True` if the vector contains `item`.
6112
6113 >>> x = Int('x')
6114 >>> A = AstVector()
6115 >>> x in A
6116 False
6117 >>> A.push(x)
6118 >>> x in A
6119 True
6120 >>> (x+1) in A
6121 False
6122 >>> A.push(x+1)
6123 >>> (x+1) in A
6124 True
6125 >>> A
6126 [x, x + 1]
6127 """
6128 for elem in self:
6129 if elem.eq(item):
6130 return True
6131 return False
6132

◆ __copy__()

__copy__ ( self)

Definition at line 6149 of file z3py.py.

6149 def __copy__(self):
6150 return self.translate(self.ctx)
6151

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6152 of file z3py.py.

6152 def __deepcopy__(self, memo={}):
6153 return self.translate(self.ctx)
6154

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

6040 def __getitem__(self, i):
6041 """Return the AST at position `i`.
6042
6043 >>> A = AstVector()
6044 >>> A.push(Int('x') + 1)
6045 >>> A.push(Int('y'))
6046 >>> A[0]
6047 x + 1
6048 >>> A[1]
6049 y
6050 """
6051
6052 if isinstance(i, int):
6053 if i < 0:
6054 i += self.__len__()
6055
6056 if i >= self.__len__():
6057 raise IndexError
6058 return _to_ast_ref(Z3_ast_vector_get(self.ctx.ref(), self.vector, i), self.ctx)
6059
6060 elif isinstance(i, slice):
6061 result = []
6062 for ii in range(*i.indices(self.__len__())):
6063 result.append(_to_ast_ref(
6064 Z3_ast_vector_get(self.ctx.ref(), self.vector, ii),
6065 self.ctx,
6066 ))
6067 return result
6068
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 6027 of file z3py.py.

6027 def __len__(self):
6028 """Return the size of the vector `self`.
6029
6030 >>> A = AstVector()
6031 >>> len(A)
6032 0
6033 >>> A.push(Int('x'))
6034 >>> A.push(Int('x'))
6035 >>> len(A)
6036 2
6037 """
6038 return int(Z3_ast_vector_size(self.ctx.ref(), self.vector))
6039
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 6155 of file z3py.py.

6155 def __repr__(self):
6156 return obj_to_string(self)
6157

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

6069 def __setitem__(self, i, v):
6070 """Update AST at position `i`.
6071
6072 >>> A = AstVector()
6073 >>> A.push(Int('x') + 1)
6074 >>> A.push(Int('y'))
6075 >>> A[0]
6076 x + 1
6077 >>> A[0] = Int('x')
6078 >>> A[0]
6079 x
6080 """
6081 if i >= self.__len__():
6082 raise IndexError
6083 Z3_ast_vector_set(self.ctx.ref(), self.vector, i, v.as_ast())
6084
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 6085 of file z3py.py.

6085 def push(self, v):
6086 """Add `v` in the end of the vector.
6087
6088 >>> A = AstVector()
6089 >>> len(A)
6090 0
6091 >>> A.push(Int('x'))
6092 >>> len(A)
6093 1
6094 """
6095 Z3_ast_vector_push(self.ctx.ref(), self.vector, v.as_ast())
6096
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 6097 of file z3py.py.

6097 def resize(self, sz):
6098 """Resize the vector to `sz` elements.
6099
6100 >>> A = AstVector()
6101 >>> A.resize(10)
6102 >>> len(A)
6103 10
6104 >>> for i in range(10): A[i] = Int('x')
6105 >>> A[5]
6106 x
6107 """
6108 Z3_ast_vector_resize(self.ctx.ref(), self.vector, sz)
6109
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 6158 of file z3py.py.

6158 def sexpr(self):
6159 """Return a textual representation of the s-expression representing the vector."""
6160 return Z3_ast_vector_to_string(self.ctx.ref(), self.vector)
6161
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 6133 of file z3py.py.

6133 def translate(self, other_ctx):
6134 """Copy vector `self` to context `other_ctx`.
6135
6136 >>> x = Int('x')
6137 >>> A = AstVector()
6138 >>> A.push(x)
6139 >>> c2 = Context()
6140 >>> B = A.translate(c2)
6141 >>> B
6142 [x]
6143 """
6144 return AstVector(
6145 Z3_ast_vector_translate(self.ctx.ref(), self.vector, other_ctx.ref()),
6146 ctx=other_ctx,
6147 )
6148
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 6013 of file z3py.py.

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