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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6064 of file z3py.py.

6064 def __init__(self, m=None, ctx=None):
6065 self.map = None
6066 if m is None:
6067 self.ctx = _get_ctx(ctx)
6068 self.map = Z3_mk_ast_map(self.ctx.ref())
6069 else:
6070 self.map = m
6071 assert ctx is not None
6072 self.ctx = ctx
6073 Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
6074
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 6078 of file z3py.py.

6078 def __del__(self):
6079 if self.map is not None and self.ctx.ref() is not None and Z3_ast_map_dec_ref is not None:
6080 Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
6081
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 6095 of file z3py.py.

6095 def __contains__(self, key):
6096 """Return `True` if the map contains key `key`.
6097
6098 >>> M = AstMap()
6099 >>> x = Int('x')
6100 >>> M[x] = x + 1
6101 >>> x in M
6102 True
6103 >>> x+1 in M
6104 False
6105 """
6106 return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
6107
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 6075 of file z3py.py.

6075 def __deepcopy__(self, memo={}):
6076 return AstMap(self.map, self.ctx)
6077

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

6108 def __getitem__(self, key):
6109 """Retrieve the value associated with key `key`.
6110
6111 >>> M = AstMap()
6112 >>> x = Int('x')
6113 >>> M[x] = x + 1
6114 >>> M[x]
6115 x + 1
6116 """
6117 return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
6118
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 6082 of file z3py.py.

6082 def __len__(self):
6083 """Return the size of the map.
6084
6085 >>> M = AstMap()
6086 >>> len(M)
6087 0
6088 >>> x = Int('x')
6089 >>> M[x] = IntVal(1)
6090 >>> len(M)
6091 1
6092 """
6093 return int(Z3_ast_map_size(self.ctx.ref(), self.map))
6094
unsigned Z3_API Z3_ast_map_size(Z3_context c, Z3_ast_map m)
Return the size of the given map.

Referenced by AstVector.__getitem__(), and AstVector.__setitem__().

◆ __repr__()

__repr__ ( self)

Definition at line 6135 of file z3py.py.

6135 def __repr__(self):
6136 return Z3_ast_map_to_string(self.ctx.ref(), self.map)
6137
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 6119 of file z3py.py.

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

6138 def erase(self, k):
6139 """Remove the entry associated with key `k`.
6140
6141 >>> M = AstMap()
6142 >>> x = Int('x')
6143 >>> M[x] = x + 1
6144 >>> len(M)
6145 1
6146 >>> M.erase(x)
6147 >>> len(M)
6148 0
6149 """
6150 Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
6151
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 6167 of file z3py.py.

6167 def keys(self):
6168 """Return an AstVector containing all keys in the map.
6169
6170 >>> M = AstMap()
6171 >>> x = Int('x')
6172 >>> M[x] = x + 1
6173 >>> M[x+x] = IntVal(1)
6174 >>> M.keys()
6175 [x, x + x]
6176 """
6177 return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
6178
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 6152 of file z3py.py.

6152 def reset(self):
6153 """Remove all entries from the map.
6154
6155 >>> M = AstMap()
6156 >>> x = Int('x')
6157 >>> M[x] = x + 1
6158 >>> M[x+x] = IntVal(1)
6159 >>> len(M)
6160 2
6161 >>> M.reset()
6162 >>> len(M)
6163 0
6164 """
6165 Z3_ast_map_reset(self.ctx.ref(), self.map)
6166
void Z3_API Z3_ast_map_reset(Z3_context c, Z3_ast_map m)
Remove all keys from the given map.

Field Documentation

◆ ctx

ctx = _get_ctx(ctx)

Definition at line 6067 of file z3py.py.

