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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6634 of file z3py.py.

6634 def __init__(self, m=None, ctx=None):
6635 self.map = None
6636 if m is None:
6637 self.ctx = _get_ctx(ctx)
6638 self.map = Z3_mk_ast_map(self.ctx.ref())
6639 else:
6640 self.map = m
6641 assert ctx is not None
6642 self.ctx = ctx
6643 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6644
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 6648 of file z3py.py.

6648 def __del__(self):
6649 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6650 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6651
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 6665 of file z3py.py.

6665 def __contains__(self, key):
6666 """Return `True` if the map contains key `key`.
6667
6668 >>> M = AstMap()
6669 >>> x = Int('x')
6670 >>> M[x] = x + 1
6671 >>> x in M
6672 True
6673 >>> x+1 in M
6674 False
6675 """
6676 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6677
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 6645 of file z3py.py.

6645 def __deepcopy__(self, memo={}):
6646 return AstMap(self.map, self.ctx)
6647

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

6678 def __getitem__(self, key):
6679 """Retrieve the value associated with key `key`.
6680
6681 >>> M = AstMap()
6682 >>> x = Int('x')
6683 >>> M[x] = x + 1
6684 >>> M[x]
6685 x + 1
6686 """
6687 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6688
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 6652 of file z3py.py.

6652 def __len__(self):
6653 """Return the size of the map.
6654
6655 >>> M = AstMap()
6656 >>> len(M)
6657 0
6658 >>> x = Int('x')
6659 >>> M[x] = IntVal(1)
6660 >>> len(M)
6661 1
6662 """
6663 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6664
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 6705 of file z3py.py.

6705 def __repr__(self):
6706 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6707
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 6689 of file z3py.py.

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

6708 def erase(self, k):
6709 """Remove the entry associated with key `k`.
6710
6711 >>> M = AstMap()
6712 >>> x = Int('x')
6713 >>> M[x] = x + 1
6714 >>> len(M)
6715 1
6716 >>> M.erase(x)
6717 >>> len(M)
6718 0
6719 """
6720 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6721
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 6737 of file z3py.py.

6737 def keys(self):
6738 """Return an AstVector containing all keys in the map.
6739
6740 >>> M = AstMap()
6741 >>> x = Int('x')
6742 >>> M[x] = x + 1
6743 >>> M[x+x] = IntVal(1)
6744 >>> M.keys()
6745 [x + x, x]
6746 """
6747 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6748
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 6722 of file z3py.py.

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