def Lean.Meta.GetEqnsFn : Type

Equations

• Lean.Meta.GetEqnsFn = (Lean.Name → Lean.MetaM (Option (Array Lean.Name)))

def Lean.Meta.registerGetEqnsFn (f : Lean.Meta.GetEqnsFn) : IO Unit

Register a new function for retrieving equation theorems. We generate equations theorems on demand, and they are generated by more than one module. For example, the structural and well-founded recursion modules generate them. Most recent getters are tried first.

A getter returns an Option (Array Name). The result is none if the getter failed. Otherwise, it is a sequence of theorem names where each one of them corresponds to an alternative. Example: the definition

def f (xs : List Nat) : List Nat :=
  match xs with
  | [] => []
  | x::xs => (x+1)::f xs

should have two equational theorems associated with it

f [] = []

and

(x : Nat) → (xs : List Nat) → f (x :: xs) = (x+1) :: f xs

Equations

• One or more equations did not get rendered due to their size.

structure Lean.Meta.EqnsExtState : Type

• map : Lean.PHashMap Lean.Name (Array Lean.Name)

instance Lean.Meta.instInhabitedEqnsExtState : Inhabited Lean.Meta.EqnsExtState

Equations

• Lean.Meta.instInhabitedEqnsExtState = { default := { map := default } }

opaque Lean.Meta.eqnsExt : Lean.EnvExtension Lean.Meta.EqnsExtState

def Lean.Meta.getEqnsFor? (declName : Lean.Name) (nonRec : optParam Bool false) : Lean.MetaM (Option (Array Lean.Name))

Return equation theorems for the given declaration. By default, we not create equation theorems for nonrecursive definitions. You can use nonRec := true to override this behavior, a dummy rfl proof is created on the fly.

Equations

• One or more equations did not get rendered due to their size.

def Lean.Meta.GetUnfoldEqnFn : Type

Equations

• Lean.Meta.GetUnfoldEqnFn = (Lean.Name → Lean.MetaM (Option Lean.Name))

def Lean.Meta.registerGetUnfoldEqnFn (f : Lean.Meta.GetUnfoldEqnFn) : IO Unit

Register a new function for retrieving a "unfold" equation theorem.

We generate this kind of equation theorem on demand, and it is generated by more than one module. For example, the structural and well-founded recursion modules generate it. Most recent getters are tried first.

A getter returns an Option Name. The result is none if the getter failed. Otherwise, it is a theorem name. Example: the definition

def f (xs : List Nat) : List Nat :=
  match xs with
  | [] => []
  | x::xs => (x+1)::f xs

should have the theorem

(xs : Nat) →
  f xs =
    match xs with
    | [] => []
    | x::xs => (x+1)::f xs

Equations

• One or more equations did not get rendered due to their size.

def Lean.Meta.getUnfoldEqnFor? (declName : Lean.Name) (nonRec : optParam Bool false) : Lean.MetaM (Option Lean.Name)

Return a "unfold" theorem for the given declaration. By default, we not create unfold theorems for nonrecursive definitions. You can use nonRec := true to override this behavior.

Equations

• One or more equations did not get rendered due to their size.