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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 5652 of file z3py.py.

5652  def __init__(self, m=None, ctx=None):
5653  self.map = None
5654  if m is None:
5655  self.ctx = _get_ctx(ctx)
5656  self.map = Z3_mk_ast_map(self.ctx.ref())
5657  else:
5658  self.map = m
5659  assert ctx is not None
5660  self.ctx = ctx
5661  Z3_ast_map_inc_ref(self.ctx.ref(), self.map)
5662 

◆ __del__()

def __del__ (   self)

Definition at line 5666 of file z3py.py.

5666  def __del__(self):
5667  if self.map is not None and self.ctx.ref() is not None:
5668  Z3_ast_map_dec_ref(self.ctx.ref(), self.map)
5669 

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

5683  def __contains__(self, key):
5684  """Return `True` if the map contains key `key`.
5685 
5686  >>> M = AstMap()
5687  >>> x = Int('x')
5688  >>> M[x] = x + 1
5689  >>> x in M
5690  True
5691  >>> x+1 in M
5692  False
5693  """
5694  return Z3_ast_map_contains(self.ctx.ref(), self.map, key.as_ast())
5695 

◆ __deepcopy__()

def __deepcopy__ (   self,
  memo = {} 
)

Definition at line 5663 of file z3py.py.

5663  def __deepcopy__(self, memo={}):
5664  return AstMap(self.map, self.ctx)
5665 

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

5696  def __getitem__(self, key):
5697  """Retrieve the value associated with key `key`.
5698 
5699  >>> M = AstMap()
5700  >>> x = Int('x')
5701  >>> M[x] = x + 1
5702  >>> M[x]
5703  x + 1
5704  """
5705  return _to_ast_ref(Z3_ast_map_find(self.ctx.ref(), self.map, key.as_ast()), self.ctx)
5706 

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

5670  def __len__(self):
5671  """Return the size of the map.
5672 
5673  >>> M = AstMap()
5674  >>> len(M)
5675  0
5676  >>> x = Int('x')
5677  >>> M[x] = IntVal(1)
5678  >>> len(M)
5679  1
5680  """
5681  return int(Z3_ast_map_size(self.ctx.ref(), self.map))
5682 

◆ __repr__()

def __repr__ (   self)

Definition at line 5723 of file z3py.py.

5723  def __repr__(self):
5724  return Z3_ast_map_to_string(self.ctx.ref(), self.map)
5725 

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

5707  def __setitem__(self, k, v):
5708  """Add/Update key `k` with value `v`.
5709 
5710  >>> M = AstMap()
5711  >>> x = Int('x')
5712  >>> M[x] = x + 1
5713  >>> len(M)
5714  1
5715  >>> M[x]
5716  x + 1
5717  >>> M[x] = IntVal(1)
5718  >>> M[x]
5719  1
5720  """
5721  Z3_ast_map_insert(self.ctx.ref(), self.map, k.as_ast(), v.as_ast())
5722 

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

5726  def erase(self, k):
5727  """Remove the entry associated with key `k`.
5728 
5729  >>> M = AstMap()
5730  >>> x = Int('x')
5731  >>> M[x] = x + 1
5732  >>> len(M)
5733  1
5734  >>> M.erase(x)
5735  >>> len(M)
5736  0
5737  """
5738  Z3_ast_map_erase(self.ctx.ref(), self.map, k.as_ast())
5739 

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

5755  def keys(self):
5756  """Return an AstVector containing all keys in the map.
5757 
5758  >>> M = AstMap()
5759  >>> x = Int('x')
5760  >>> M[x] = x + 1
5761  >>> M[x+x] = IntVal(1)
5762  >>> M.keys()
5763  [x, x + x]
5764  """
5765  return AstVector(Z3_ast_map_keys(self.ctx.ref(), self.map), self.ctx)
5766 

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

5740  def reset(self):
5741  """Remove all entries from the map.
5742 
5743  >>> M = AstMap()
5744  >>> x = Int('x')
5745  >>> M[x] = x + 1
5746  >>> M[x+x] = IntVal(1)
5747  >>> len(M)
5748  2
5749  >>> M.reset()
5750  >>> len(M)
5751  0
5752  """
5753  Z3_ast_map_reset(self.ctx.ref(), self.map)
5754 

Field Documentation

◆ ctx

ctx

Definition at line 5655 of file z3py.py.

