Library search

This file defines tactics exact? and apply?, (formerly known as library_search) and a term elaborator exact?% that tries to find a lemma solving the current goal (subgoals are solved using solveByElim).

example : x < x + 1 := exact?%
example : Nat := by exact?

def Lean.Meta.LibrarySearch.solveByElim (required : List Lean.Expr) (exfalso : Bool) (goals : List Lean.MVarId) (maxDepth : Nat) : Lean.MetaM (List Lean.MVarId)

Wrapper for calling `Lean.Meta.SolveByElim.solveByElim with appropriate arguments for library search.

Equations

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

inductive Lean.Meta.LibrarySearch.DeclMod : Type

A "modifier" for a declaration.

• none indicates the original declaration,
• mp indicates that (possibly after binders) the declaration is an ↔, and we want to consider the forward direction,
• mpr similarly, but for the backward direction.

• none: Lean.Meta.LibrarySearch.DeclMod

  the original declaration

• mp: Lean.Meta.LibrarySearch.DeclMod

  the forward direction of an iff

• mpr: Lean.Meta.LibrarySearch.DeclMod

  the backward direction of an iff

instance Lean.Meta.LibrarySearch.instDecidableEqDeclMod : DecidableEq Lean.Meta.LibrarySearch.DeclMod

Equations

• Lean.Meta.LibrarySearch.instDecidableEqDeclMod x y = if h : Lean.Meta.LibrarySearch.DeclMod.toCtorIdx x = Lean.Meta.LibrarySearch.DeclMod.toCtorIdx y then isTrue ⋯ else isFalse ⋯

instance Lean.Meta.LibrarySearch.instInhabitedDeclMod : Inhabited Lean.Meta.LibrarySearch.DeclMod

Equations

• Lean.Meta.LibrarySearch.instInhabitedDeclMod = { default := Lean.Meta.LibrarySearch.DeclMod.none }

instance Lean.Meta.LibrarySearch.instOrdDeclMod : Ord Lean.Meta.LibrarySearch.DeclMod

Equations

• Lean.Meta.LibrarySearch.instOrdDeclMod = { compare := Lean.Meta.LibrarySearch.ordDeclMod✝ }

@[reducible]

def Lean.Meta.LibrarySearch.CandidateFinder : Type

LibrarySearch has an extension mechanism for replacing the function used to find candidate lemmas.

Equations

• Lean.Meta.LibrarySearch.CandidateFinder = (Lean.Expr → Lean.MetaM (Array (Lake.Name × Lean.Meta.LibrarySearch.DeclMod)))

def Lean.Meta.LibrarySearch.DiscrTreeFinder.buildImportCache (config : Lean.Meta.WhnfCoreConfig) : Lean.MetaM (Lean.Meta.DiscrTree (Lake.Name × Lean.Meta.LibrarySearch.DeclMod))

Constructs an discrimination tree from the current environment.

Equations

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

def Lean.Meta.LibrarySearch.DiscrTreeFinder.localMatches (config : Lean.Meta.WhnfCoreConfig) (ty : Lean.Expr) : Lean.MetaM (Array (Lake.Name × Lean.Meta.LibrarySearch.DeclMod))

Returns matches from local constants.

Equations

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

def Lean.Meta.LibrarySearch.DiscrTreeFinder.mkImportFinder (config : Lean.Meta.WhnfCoreConfig) (importTree : Lean.Meta.DiscrTree (Lake.Name × Lean.Meta.LibrarySearch.DeclMod)) (ty : Lean.Expr) : Lean.MetaM (Array (Lake.Name × Lean.Meta.LibrarySearch.DeclMod))

Candidate-finding function that uses a strict discrimination tree for resolution.

Equations

• Lean.Meta.LibrarySearch.DiscrTreeFinder.mkImportFinder config importTree ty = do let __do_lift ← Lean.Meta.DiscrTree.getMatch importTree ty config pure (Array.reverse __do_lift)

def Lean.Meta.LibrarySearch.IncDiscrTreeFinder.mkImportFinder : IO Lean.Meta.LibrarySearch.CandidateFinder

Candidate-finding function that uses a strict discrimination tree for resolution.

Equations

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

opaque Lean.Meta.LibrarySearch.defaultCandidateFinder : IO.Ref Lean.Meta.LibrarySearch.CandidateFinder

The preferred candidate finding function.

def Lean.Meta.LibrarySearch.setDefaultCandidateFinder (cf : Lean.Meta.LibrarySearch.CandidateFinder) : IO Unit

Update the candidate finder used by library search.

Equations

• Lean.Meta.LibrarySearch.setDefaultCandidateFinder cf = ST.Ref.set Lean.Meta.LibrarySearch.defaultCandidateFinder cf

def Lean.Meta.LibrarySearch.mkHeartbeatCheck (leavePercent : Nat) : Lean.MetaM (Lean.MetaM Bool)

Return an action that returns true when the remaining heartbeats is less than the currently remaining heartbeats * leavePercent / 100.

Equations

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

def Lean.Meta.LibrarySearch.interleaveWith {α : Type u_1} {β : Type u_2} {γ : Type u_3} (f : α → γ) (x : Array α) (g : β → γ) (y : Array β) : Array γ

Interleave x y interleaves the elements of x and y until one is empty and then returns final elements in other list.

Equations

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

def Lean.Meta.LibrarySearch.abortSpeculation {m : Type u_1 → Type u_2} {α : Type u_1} [MonadExcept Lean.Exception m] : m α

Called to abort speculative execution in library search.

Equations

• Lean.Meta.LibrarySearch.abortSpeculation = throw (Lean.Exception.internal Lean.Meta.LibrarySearch.abortSpeculationId)

def Lean.Meta.LibrarySearch.isAbortSpeculation : Lean.Exception → Bool

Returns true if this is an abort speculation exception.

Equations

• Lean.Meta.LibrarySearch.isAbortSpeculation x = match x with | Lean.Exception.internal id extra => id == Lean.Meta.LibrarySearch.abortSpeculationId | x => false

@[reducible]

def Lean.Meta.LibrarySearch.Candidate : Type

A library search candidate using symmetry includes the goal to solve, the metavar context for that goal, and the name and orientation of a rule to try using with goal.

Equations

• Lean.Meta.LibrarySearch.Candidate = ((Lean.MVarId × Lean.MetavarContext) × Lake.Name × Lean.Meta.LibrarySearch.DeclMod)

def Lean.Meta.LibrarySearch.librarySearchSymm (searchFn : Lean.Meta.LibrarySearch.CandidateFinder) (goal : Lean.MVarId) : Lean.MetaM (Array Lean.Meta.LibrarySearch.Candidate)

Run searchFn on both the goal and symm applied to the goal.

Equations

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

def Lean.Meta.LibrarySearch.mkLibrarySearchLemma (lem : Lake.Name) (mod : Lean.Meta.LibrarySearch.DeclMod) : Lean.MetaM Lean.Expr

Create lemma from name and mod.

Equations

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

def Lean.Meta.LibrarySearch.tryOnEach (act : Lean.Meta.LibrarySearch.Candidate → Lean.MetaM (List Lean.MVarId)) (candidates : Array Lean.Meta.LibrarySearch.Candidate) : Lean.MetaM (Option (Array (List Lean.MVarId × Lean.MetavarContext)))

Sequentially invokes a tactic act on each value in candidates on the current state.

The tactic act should return a list of meta-variables that still need to be resolved. If this list is empty, then no variables remain to be solved, and tryOnEach returns none with the environment set so each goal is resolved.

If the action throws an internal exception with the abortSpeculationId id then further computation is stopped and intermediate results returned. If any other exception is thrown, then it is silently discarded.

Equations

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

def Lean.Meta.LibrarySearch.librarySearch (goal : Lean.MVarId) (tactic : optParam (Bool → List Lean.MVarId → Lean.MetaM (List Lean.MVarId)) fun (initial : Bool) (g : List Lean.MVarId) => Lean.Meta.LibrarySearch.solveByElim [] initial g 6) (allowFailure : optParam (Lean.MVarId → Lean.MetaM Bool) fun (x : Lean.MVarId) => pure true) (leavePercentHeartbeats : optParam Nat 10) : Lean.MetaM (Option (Array (List Lean.MVarId × Lean.MetavarContext)))

Tries to solve the goal either by:

• calling tactic true
• or applying a library lemma then calling tactic false on the resulting goals.

Typically here tactic is solveByElim, with the Bool flag indicating whether it may retry with exfalso.

If it successfully closes the goal, returns none. Otherwise, it returns some a, where a : Array (List MVarId × MetavarContext), with an entry for each library lemma which was successfully applied, containing a list of the subsidiary goals, and the metavariable context after the application.

(Always succeeds, and the metavariable context stored in the monad is reverted, unless the goal was completely solved.)

(Note that if solveByElim solves some but not all subsidiary goals, this is not currently tracked.)

Equations

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