Documentation

Lean.Data.KVMap

inductive Lean.DataValue :

Value stored in a key-value map.

Instances For
    @[implicit_reducible]
    @[implicit_reducible]
    @[implicit_reducible]
    @[export lean_data_value_beq]
    Instances For
      @[export lean_mk_bool_data_value]
      Instances For
        @[export lean_data_value_bool]
        Instances For
          @[export lean_data_value_to_string]
          Instances For
            @[implicit_reducible]
            @[implicit_reducible]
            @[implicit_reducible]
            @[implicit_reducible]
            @[implicit_reducible]
            @[implicit_reducible]
            @[implicit_reducible]
            structure Lean.KVMap :

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

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

            Instances For
              @[implicit_reducible]
              Instances For
                @[implicit_reducible]
                @[implicit_reducible]
                Instances For
                  Instances For
                    Instances For
                      Instances For
                        def Lean.KVMap.findD (m : KVMap) (k : Name) (d₀ : DataValue) :
                        Instances For
                          Instances For
                            Instances For

                              Erase an entry from the map

                              Instances For
                                def Lean.KVMap.getString (m : KVMap) (k : Name) (defVal : String := "") :
                                Instances For
                                  def Lean.KVMap.getNat (m : KVMap) (k : Name) (defVal : Nat := 0) :
                                  Instances For
                                    def Lean.KVMap.getInt (m : KVMap) (k : Name) (defVal : Int := 0) :
                                    Instances For
                                      def Lean.KVMap.getBool (m : KVMap) (k : Name) (defVal : Bool := false) :
                                      Instances For
                                        def Lean.KVMap.getName (m : KVMap) (k : Name) (defVal : Name := Name.anonymous) :
                                        Instances For
                                          Instances For
                                            def Lean.KVMap.setString (m : KVMap) (k : Name) (v : String) :
                                            Instances For
                                              def Lean.KVMap.setNat (m : KVMap) (k : Name) (v : Nat) :
                                              Instances For
                                                def Lean.KVMap.setInt (m : KVMap) (k : Name) (v : Int) :
                                                Instances For
                                                  def Lean.KVMap.setBool (m : KVMap) (k : Name) (v : Bool) :
                                                  Instances For
                                                    def Lean.KVMap.setName (m : KVMap) (k v : Name) :
                                                    Instances For
                                                      def Lean.KVMap.setSyntax (m : KVMap) (k : Name) (v : Syntax) :
                                                      Instances For

                                                        Update a String entry based on its current value.

                                                        Instances For
                                                          def Lean.KVMap.updateNat (m : KVMap) (k : Name) (f : NatNat) :

                                                          Update a Nat entry based on its current value.

                                                          Instances For
                                                            def Lean.KVMap.updateInt (m : KVMap) (k : Name) (f : IntInt) :

                                                            Update an Int entry based on its current value.

                                                            Instances For
                                                              def Lean.KVMap.updateBool (m : KVMap) (k : Name) (f : BoolBool) :

                                                              Update a Bool entry based on its current value.

                                                              Instances For
                                                                def Lean.KVMap.updateName (m : KVMap) (k : Name) (f : NameName) :

                                                                Update a Name entry based on its current value.

                                                                Instances For

                                                                  Update a Syntax entry based on its current value.

                                                                  Instances For
                                                                    @[inline]
                                                                    def Lean.KVMap.forIn {δ : Type w} {m : Type w → Type w'} [Monad m] (kv : KVMap) (init : δ) (f : Name × DataValueδm (ForInStep δ)) :
                                                                    m δ
                                                                    Instances For
                                                                      @[implicit_reducible]
                                                                      Instances For
                                                                        def Lean.KVMap.mergeBy (mergeFn : NameDataValueDataValueDataValue) (l r : KVMap) :
                                                                        Instances For
                                                                          def Lean.KVMap.eqv (m₁ m₂ : KVMap) :
                                                                          Instances For
                                                                            @[implicit_reducible]
                                                                            class Lean.KVMap.Value (α : Type) :
                                                                            Instances
                                                                              @[inline]
                                                                              def Lean.KVMap.get? {α : Type} [Value α] (m : KVMap) (k : Name) :
                                                                              Instances For
                                                                                @[inline]
                                                                                def Lean.KVMap.get {α : Type} [Value α] (m : KVMap) (k : Name) (defVal : α) :
                                                                                α
                                                                                Instances For
                                                                                  @[inline]
                                                                                  def Lean.KVMap.set {α : Type} [Value α] (m : KVMap) (k : Name) (v : α) :
                                                                                  Instances For
                                                                                    @[inline]
                                                                                    def Lean.KVMap.update {α : Type} [Value α] (m : KVMap) (k : Name) (f : Option αOption α) :
                                                                                    Instances For
                                                                                      @[implicit_reducible]
                                                                                      @[implicit_reducible]
                                                                                      @[implicit_reducible]
                                                                                      @[implicit_reducible]
                                                                                      @[implicit_reducible]
                                                                                      @[implicit_reducible]
                                                                                      @[implicit_reducible]