Referenced by Probe.__call__(), AstMap.__contains__(), FuncInterp.__copy__(), ModelRef.__copy__(), Solver.__copy__(), AstMap.__deepcopy__(), FuncEntry.__deepcopy__(), FuncInterp.__deepcopy__(), ModelRef.__deepcopy__(), Statistics.__deepcopy__(), Solver.__deepcopy__(), Fixedpoint.__deepcopy__(), Optimize.__deepcopy__(), ApplyResult.__deepcopy__(), Tactic.__deepcopy__(), Probe.__deepcopy__(), AstMap.__del__(), FuncEntry.__del__(), FuncInterp.__del__(), ModelRef.__del__(), Statistics.__del__(), Solver.__del__(), Fixedpoint.__del__(), Optimize.__del__(), ApplyResult.__del__(), Tactic.__del__(), Probe.__del__(), Probe.__eq__(), Probe.__ge__(), AstMap.__getitem__(), ModelRef.__getitem__(), Statistics.__getitem__(), ApplyResult.__getitem__(), Probe.__gt__(), Probe.__le__(), AstMap.__len__(), ModelRef.__len__(), Statistics.__len__(), ApplyResult.__len__(), Probe.__lt__(), Probe.__ne__(), AstMap.__repr__(), Statistics.__repr__(), AstMap.__setitem__(), Fixedpoint.add_cover(), Fixedpoint.add_rule(), Optimize.add_soft(), Tactic.apply(), FuncEntry.arg_value(), FuncInterp.arity(), ApplyResult.as_expr(), Solver.assert_and_track(), Optimize.assert_and_track(), Solver.assert_exprs(), Fixedpoint.assert_exprs(), Optimize.assert_exprs(), Solver.assertions(), Optimize.assertions(), Solver.check(), Optimize.check(), UserPropagateBase.conflict(), Solver.consequences(), UserPropagateBase.ctx_ref(), ModelRef.decls(), Solver.dimacs(), FuncInterp.else_value(), FuncInterp.entry(), AstMap.erase(), ModelRef.eval(), Solver.from_file(), Optimize.from_file(), Solver.from_string(), Optimize.from_string(), Fixedpoint.get_answer(), Fixedpoint.get_assertions(), Fixedpoint.get_cover_delta(), Fixedpoint.get_ground_sat_answer(), ModelRef.get_interp(), Statistics.get_key_value(), Fixedpoint.get_num_levels(), Fixedpoint.get_rule_names_along_trace(), Fixedpoint.get_rules(), Fixedpoint.get_rules_along_trace(), ModelRef.get_sort(), ModelRef.get_universe(), Solver.help(), Fixedpoint.help(), Optimize.help(), Tactic.help(), Solver.import_model_converter(), AstMap.keys(), Statistics.keys(), Optimize.maximize(), Optimize.minimize(), Solver.model(), Optimize.model(), Solver.non_units(), FuncEntry.num_args(), FuncInterp.num_entries(), Solver.num_scopes(), ModelRef.num_sorts(), Optimize.objectives(), Solver.param_descrs(), Fixedpoint.param_descrs(), Optimize.param_descrs(), Tactic.param_descrs(), Fixedpoint.parse_file(), Fixedpoint.parse_string(), Solver.pop(), Optimize.pop(), Solver.proof(), Solver.push(), Optimize.push(), Fixedpoint.query(), Fixedpoint.query_from_lvl(), Solver.reason_unknown(), Fixedpoint.reason_unknown(), Optimize.reason_unknown(), Fixedpoint.register_relation(), AstMap.reset(), Solver.reset(), Solver.set(), Fixedpoint.set(), Optimize.set(), Fixedpoint.set_predicate_representation(), ModelRef.sexpr(), Solver.sexpr(), Fixedpoint.sexpr(), Optimize.sexpr(), ApplyResult.sexpr(), Tactic.solver(), Solver.statistics(), Fixedpoint.statistics(), Optimize.statistics(), Solver.to_smt2(), Fixedpoint.to_string(), Solver.trail(), Solver.trail_levels(), FuncInterp.translate(), ModelRef.translate(), Solver.translate(), Solver.units(), Solver.unsat_core(), Optimize.unsat_core(), Fixedpoint.update_rule(), and FuncEntry.value().

◆ map

map
z3py.UserPropagateBase.__init__
def __init__(self, s, ctx=None)
Definition: z3py.py:10582
Z3_ast_map_keys
Z3_ast_vector Z3_API Z3_ast_map_keys(Z3_context c, Z3_ast_map m)
Return the keys stored in the given map.
Z3_ast_map_size
unsigned Z3_API Z3_ast_map_size(Z3_context c, Z3_ast_map m)
Return the size of the given map.
Z3_ast_map_dec_ref
void Z3_API Z3_ast_map_dec_ref(Z3_context c, Z3_ast_map m)
Decrement the reference counter of the given AST map.
Z3_ast_map_insert
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.
Z3_ast_map_inc_ref
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_reset
void Z3_API Z3_ast_map_reset(Z3_context c, Z3_ast_map m)
Remove all keys from the given map.
z3py.UserPropagateBase.__del__
def __del__(self)
Definition: z3py.py:10607
Z3_ast_map_contains
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.
Z3_ast_map_find
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.
Z3_ast_map_erase
void Z3_API Z3_ast_map_erase(Z3_context c, Z3_ast_map m, Z3_ast k)
Erase a key from the map.
Z3_ast_map_to_string
Z3_string Z3_API Z3_ast_map_to_string(Z3_context c, Z3_ast_map m)
Convert the given map into a string.
Z3_mk_ast_map
Z3_ast_map Z3_API Z3_mk_ast_map(Z3_context c)
Return an empty mapping from AST to AST.