Z3
Public Member Functions | Data Fields
AstMap Class Reference

Public Member Functions

def __init__ (self, m=None, ctx=None)
 
def __deepcopy__ (self, memo={})
 
def __del__ (self)
 
def __len__ (self)
 
def __contains__ (self, key)
 
def __getitem__ (self, key)
 
def __setitem__ (self, k, v)
 
def __repr__ (self)
 
def erase (self, k)
 
def reset (self)
 
def keys (self)
 

Data Fields

 map
 
 ctx
 

Detailed Description

A mapping from ASTs to ASTs.

Definition at line 5271 of file z3py.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 5274 of file z3py.py.

5274  def __init__(self, m=None, ctx=None):
5275  self.map = None
5276  if m is None:
5277  self.ctx = _get_ctx(ctx)
5278  self.map = Z3_mk_ast_map(self.ctx.ref())
5279  else:
5280  self.map = m
5281  assert ctx is not None
5282  self.ctx = ctx
5283  Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
5284 
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__()

def __del__ (   self)

Definition at line 5288 of file z3py.py.

5288  def __del__(self):
5289  if self.map is not None and self.ctx.ref() is not None:
5290  Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
5291 
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__()

def __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 5305 of file z3py.py.

5305  def __contains__(self, key):
5306  """Return `True` if the map contains key `key`.
5307 
5308  >>> M = AstMap()
5309  >>> x = Int('x')
5310  >>> M[x] = x + 1
5311  >>> x in M
5312  True
5313  >>> x+1 in M
5314  False
5315  """
5316  return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
5317 
Z3_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__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 5285 of file z3py.py.

5285  def __deepcopy__(self, memo={}):
5286  return AstMap(self.map, self.ctx)
5287 

◆ __getitem__()

def __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 5318 of file z3py.py.

5318  def __getitem__(self, key):
5319  """Retrieve the value associated with key `key`.
5320 
5321  >>> M = AstMap()
5322  >>> x = Int('x')
5323  >>> M[x] = x + 1
5324  >>> M[x]
5325  x + 1
5326  """
5327  return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
5328 
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__()

def __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 5292 of file z3py.py.

5292  def __len__(self):
5293  """Return the size of the map.
5294 
5295  >>> M = AstMap()
5296  >>> len(M)
5297  0
5298  >>> x = Int('x')
5299  >>> M[x] = IntVal(1)
5300  >>> len(M)
5301  1
5302  """
5303  return int(Z3_ast_map_size(self.ctx.ref(), self.map))
5304 
unsigned Z3_API Z3_ast_map_size(Z3_context c, Z3_ast_map m)
Return the size of the given map.

◆ __repr__()

def __repr__ (   self)

Definition at line 5345 of file z3py.py.

5345  def __repr__(self):
5346  return Z3_ast_map_to_string(self.ctx.ref(), self.map)
5347 
Z3_string Z3_API Z3_ast_map_to_string(Z3_context c, Z3_ast_map m)
Convert the given map into a string.

◆ __setitem__()

def __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 5329 of file z3py.py.

5329  def __setitem__(self, k, v):
5330  """Add/Update key `k` with value `v`.
5331 
5332  >>> M = AstMap()
5333  >>> x = Int('x')
5334  >>> M[x] = x + 1
5335  >>> len(M)
5336  1
5337  >>> M[x]
5338  x + 1
5339  >>> M[x] = IntVal(1)
5340  >>> M[x]
5341  1
5342  """
5343  Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
5344 
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()

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

5348  def erase(self, k):
5349  """Remove the entry associated with key `k`.
5350 
5351  >>> M = AstMap()
5352  >>> x = Int('x')
5353  >>> M[x] = x + 1
5354  >>> len(M)
5355  1
5356  >>> M.erase(x)
5357  >>> len(M)
5358  0
5359  """
5360  Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
5361 
void Z3_API Z3_ast_map_erase(Z3_context c, Z3_ast_map m, Z3_ast k)
Erase a key from the map.

◆ keys()

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

5377  def keys(self):
5378  """Return an AstVector containing all keys in the map.
5379 
5380  >>> M = AstMap()
5381  >>> x = Int('x')
5382  >>> M[x] = x + 1
5383  >>> M[x+x] = IntVal(1)
5384  >>> M.keys()
5385  [x, x + x]
5386  """
5387  return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
5388 
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()

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

5362  def reset(self):
5363  """Remove all entries from the map.
5364 
5365  >>> M = AstMap()
5366  >>> x = Int('x')
5367  >>> M[x] = x + 1
5368  >>> M[x+x] = IntVal(1)
5369  >>> len(M)
5370  2
5371  >>> M.reset()
5372  >>> len(M)
5373  0
5374  """
5375  Z3_ast_map_reset(self.ctx.ref(), self.map)
5376 
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

Definition at line 5277 of file z3py.py.

Referenced by Probe.__call__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), Probe.__eq__(), Probe.__ge__(), ApplyResult.__getitem__(), Probe.__gt__(), Probe.__le__(), ApplyResult.__len__(), Probe.__lt__(), Probe.__ne__(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), ApplyResult.as_expr(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Optimize.assertions(), Optimize.check(), ApplyResult.convert_model(), Optimize.from_file(), Optimize.from_string(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), Fixedpoint.get_ground_sat_answer(), Fixedpoint.get_num_levels(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), Fixedpoint.help(), Optimize.help(), Tactic.help(), Optimize.maximize(), Optimize.minimize(), Optimize.model(), Optimize.objectives(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), Fixedpoint.pop(), Optimize.pop(), Fixedpoint.push(), Optimize.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), Fixedpoint.register_relation(), Fixedpoint.set(), Optimize.set(), Fixedpoint.set_predicate_representation(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), Tactic.solver(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), and Fixedpoint.update_rule().

◆ map

map

Definition at line 5275 of file z3py.py.