Referenced by ArithRef.__add__(), BitVecRef.__add__(), BitVecRef.__and__(), FuncDeclRef.__call__(), AstMap.__contains__(), AstRef.__copy__(), AstVector.__copy__(), FuncInterp.__copy__(), Goal.__copy__(), ModelRef.__copy__(), AstMap.__deepcopy__(), AstRef.__deepcopy__(), AstVector.__deepcopy__(), Datatype.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), Goal.__deepcopy__(), ModelRef.__deepcopy__(), ParamDescrsRef.__deepcopy__(), ParamsRef.__deepcopy__(), Statistics.__deepcopy__(), AstMap.__del__(), AstRef.__del__(), AstVector.__del__(), Context.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), Goal.__del__(), ModelRef.__del__(), ParamDescrsRef.__del__(), ParamsRef.__del__(), ScopedConstructor.__del__(), ScopedConstructorList.__del__(), Solver.__del__(), Statistics.__del__(), ArithRef.__div__(), BitVecRef.__div__(), ExprRef.__eq__(), ArithRef.__ge__(), BitVecRef.__ge__(), AstMap.__getitem__(), AstVector.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ArithRef.__gt__(), BitVecRef.__gt__(), BitVecRef.__invert__(), ArithRef.__le__(), BitVecRef.__le__(), AstMap.__len__(), AstVector.__len__(), ModelRef.__len__(), Statistics.__len__(), BitVecRef.__lshift__(), ArithRef.__lt__(), BitVecRef.__lt__(), ArithRef.__mod__(), BitVecRef.__mod__(), ArithRef.__mul__(), BitVecRef.__mul__(), BoolRef.__mul__(), ExprRef.__ne__(), ArithRef.__neg__(), BitVecRef.__neg__(), BitVecRef.__or__(), ArithRef.__pow__(), ArithRef.__radd__(), BitVecRef.__radd__(), BitVecRef.__rand__(), ArithRef.__rdiv__(), BitVecRef.__rdiv__(), AstMap.__repr__(), ParamDescrsRef.__repr__(), ParamsRef.__repr__(), Statistics.__repr__(), BitVecRef.__rlshift__(), ArithRef.__rmod__(), BitVecRef.__rmod__(), ArithRef.__rmul__(), BitVecRef.__rmul__(), BitVecRef.__ror__(), ArithRef.__rpow__(), BitVecRef.__rrshift__(), BitVecRef.__rshift__(), ArithRef.__rsub__(), BitVecRef.__rsub__(), BitVecRef.__rxor__(), AstMap.__setitem__(), AstVector.__setitem__(), ArithRef.__sub__(), BitVecRef.__sub__(), BitVecRef.__xor__(), DatatypeSortRef.accessor(), ExprRef.arg(), FuncEntry.arg_value(), FuncInterp.arity(), Goal.as_expr(), Solver.assert_and_track(), Goal.assert_exprs(), Solver.assert_exprs(), QuantifierRef.body(), Solver.check(), Goal.convert_model(), AstRef.ctx_ref(), ExprRef.decl(), ModelRef.decls(), ArrayRef.default(), RatNumRef.denominator(), Goal.depth(), Goal.dimacs(), FuncDeclRef.domain(), ArraySortRef.domain_n(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), Goal.get(), ParamDescrsRef.get_documentation(), ModelRef.get_interp(), Statistics.get_key_value(), ParamDescrsRef.get_kind(), ParamDescrsRef.get_name(), ModelRef.get_sort(), ModelRef.get_universe(), Goal.inconsistent(), AstMap.keys(), Statistics.keys(), Solver.model(), SortRef.name(), QuantifierRef.no_pattern(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), FuncDeclRef.params(), QuantifierRef.pattern(), AlgebraicNumRef.poly(), Solver.pop(), Goal.prec(), AstVector.push(), Solver.push(), QuantifierRef.qid(), ArraySortRef.range(), FuncDeclRef.range(), DatatypeSortRef.recognizer(), Context.ref(), AstMap.reset(), Solver.reset(), AstVector.resize(), ParamsRef.set(), Solver.set(), AstVector.sexpr(), Goal.sexpr(), ModelRef.sexpr(), Goal.size(), ParamDescrsRef.size(), QuantifierRef.skolem_id(), AstRef.translate(), AstVector.translate(), Goal.translate(), ModelRef.translate(), ParamsRef.validate(), FuncEntry.value(), QuantifierRef.var_name(), and QuantifierRef.var_sort().

◆ map