inductive Lean.Meta.Origin : Type

An Origin is an identifier for simp theorems which indicates roughly what action the user took which lead to this theorem existing in the simp set.

• decl: Lean.Name → optParam Bool true → optParam Bool false → Lean.Meta.Origin

  A global declaration in the environment.

• fvar: Lean.FVarId → Lean.Meta.Origin

  A local hypothesis. When contextual := true is enabled, this fvar may exist in an extension of the current local context; it will not be used for rewriting by simp once it is out of scope but it may end up in the usedSimps trace.

• stx: Lean.Name → Lean.Syntax → Lean.Meta.Origin

  A proof term provided directly to a call to simp [ref, ...] where ref is the provided simp argument (of kind Parser.Tactic.simpLemma). The id is a unique identifier for the call.

• other: Lean.Name → Lean.Meta.Origin

  Some other origin. name should not collide with the other types for erasure to work correctly, and simp trace will ignore this lemma. The other origins should be preferred if possible.

instance Lean.Meta.instInhabitedOrigin : Inhabited Lean.Meta.Origin

instance Lean.Meta.instReprOrigin : Repr Lean.Meta.Origin

def Lean.Meta.Origin.key : Lean.Meta.Origin → Lean.Name

A unique identifier corresponding to the origin.

def Lean.Meta.Origin.converse : Lean.Meta.Origin → Option Lean.Meta.Origin

The origin corresponding to the converse direction (← thm vs. thm)

Equations

• (Lean.Meta.Origin.decl declName phase inv).converse = some (Lean.Meta.Origin.decl declName phase !inv)
• x.converse = none

instance Lean.Meta.instBEqOrigin : BEq Lean.Meta.Origin

instance Lean.Meta.instHashableOrigin : Hashable Lean.Meta.Origin

def Lean.Meta.Origin.lt : Lean.Meta.Origin → Lean.Meta.Origin → Bool

instance Lean.Meta.instLTOrigin : LT Lean.Meta.Origin

Equations

• Lean.Meta.instLTOrigin = { lt := fun (a b : Lean.Meta.Origin) => a.lt b = true }

instance Lean.Meta.instDecidableLtOrigin (a b : Lean.Meta.Origin) : Decidable (a < b)

Equations

• Lean.Meta.instDecidableLtOrigin a b = inferInstanceAs (Decidable (a.lt b = true))

@[reducible, inline]

abbrev Lean.Meta.SimpTheoremKey : Type

structure Lean.Meta.SimpTheorem : Type

The fields levelParams and proof are used to encode the proof of the simp theorem. If the proof is a global declaration c, we store Expr.const c [] at proof without the universe levels, and levelParams is set to #[] When using the lemma, we create fresh universe metavariables. Motivation: most simp theorems are global declarations, and this approach is faster and saves memory.

The field levelParams is not empty only when we elaborate an expression provided by the user, and it contains universe metavariables. Then, we use abstractMVars to abstract the universe metavariables and create new fresh universe parameters that are stored at the field levelParams.

• keys : Array Lean.Meta.SimpTheoremKey
• levelParams : Array Lean.Name

  It stores universe parameter names for universe polymorphic proofs. Recall that it is non-empty only when we elaborate an expression provided by the user. When proof is just a constant, we can use the universe parameter names stored in the declaration.

• proof : Lean.Expr
• priority : Nat
• post : Bool
• perm : Bool

  perm is true if lhs and rhs are identical modulo permutation of variables.

• origin : Lean.Meta.Origin

  origin is mainly relevant for producing trace messages. It is also viewed an id used to "erase" simp theorems from SimpTheorems.

• rfl : Bool

  rfl is true if proof is by Eq.refl or rfl.

instance Lean.Meta.instInhabitedSimpTheorem : Inhabited Lean.Meta.SimpTheorem

partial def Lean.Meta.isRflProofCore (type proof : Lean.Expr) : Lean.CoreM Bool

partial def Lean.Meta.isRflTheorem (declName : Lean.Name) : Lean.CoreM Bool

def Lean.Meta.isRflProof (proof : Lean.Expr) : Lean.MetaM Bool

Equations

• Lean.Meta.isRflProof (Lean.Expr.const declName us) = liftM (Lean.Meta.isRflTheorem declName)
• Lean.Meta.isRflProof proof = do let __do_lift ← Lean.Meta.inferType proof liftM (Lean.Meta.isRflProofCore __do_lift proof)

instance Lean.Meta.instToFormatSimpTheorem : Lean.ToFormat Lean.Meta.SimpTheorem

Equations

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

def Lean.Meta.ppOrigin {m : Type → Type} [Monad m] [Lean.MonadEnv m] [Lean.MonadError m] : Lean.Meta.Origin → m Lean.MessageData

def Lean.Meta.ppSimpTheorem {m : Type → Type} [Monad m] [Lean.MonadEnv m] [Lean.MonadError m] (s : Lean.Meta.SimpTheorem) : m Lean.MessageData

