Documentation

Lean.Data.KVMap

@[export lean_data_value_beq]
Equations
  • a.beqExp b = (a == b)
@[export lean_mk_bool_data_value]
Equations
@[export lean_data_value_bool]
Equations
structure Lean.KVMap :

A key-value map. We use it to represent user-selected options and Expr.mdata.

Remark: we do not use RBMap here because we need to manipulate KVMap objects in C++ and RBMap is implemented in Lean. So, we use just a List until we can generate C++ code from Lean code.

Instances For
Equations
Equations
Equations
Equations
  • { entries := m }.isEmpty = m.isEmpty
Equations
  • m.size = m.entries.length
Equations
Equations
  • m.findD k d₀ = (m.find k).getD d₀
Equations
Equations
Equations
  • m.contains n = (m.find n).isSome

Erase an entry from the map

Equations
Equations
def Lean.KVMap.getNat (m : Lean.KVMap) (k : Lake.Name) (defVal : optParam Nat 0) :
Equations
def Lean.KVMap.getInt (m : Lean.KVMap) (k : Lake.Name) (defVal : optParam Int 0) :
Equations
Equations
Equations
Equations
Equations
Equations
Equations
Equations
Equations
Equations

Update a String entry based on its current value.

Equations

Update a Nat entry based on its current value.

Equations

Update an Int entry based on its current value.

Equations

Update a Bool entry based on its current value.

Equations

Update a Name entry based on its current value.

Equations

Update a Syntax entry based on its current value.

Equations
@[inline]
def Lean.KVMap.forIn {δ : Type w} {m : Type w → Type w'} [Monad m] (kv : Lean.KVMap) (init : δ) (f : Lake.Name × Lean.DataValueδm (ForInStep δ)) :
m δ
Equations
  • kv.forIn init f = kv.entries.forIn init f
Equations
  • Lean.KVMap.instForInProdNameDataValue = { forIn := fun {β : Type ?u.14} [Monad m] => Lean.KVMap.forIn }
Equations
Equations
Equations
  • One or more equations did not get rendered due to their size.
def Lean.KVMap.eqv (m₁ : Lean.KVMap) (m₂ : Lean.KVMap) :
Equations
  • m₁.eqv m₂ = (m₁.subset m₂ && m₂.subset m₁)
@[inline]
Equations
  • m.get? k = (m.find k).bind Lean.KVMap.Value.ofDataValue?
@[inline]
def Lean.KVMap.get {α : Type} [Lean.KVMap.Value α] (m : Lean.KVMap) (k : Lake.Name) (defVal : α) :
α
Equations
  • m.get k defVal = (m.get? k).getD defVal
@[inline]
def Lean.KVMap.set {α : Type} [Lean.KVMap.Value α] (m : Lean.KVMap) (k : Lake.Name) (v : α) :
Equations
@[inline]
def Lean.KVMap.update {α : Type} [Lean.KVMap.Value α] (m : Lean.KVMap) (k : Lake.Name) (f : Option αOption α) :
Equations
  • m.update k f = match f (m.get? k) with | some a => m.set k a | none => m.erase k
Equations
Equations
Equations
Equations
Equations
Equations
  • One or more equations did not get rendered due to their size.
Equations
  • One or more equations did not get rendered due to their size.