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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6640 of file z3py.py.

6640 def __init__(self, m=None, ctx=None):
6641 self.map = None
6642 if m is None:
6643 self.ctx = _get_ctx(ctx)
6644 self.map = Z3_mk_ast_map(self.ctx.ref())
6645 else:
6646 self.map = m
6647 assert ctx is not None
6648 self.ctx = ctx
6649 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6650
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 6654 of file z3py.py.

6654 def __del__(self):
6655 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6656 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6657
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 6671 of file z3py.py.

6671 def __contains__(self, key):
6672 """Return `True` if the map contains key `key`.
6673
6674 >>> M = AstMap()
6675 >>> x = Int('x')
6676 >>> M[x] = x + 1
6677 >>> x in M
6678 True
6679 >>> x+1 in M
6680 False
6681 """
6682 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6683
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 6651 of file z3py.py.

6651 def __deepcopy__(self, memo={}):
6652 return AstMap(self.map, self.ctx)
6653

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

6684 def __getitem__(self, key):
6685 """Retrieve the value associated with key `key`.
6686
6687 >>> M = AstMap()
6688 >>> x = Int('x')
6689 >>> M[x] = x + 1
6690 >>> M[x]
6691 x + 1
6692 """
6693 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6694
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 6658 of file z3py.py.

6658 def __len__(self):
6659 """Return the size of the map.
6660
6661 >>> M = AstMap()
6662 >>> len(M)
6663 0
6664 >>> x = Int('x')
6665 >>> M[x] = IntVal(1)
6666 >>> len(M)
6667 1
6668 """
6669 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6670
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 6711 of file z3py.py.

6711 def __repr__(self):
6712 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6713
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 6695 of file z3py.py.

6695 def __setitem__(self, k, v):
6696 """Add/Update key `k` with value `v`.
6697
6698 >>> M = AstMap()
6699 >>> x = Int('x')
6700 >>> M[x] = x + 1
6701 >>> len(M)
6702 1
6703 >>> M[x]
6704 x + 1
6705 >>> M[x] = IntVal(1)
6706 >>> M[x]
6707 1
6708 """
6709 Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
6710
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 6714 of file z3py.py.

6714 def erase(self, k):
6715 """Remove the entry associated with key `k`.
6716
6717 >>> M = AstMap()
6718 >>> x = Int('x')
6719 >>> M[x] = x + 1
6720 >>> len(M)
6721 1
6722 >>> M.erase(x)
6723 >>> len(M)
6724 0
6725 """
6726 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6727
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 6743 of file z3py.py.

6743 def keys(self):
6744 """Return an AstVector containing all keys in the map.
6745
6746 >>> M = AstMap()
6747 >>> x = Int('x')
6748 >>> M[x] = x + 1
6749 >>> M[x+x] = IntVal(1)
6750 >>> M.keys()
6751 [x + x, x]
6752 """
6753 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6754
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 6728 of file z3py.py.

6728 def reset(self):
6729 """Remove all entries from the map.
6730
6731 >>> M = AstMap()
6732 >>> x = Int('x')
6733 >>> M[x] = x + 1
6734 >>> M[x+x] = IntVal(1)
6735 >>> len(M)
6736 2
6737 >>> M.reset()
6738 >>> len(M)
6739 0
6740 """
6741 Z3_ast_map_reset(self.ctx.ref(), self.map)
6742
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