instance Lean.Meta.instBEqSimpTheorem : BEq Lean.Meta.SimpTheorem

Equations

• Lean.Meta.instBEqSimpTheorem = { beq := fun (e₁ e₂ : Lean.Meta.SimpTheorem) => e₁.proof == e₂.proof }

@[reducible, inline]

abbrev Lean.Meta.SimpTheoremTree : Type

Equations

• Lean.Meta.SimpTheoremTree = Lean.Meta.DiscrTree Lean.Meta.SimpTheorem

structure Lean.Meta.SimpTheorems : Type

• pre : Lean.Meta.SimpTheoremTree
• post : Lean.Meta.SimpTheoremTree
• lemmaNames : Lean.PHashSet Lean.Meta.Origin
• toUnfold : Lean.PHashSet Lean.Name

  Constants (and let-declaration FVarId) to unfold. When zetaDelta := false, the simplifier will expand a let-declaration if it is in this set.

• erased : Lean.PHashSet Lean.Meta.Origin
• toUnfoldThms : Lean.PHashMap Lean.Name (Array Lean.Name)

instance Lean.Meta.instInhabitedSimpTheorems : Inhabited Lean.Meta.SimpTheorems

Equations

• Lean.Meta.instInhabitedSimpTheorems = { default := { pre := default, post := default, lemmaNames := default, toUnfold := default, erased := default, toUnfoldThms := default } }

def Lean.Meta.simpGlobalConfig : Lean.Meta.ConfigWithKey

Configuration for MetaM used to process global simp theorems

@[inline]

def Lean.Meta.withSimpGlobalConfig {α : Type} : Lean.MetaM α → Lean.MetaM α

partial def Lean.Meta.SimpTheorems.eraseCore (d : Lean.Meta.SimpTheorems) (thmId : Lean.Meta.Origin) : Lean.Meta.SimpTheorems

def Lean.Meta.addSimpTheoremEntry (d : Lean.Meta.SimpTheorems) (e : Lean.Meta.SimpTheorem) : Lean.Meta.SimpTheorems

def Lean.Meta.addSimpTheoremEntry.updateLemmaNames (e : Lean.Meta.SimpTheorem) (s : Lean.PHashSet Lean.Meta.Origin) : Lean.PHashSet Lean.Meta.Origin

def Lean.Meta.SimpTheorems.addDeclToUnfoldCore (d : Lean.Meta.SimpTheorems) (declName : Lean.Name) : Lean.Meta.SimpTheorems

Equations

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

def Lean.Meta.SimpTheorems.addLetDeclToUnfold (d : Lean.Meta.SimpTheorems) (fvarId : Lean.FVarId) : Lean.Meta.SimpTheorems

def Lean.Meta.SimpTheorems.isDeclToUnfold (d : Lean.Meta.SimpTheorems) (declName : Lean.Name) : Bool

Return true if declName is tagged to be unfolded using unfoldDefinition? (i.e., without using equational theorems).

def Lean.Meta.SimpTheorems.isLetDeclToUnfold (d : Lean.Meta.SimpTheorems) (fvarId : Lean.FVarId) : Bool

Equations

• d.isLetDeclToUnfold fvarId = Lean.PersistentHashSet.contains d.toUnfold fvarId.name

def Lean.Meta.SimpTheorems.isLemma (d : Lean.Meta.SimpTheorems) (thmId : Lean.Meta.Origin) : Bool

def Lean.Meta.SimpTheorems.registerDeclToUnfoldThms (d : Lean.Meta.SimpTheorems) (declName : Lean.Name) (eqThms : Array Lean.Name) : Lean.Meta.SimpTheorems

Register the equational theorems for the given definition.

def Lean.Meta.SimpTheorems.erase {m : Type → Type} [Monad m] [Lean.MonadLog m] [Lean.AddMessageContext m] [Lean.MonadOptions m] (d : Lean.Meta.SimpTheorems) (thmId : Lean.Meta.Origin) : m Lean.Meta.SimpTheorems

Equations

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

inductive Lean.Meta.SimpEntry : Type

• thm: Lean.Meta.SimpTheorem → Lean.Meta.SimpEntry
• toUnfold: Lean.Name → Lean.Meta.SimpEntry
• toUnfoldThms: Lean.Name → Array Lean.Name → Lean.Meta.SimpEntry

instance Lean.Meta.instInhabitedSimpEntry : Inhabited Lean.Meta.SimpEntry

@[reducible, inline]

abbrev Lean.Meta.SimpExtension : Type

def Lean.Meta.SimpExtension.getTheorems (ext : Lean.Meta.SimpExtension) : Lean.CoreM Lean.Meta.SimpTheorems

