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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 5591 of file z3py.py.

5591  def __init__(self, m=None, ctx=None):
5592  self.map = None
5593  if m is None:
5594  self.ctx = _get_ctx(ctx)
5595  self.map = Z3_mk_ast_map(self.ctx.ref())
5596  else:
5597  self.map = m
5598  assert ctx is not None
5599  self.ctx = ctx
5600  Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
5601 
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 5605 of file z3py.py.

5605  def __del__(self):
5606  if self.map is not None and self.ctx.ref() is not None:
5607  Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
5608 
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 5622 of file z3py.py.

5622  def __contains__(self, key):
5623  """Return `True` if the map contains key `key`.
5624 
5625  >>> M = AstMap()
5626  >>> x = Int('x')
5627  >>> M[x] = x + 1
5628  >>> x in M
5629  True
5630  >>> x+1 in M
5631  False
5632  """
5633  return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
5634 
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 5602 of file z3py.py.

5602  def __deepcopy__(self, memo={}):
5603  return AstMap(self.map, self.ctx)
5604 

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

5635  def __getitem__(self, key):
5636  """Retrieve the value associated with key `key`.
5637 
5638  >>> M = AstMap()
5639  >>> x = Int('x')
5640  >>> M[x] = x + 1
5641  >>> M[x]
5642  x + 1
5643  """
5644  return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
5645 
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 5609 of file z3py.py.

5609  def __len__(self):
5610  """Return the size of the map.
5611 
5612  >>> M = AstMap()
5613  >>> len(M)
5614  0
5615  >>> x = Int('x')
5616  >>> M[x] = IntVal(1)
5617  >>> len(M)
5618  1
5619  """
5620  return int(Z3_ast_map_size(self.ctx.ref(), self.map))
5621 
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 5662 of file z3py.py.

5662  def __repr__(self):
5663  return Z3_ast_map_to_string(self.ctx.ref(), self.map)
5664 
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 5646 of file z3py.py.

5646  def __setitem__(self, k, v):
5647  """Add/Update key `k` with value `v`.
5648 
5649  >>> M = AstMap()
5650  >>> x = Int('x')
5651  >>> M[x] = x + 1
5652  >>> len(M)
5653  1
5654  >>> M[x]
5655  x + 1
5656  >>> M[x] = IntVal(1)
5657  >>> M[x]
5658  1
5659  """
5660  Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
5661 
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 5665 of file z3py.py.

5665  def erase(self, k):
5666  """Remove the entry associated with key `k`.
5667 
5668  >>> M = AstMap()
5669  >>> x = Int('x')
5670  >>> M[x] = x + 1
5671  >>> len(M)
5672  1
5673  >>> M.erase(x)
5674  >>> len(M)
5675  0
5676  """
5677  Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
5678 
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 5694 of file z3py.py.

5694  def keys(self):
5695  """Return an AstVector containing all keys in the map.
5696 
5697  >>> M = AstMap()
5698  >>> x = Int('x')
5699  >>> M[x] = x + 1
5700  >>> M[x+x] = IntVal(1)
5701  >>> M.keys()
5702  [x, x + x]
5703  """
5704  return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
5705 
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 5679 of file z3py.py.

5679  def reset(self):
5680  """Remove all entries from the map.
5681 
5682  >>> M = AstMap()
5683  >>> x = Int('x')
5684  >>> M[x] = x + 1
5685  >>> M[x+x] = IntVal(1)
5686  >>> len(M)
5687  2
5688  >>> M.reset()
5689  >>> len(M)
5690  0
5691  """
5692  Z3_ast_map_reset(self.ctx.ref(), self.map)
5693 
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 5594 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(), Optimize.assert_and_track(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Optimize.assertions(), Optimize.check(), 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(), Optimize.pop(), 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(), Optimize.unsat_core(), and Fixedpoint.update_rule().

◆ map

map

Definition at line 5592 of file z3py.py.