Z3
Loading...
Searching...
No Matches
AstMap Class Reference

Public Member Functions

 __init__ (self, m=None, ctx=None)
 __deepcopy__ (self, memo={})
 __del__ (self)
 __len__ (self)
 __contains__ (self, key)
 __getitem__ (self, key)
 __setitem__ (self, k, v)
 __repr__ (self)
 erase (self, k)
 reset (self)
 keys (self)

Data Fields

 map = None
 ctx = _get_ctx(ctx)

Detailed Description

A mapping from ASTs to ASTs.

Definition at line 6169 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6172 of file z3py.py.

6172 def __init__(self, m=None, ctx=None):
6173 self.map = None
6174 if m is None:
6175 self.ctx = _get_ctx(ctx)
6176 self.map = Z3_mk_ast_map(self.ctx.ref())
6177 else:
6178 self.map = m
6179 assert ctx is not None
6180 self.ctx = ctx
6181 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6182
void Z3_API Z3_ast_map_inc_ref(Z3_context c, Z3_ast_map m)
Increment the reference counter of the given AST map.
Z3_ast_map Z3_API Z3_mk_ast_map(Z3_context c)
Return an empty mapping from AST to AST.

◆ __del__()

__del__ ( self)

Definition at line 6186 of file z3py.py.

6186 def __del__(self):
6187 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6188 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6189
void Z3_API Z3_ast_map_dec_ref(Z3_context c, Z3_ast_map m)
Decrement the reference counter of the given AST map.

Member Function Documentation

◆ __contains__()

__contains__ ( self,
key )
Return `True` if the map contains key `key`.

>>> M = AstMap()
>>> x = Int('x')
>>> M[x] = x + 1
>>> x in M
True
>>> x+1 in M
False

Definition at line 6203 of file z3py.py.

6203 def __contains__(self, key):
6204 """Return `True` if the map contains key `key`.
6205
6206 >>> M = AstMap()
6207 >>> x = Int('x')
6208 >>> M[x] = x + 1
6209 >>> x in M
6210 True
6211 >>> x+1 in M
6212 False
6213 """
6214 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6215
bool Z3_API Z3_ast_map_contains(Z3_context c, Z3_ast_map m, Z3_ast k)
Return true if the map m contains the AST key k.

◆ __deepcopy__()

__deepcopy__ ( self,
memo = {} )

Definition at line 6183 of file z3py.py.

6183 def __deepcopy__(self, memo={}):
6184 return AstMap(self.map, self.ctx)
6185

◆ __getitem__()

__getitem__ ( self,
key )
Retrieve the value associated with key `key`.

>>> M = AstMap()
>>> x = Int('x')
>>> M[x] = x + 1
>>> M[x]
x + 1

Definition at line 6216 of file z3py.py.

6216 def __getitem__(self, key):
6217 """Retrieve the value associated with key `key`.
6218
6219 >>> M = AstMap()
6220 >>> x = Int('x')
6221 >>> M[x] = x + 1
6222 >>> M[x]
6223 x + 1
6224 """
6225 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6226
Z3_ast Z3_API Z3_ast_map_find(Z3_context c, Z3_ast_map m, Z3_ast k)
Return the value associated with the key k.

◆ __len__()

__len__ ( self)
Return the size of the map.

>>> M = AstMap()
>>> len(M)
0
>>> x = Int('x')
>>> M[x] = IntVal(1)
>>> len(M)
1

Definition at line 6190 of file z3py.py.

6190 def __len__(self):
6191 """Return the size of the map.
6192
6193 >>> M = AstMap()
6194 >>> len(M)
6195 0
6196 >>> x = Int('x')
6197 >>> M[x] = IntVal(1)
6198 >>> len(M)
6199 1
6200 """
6201 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6202
unsigned Z3_API Z3_ast_map_size(Z3_context c, Z3_ast_map m)
Return the size of the given map.

◆ __repr__()

__repr__ ( self)

Definition at line 6243 of file z3py.py.

6243 def __repr__(self):
6244 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6245
Z3_string Z3_API Z3_ast_map_to_string(Z3_context c, Z3_ast_map m)
Convert the given map into a string.

◆ __setitem__()

__setitem__ ( self,
k,
v )
Add/Update key `k` with value `v`.

>>> M = AstMap()
>>> x = Int('x')
>>> M[x] = x + 1
>>> len(M)
1
>>> M[x]
x + 1
>>> M[x] = IntVal(1)
>>> M[x]
1

Definition at line 6227 of file z3py.py.

6227 def __setitem__(self, k, v):
6228 """Add/Update key `k` with value `v`.
6229
6230 >>> M = AstMap()
6231 >>> x = Int('x')
6232 >>> M[x] = x + 1
6233 >>> len(M)
6234 1
6235 >>> M[x]
6236 x + 1
6237 >>> M[x] = IntVal(1)
6238 >>> M[x]
6239 1
6240 """
6241 Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
6242
void Z3_API Z3_ast_map_insert(Z3_context c, Z3_ast_map m, Z3_ast k, Z3_ast v)
Store/Replace a new key, value pair in the given map.

◆ erase()

erase ( self,
k )
Remove the entry associated with key `k`.

>>> M = AstMap()
>>> x = Int('x')
>>> M[x] = x + 1
>>> len(M)
1
>>> M.erase(x)
>>> len(M)
0

Definition at line 6246 of file z3py.py.

6246 def erase(self, k):
6247 """Remove the entry associated with key `k`.
6248
6249 >>> M = AstMap()
6250 >>> x = Int('x')
6251 >>> M[x] = x + 1
6252 >>> len(M)
6253 1
6254 >>> M.erase(x)
6255 >>> len(M)
6256 0
6257 """
6258 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6259
void Z3_API Z3_ast_map_erase(Z3_context c, Z3_ast_map m, Z3_ast k)
Erase a key from the map.

◆ keys()

keys ( self)
Return an AstVector containing all keys in the map.

>>> M = AstMap()
>>> x = Int('x')
>>> M[x]   = x + 1
>>> M[x+x] = IntVal(1)
>>> M.keys()
[x, x + x]

Definition at line 6275 of file z3py.py.

6275 def keys(self):
6276 """Return an AstVector containing all keys in the map.
6277
6278 >>> M = AstMap()
6279 >>> x = Int('x')
6280 >>> M[x] = x + 1
6281 >>> M[x+x] = IntVal(1)
6282 >>> M.keys()
6283 [x, x + x]
6284 """
6285 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6286
Z3_ast_vector Z3_API Z3_ast_map_keys(Z3_context c, Z3_ast_map m)
Return the keys stored in the given map.

◆ reset()

reset ( self)
Remove all entries from the map.

>>> M = AstMap()
>>> x = Int('x')
>>> M[x]   = x + 1
>>> M[x+x] = IntVal(1)
>>> len(M)
2
>>> M.reset()
>>> len(M)
0

Definition at line 6260 of file z3py.py.

6260 def reset(self):
6261 """Remove all entries from the map.
6262
6263 >>> M = AstMap()
6264 >>> x = Int('x')
6265 >>> M[x] = x + 1
6266 >>> M[x+x] = IntVal(1)
6267 >>> len(M)
6268 2
6269 >>> M.reset()
6270 >>> len(M)
6271 0
6272 """
6273 Z3_ast_map_reset(self.ctx.ref(), self.map)
6274
void Z3_API Z3_ast_map_reset(Z3_context c, Z3_ast_map m)
Remove all keys from the given map.

Field Documentation

◆ ctx

◆ map

map = None