def Lean.Meta.addSimpTheorem (ext : Lean.Meta.SimpExtension) (declName : Lean.Name) (post inv : Bool) (attrKind : Lean.AttributeKind) (prio : Nat) : Lean.MetaM Unit

Equations

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

def Lean.Meta.mkSimpExt (name : Lean.Name := by exact decl_name%) : IO Lean.Meta.SimpExtension

@[reducible, inline]

abbrev Lean.Meta.SimpExtensionMap : Type

Equations

• Lean.Meta.SimpExtensionMap = Std.HashMap Lean.Name Lean.Meta.SimpExtension

opaque Lean.Meta.simpExtensionMapRef : IO.Ref Lean.Meta.SimpExtensionMap

def Lean.Meta.getSimpExtension? (attrName : Lean.Name) : IO (Option Lean.Meta.SimpExtension)

def Lean.Meta.SimpTheorems.addConst (s : Lean.Meta.SimpTheorems) (declName : Lean.Name) (post : Bool := true) (inv : Bool := false) (prio : Nat := 1000) : Lean.MetaM Lean.Meta.SimpTheorems

Auxiliary method for adding a global declaration to a SimpTheorems datastructure.

def Lean.Meta.SimpTheorem.getValue (simpThm : Lean.Meta.SimpTheorem) : Lean.MetaM Lean.Expr

Equations

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

def Lean.Meta.SimpTheorems.ignoreEquations (declName : Lean.Name) : Lean.CoreM Bool

Reducible functions and projection functions should always be put in toUnfold, instead of trying to use equational theorems.

The simplifiers has special support for structure and class projections, and gets confused when they suddenly rewrite, so ignore equations for them

Equations

• Lean.Meta.SimpTheorems.ignoreEquations declName = do let __do_lift ← Lean.isProjectionFn declName let __do_lift_1 ← Lean.isReducible declName pure (__do_lift || __do_lift_1)

def Lean.Meta.SimpTheorems.unfoldEvenWithEqns (declName : Lean.Name) : Lean.CoreM Bool

Even if a function has equation theorems, we also store it in the toUnfold set in the following two cases: 1- It was defined by structural recursion and has a smart-unfolding associated declaration. 2- It is non-recursive.

Reason: unfoldPartialApp := true or conditional equations may not apply.

Remark: In the future, we are planning to disable this behavior unless unfoldPartialApp := true. Moreover, users will have to use f.eq_def if they want to force the definition to be unfolded.

def Lean.Meta.SimpTheorems.addDeclToUnfold (d : Lean.Meta.SimpTheorems) (declName : Lean.Name) : Lean.MetaM Lean.Meta.SimpTheorems

Equations

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

def Lean.Meta.SimpTheorems.add (s : Lean.Meta.SimpTheorems) (id : Lean.Meta.Origin) (levelParams : Array Lean.Name) (proof : Lean.Expr) (inv : Bool := false) (post : Bool := true) (prio : Nat := 1000) (config : Lean.Meta.ConfigWithKey := Lean.Meta.simpGlobalConfig) : Lean.MetaM Lean.Meta.SimpTheorems

Auxiliary method for adding a local simp theorem to a SimpTheorems datastructure.

@[reducible, inline]

abbrev Lean.Meta.SimpTheoremsArray : Type

def Lean.Meta.SimpTheoremsArray.addTheorem (thmsArray : Lean.Meta.SimpTheoremsArray) (id : Lean.Meta.Origin) (h : Lean.Expr) (config : Lean.Meta.ConfigWithKey := Lean.Meta.simpGlobalConfig) : Lean.MetaM Lean.Meta.SimpTheoremsArray

def Lean.Meta.SimpTheoremsArray.eraseTheorem (thmsArray : Lean.Meta.SimpTheoremsArray) (thmId : Lean.Meta.Origin) : Lean.Meta.SimpTheoremsArray

Equations

• thmsArray.eraseTheorem thmId = Array.map (fun (thms : Lean.Meta.SimpTheorems) => thms.eraseCore thmId) thmsArray

def Lean.Meta.SimpTheoremsArray.isErased (thmsArray : Lean.Meta.SimpTheoremsArray) (thmId : Lean.Meta.Origin) : Bool

def Lean.Meta.SimpTheoremsArray.isDeclToUnfold (thmsArray : Lean.Meta.SimpTheoremsArray) (declName : Lean.Name) : Bool

Equations

• thmsArray.isDeclToUnfold declName = Array.any thmsArray fun (thms : Lean.Meta.SimpTheorems) => thms.isDeclToUnfold declName

def Lean.Meta.SimpTheoremsArray.isLetDeclToUnfold (thmsArray : Lean.Meta.SimpTheoremsArray) (fvarId : Lean.FVarId) : Bool

Equations

• thmsArray.isLetDeclToUnfold fvarId = Array.any thmsArray fun (thms : Lean.Meta.SimpTheorems) => thms.isLetDeclToUnfold fvarId