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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6238 of file z3py.py.

6238 def __init__(self, m=None, ctx=None):
6239 self.map = None
6240 if m is None:
6241 self.ctx = _get_ctx(ctx)
6242 self.map = Z3_mk_ast_map(self.ctx.ref())
6243 else:
6244 self.map = m
6245 assert ctx is not None
6246 self.ctx = ctx
6247 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6248
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 6252 of file z3py.py.

6252 def __del__(self):
6253 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6254 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6255
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 6269 of file z3py.py.

6269 def __contains__(self, key):
6270 """Return `True` if the map contains key `key`.
6271
6272 >>> M = AstMap()
6273 >>> x = Int('x')
6274 >>> M[x] = x + 1
6275 >>> x in M
6276 True
6277 >>> x+1 in M
6278 False
6279 """
6280 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6281
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 6249 of file z3py.py.

6249 def __deepcopy__(self, memo={}):
6250 return AstMap(self.map, self.ctx)
6251

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

6282 def __getitem__(self, key):
6283 """Retrieve the value associated with key `key`.
6284
6285 >>> M = AstMap()
6286 >>> x = Int('x')
6287 >>> M[x] = x + 1
6288 >>> M[x]
6289 x + 1
6290 """
6291 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6292
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 6256 of file z3py.py.

6256 def __len__(self):
6257 """Return the size of the map.
6258
6259 >>> M = AstMap()
6260 >>> len(M)
6261 0
6262 >>> x = Int('x')
6263 >>> M[x] = IntVal(1)
6264 >>> len(M)
6265 1
6266 """
6267 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6268
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 6309 of file z3py.py.

6309 def __repr__(self):
6310 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6311
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 6293 of file z3py.py.

6293 def __setitem__(self, k, v):
6294 """Add/Update key `k` with value `v`.
6295
6296 >>> M = AstMap()
6297 >>> x = Int('x')
6298 >>> M[x] = x + 1
6299 >>> len(M)
6300 1
6301 >>> M[x]
6302 x + 1
6303 >>> M[x] = IntVal(1)
6304 >>> M[x]
6305 1
6306 """
6307 Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
6308
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 6312 of file z3py.py.

6312 def erase(self, k):
6313 """Remove the entry associated with key `k`.
6314
6315 >>> M = AstMap()
6316 >>> x = Int('x')
6317 >>> M[x] = x + 1
6318 >>> len(M)
6319 1
6320 >>> M.erase(x)
6321 >>> len(M)
6322 0
6323 """
6324 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6325
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 6341 of file z3py.py.

6341 def keys(self):
6342 """Return an AstVector containing all keys in the map.
6343
6344 >>> M = AstMap()
6345 >>> x = Int('x')
6346 >>> M[x] = x + 1
6347 >>> M[x+x] = IntVal(1)
6348 >>> M.keys()
6349 [x, x + x]
6350 """
6351 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6352
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 6326 of file z3py.py.

6326 def reset(self):
6327 """Remove all entries from the map.
6328
6329 >>> M = AstMap()
6330 >>> x = Int('x')
6331 >>> M[x] = x + 1
6332 >>> M[x+x] = IntVal(1)
6333 >>> len(M)
6334 2
6335 >>> M.reset()
6336 >>> len(M)
6337 0
6338 """
6339 Z3_ast_map_reset(self.ctx.ref(), self.map)
6340
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