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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6232 of file z3py.py.

6232 def __init__(self, m=None, ctx=None):
6233 self.map = None
6234 if m is None:
6235 self.ctx = _get_ctx(ctx)
6236 self.map = Z3_mk_ast_map(self.ctx.ref())
6237 else:
6238 self.map = m
6239 assert ctx is not None
6240 self.ctx = ctx
6241 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6242
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 6246 of file z3py.py.

6246 def __del__(self):
6247 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6248 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6249
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 6263 of file z3py.py.

6263 def __contains__(self, key):
6264 """Return `True` if the map contains key `key`.
6265
6266 >>> M = AstMap()
6267 >>> x = Int('x')
6268 >>> M[x] = x + 1
6269 >>> x in M
6270 True
6271 >>> x+1 in M
6272 False
6273 """
6274 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6275
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 6243 of file z3py.py.

6243 def __deepcopy__(self, memo={}):
6244 return AstMap(self.map, self.ctx)
6245

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

6276 def __getitem__(self, key):
6277 """Retrieve the value associated with key `key`.
6278
6279 >>> M = AstMap()
6280 >>> x = Int('x')
6281 >>> M[x] = x + 1
6282 >>> M[x]
6283 x + 1
6284 """
6285 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6286
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 6250 of file z3py.py.

6250 def __len__(self):
6251 """Return the size of the map.
6252
6253 >>> M = AstMap()
6254 >>> len(M)
6255 0
6256 >>> x = Int('x')
6257 >>> M[x] = IntVal(1)
6258 >>> len(M)
6259 1
6260 """
6261 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6262
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 6303 of file z3py.py.

6303 def __repr__(self):
6304 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6305
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 6287 of file z3py.py.

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

6306 def erase(self, k):
6307 """Remove the entry associated with key `k`.
6308
6309 >>> M = AstMap()
6310 >>> x = Int('x')
6311 >>> M[x] = x + 1
6312 >>> len(M)
6313 1
6314 >>> M.erase(x)
6315 >>> len(M)
6316 0
6317 """
6318 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6319
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 6335 of file z3py.py.

6335 def keys(self):
6336 """Return an AstVector containing all keys in the map.
6337
6338 >>> M = AstMap()
6339 >>> x = Int('x')
6340 >>> M[x] = x + 1
6341 >>> M[x+x] = IntVal(1)
6342 >>> M.keys()
6343 [x, x + x]
6344 """
6345 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6346
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 6320 of file z3py.py.

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