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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6071 of file z3py.py.

6071 def __init__(self, m=None, ctx=None):
6072 self.map = None
6073 if m is None:
6074 self.ctx = _get_ctx(ctx)
6075 self.map = Z3_mk_ast_map(self.ctx.ref())
6076 else:
6077 self.map = m
6078 assert ctx is not None
6079 self.ctx = ctx
6080 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6081
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 6085 of file z3py.py.

6085 def __del__(self):
6086 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6087 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6088
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 6102 of file z3py.py.

6102 def __contains__(self, key):
6103 """Return `True` if the map contains key `key`.
6104
6105 >>> M = AstMap()
6106 >>> x = Int('x')
6107 >>> M[x] = x + 1
6108 >>> x in M
6109 True
6110 >>> x+1 in M
6111 False
6112 """
6113 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6114
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 6082 of file z3py.py.

6082 def __deepcopy__(self, memo={}):
6083 return AstMap(self.map, self.ctx)
6084

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

6115 def __getitem__(self, key):
6116 """Retrieve the value associated with key `key`.
6117
6118 >>> M = AstMap()
6119 >>> x = Int('x')
6120 >>> M[x] = x + 1
6121 >>> M[x]
6122 x + 1
6123 """
6124 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6125
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 6089 of file z3py.py.

6089 def __len__(self):
6090 """Return the size of the map.
6091
6092 >>> M = AstMap()
6093 >>> len(M)
6094 0
6095 >>> x = Int('x')
6096 >>> M[x] = IntVal(1)
6097 >>> len(M)
6098 1
6099 """
6100 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6101
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 6142 of file z3py.py.

6142 def __repr__(self):
6143 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6144
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 6126 of file z3py.py.

6126 def __setitem__(self, k, v):
6127 """Add/Update key `k` with value `v`.
6128
6129 >>> M = AstMap()
6130 >>> x = Int('x')
6131 >>> M[x] = x + 1
6132 >>> len(M)
6133 1
6134 >>> M[x]
6135 x + 1
6136 >>> M[x] = IntVal(1)
6137 >>> M[x]
6138 1
6139 """
6140 Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
6141
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 6145 of file z3py.py.

6145 def erase(self, k):
6146 """Remove the entry associated with key `k`.
6147
6148 >>> M = AstMap()
6149 >>> x = Int('x')
6150 >>> M[x] = x + 1
6151 >>> len(M)
6152 1
6153 >>> M.erase(x)
6154 >>> len(M)
6155 0
6156 """
6157 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6158
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 6174 of file z3py.py.

6174 def keys(self):
6175 """Return an AstVector containing all keys in the map.
6176
6177 >>> M = AstMap()
6178 >>> x = Int('x')
6179 >>> M[x] = x + 1
6180 >>> M[x+x] = IntVal(1)
6181 >>> M.keys()
6182 [x, x + x]
6183 """
6184 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6185
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 6159 of file z3py.py.

6159 def reset(self):
6160 """Remove all entries from the map.
6161
6162 >>> M = AstMap()
6163 >>> x = Int('x')
6164 >>> M[x] = x + 1
6165 >>> M[x+x] = IntVal(1)
6166 >>> len(M)
6167 2
6168 >>> M.reset()
6169 >>> len(M)
6170 0
6171 """
6172 Z3_ast_map_reset(self.ctx.ref(), self.map)
6173
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