General documentation

index
foundational types
references

Library

Aesop (file)
Builder (file)
Apply
Basic
Cases
Constructors
Default
Forward
NormSimp
Tactic
Unfold
BuiltinRules (file)
ApplyHyps
Assumption
DestructProducts
Ext
Intros
Rfl
Split
Subst
Frontend
Extension (file)
Init
Attribute
Basic
Command
RuleExpr
Saturate
Tactic
Index (file)
Basic
Options (file)
Internal
Public
Rule (file)
Basic
Name
RuleSet (file)
Filter
Member
Name
RuleTac (file)
Forward (file)
Basic
Apply
Basic
Cases
ElabRuleTerm
FVarIdSubst
GoalDiff
Preprocess
Tactic
Script
Check
CtorNames
GoalWithMVars
Main
OptimizeSyntax
SScript
ScriptM
SpecificTactics
Step
StructureDynamic
StructureStatic
Tactic
TacticState
UScript
UScriptToSScript
Util
Search
Expansion (file)
Basic
Norm
Simp
Queue (file)
Class
ExpandSafePrefix
Main
RuleSelection
SearchM
Stats
Basic
Extension
Report
Tree (file)
AddRapp
Check
Data
ExtractProof
ExtractScript
Free
RunMetaM
State
Tracing
Traversal
TreeM
UnsafeQueue
Util
Tactic (file)
Ext
Unfold
Basic
EqualUpToIds
UnionFind
UnorderedArraySet
Check
Constants
ElabM
Exception
Main
Nanos
Percent
RulePattern
Saturate
Tracing
Batteries
Classes
Order
RatCast
SatisfiesM
CodeAction (file)
Attr
Basic
Deprecated
Misc
Control
ForInStep
Basic
Lemmas
Nondet
Basic
Data
Array
Init
Lemmas
Basic
Lemmas
Match
Merge
Monadic
BinomialHeap
Basic
Fin
Basic
Lemmas
HashMap (file)
Basic
Lemmas
WF
List
Init
Lemmas
Basic
Count
Lemmas
Pairwise
Perm
MLList
Basic
Nat
Basic
Gcd
Lemmas
RBMap (file)
Alter
Basic
Depth
Lemmas
WF
Range
Lemmas
Rat
Basic
Lemmas
String (file)
Basic
Lemmas
Matcher
Sum
Basic
Lemmas
AssocList
ByteArray
Char
UInt
Lean
Meta
AssertHypotheses
Basic
Clear
DiscrTree
Expr
Inaccessible
InstantiateMVars
SavedState
UnusedNames
AttributeExtra
Except
Expr
Float
HashSet
MonadBacktrack
NameMap
NameMapAttribute
PersistentHashMap
PersistentHashSet
Position
Syntax
TagAttribute
Linter (file)
UnnecessarySeqFocus
UnreachableTactic
Tactic
Lint (file)
Basic
Frontend
Misc
Simp
TypeClass
Alias
Basic
Classical
Congr
Exact
Init
OpenPrivate
PermuteGoals
SeqFocus
Unreachable
Where
Util
Cache
ExtendedBinder
LibraryNote
ProofWanted
Logic
WF
ImportGraph
Imports
RequiredModules
Init (file)
Control (file)
Lawful (file)
Basic
Instances
Basic
EState
Except
ExceptCps
Id
Option
Reader
State
StateCps
StateRef
Data (file)
Array (file)
Subarray (file)
Split
Attach
Basic
BasicAux
BinSearch
DecidableEq
InsertionSort
Lemmas
Mem
QSort
TakeDrop
BitVec (file)
Basic
Bitblast
Folds
Lemmas
ByteArray (file)
Basic
Char (file)
Basic
Lemmas
Fin (file)
Basic
Bitwise
Fold
Iterate
Lemmas
Log2
FloatArray (file)
Basic
Format (file)
Basic
Instances
Macro
Syntax
Int (file)
Bitwise (file)
Lemmas
Basic
DivMod
DivModLemmas
Gcd
Lemmas
Order
Pow
List (file)
Nat (file)
Basic
Pairwise
Range
TakeDrop
Attach
Basic
BasicAux
Control
Count
Erase
Find
Impl
Lemmas
MinMax
Monadic
Notation
Pairwise
Sublist
TakeDrop
Zip
Nat (file)
Bitwise (file)
Basic
Lemmas
Basic
Compare
Control
Div
Dvd
Gcd
Lcm
Lemmas
Linear
Log2
MinMax
Mod
Power2
SOM
Simproc
Option (file)
Basic
BasicAux
Instances
Lemmas
String (file)
Basic
Extra
Lemmas
ToString (file)
Basic
Macro
UInt (file)
Basic
Bitwise
Lemmas
Log2
AC
BEq
Basic
Bool
Cast
Channel
Float
Hashable
OfScientific
Ord
Prod
Queue
Random
Range
Repr
Stream
Subtype
Sum
Grind (file)
Cases
Lemmas
Norm
Tactics
Omega (file)
Coeffs
Constraint
Int
IntList
LinearCombo
Logic
System (file)
FilePath
IO
IOError
Mutex
Platform
Promise
ST
Uri
BinderPredicates
ByCases
Classical
Coe
Conv
Core
Dynamic
Ext
GetElem
Guard
Hints
MacroTrace
Meta
MetaTypes
Notation
NotationExtra
Prelude
PropLemmas
RCases
ShareCommon
SimpLemmas
Simproc
SizeOf
SizeOfLemmas
Tactics
TacticsExtra
Util
WF
WFTactics
Lake (file)
Build (file)
Actions
Basic
Common
Data
Executable
Facets
Fetch
Imports
Index
Info
Job
Key
Library
Module
Package
Run
Store
Targets
Topological
Trace
CLI
Actions
Build
Error
Config (file)
Context
Defaults
Dependency
Env
ExternLib
ExternLibConfig
FacetConfig
Glob
InstallPath
LeanConfig
LeanExe
LeanExeConfig
LeanLib
LeanLibConfig
Module
Monad
Opaque
Package
Script
TargetConfig
Workspace
WorkspaceConfig
DSL (file)
Attributes
AttributesCore
Config
DeclUtil
Extensions
Meta
Package
Require
Script
Targets
Load
Config
Toml (file)
Data
DateTime
Dict
Value
Elab (file)
Expression
Value
Grammar
Load
ParserUtil
Util
Binder
Casing
Compare
Cycle
DRBMap
EStateT
EquipT
Error
Exit
Family
FilePath
Git
IO
JsonObject
Lift
List
Lock
Log
Message
Name
NativeLib
Opaque
OrdHashSet
OrderedTagAttribute
Proc
RBArray
Store
StoreInsts
Sugar
Task
Version
Lean (file)
Compiler (file)
IR (file)
Basic
Borrow
Boxing
Checker
CompilerM
CtorLayout
ElimDeadBranches
ElimDeadVars
EmitC
EmitUtil
ExpandResetReuse
Format
FreeVars
LiveVars
NormIds
PushProj
RC
ResetReuse
SimpCase
Sorry
UnboxResult
LCNF (file)
Simp (file)
Basic
Config
ConstantFold
DefaultAlt
DiscrM
FunDeclInfo
InlineCandidate
InlineProj
JpCases
Main
SimpM
SimpValue
Used
AlphaEqv
AuxDeclCache
BaseTypes
Basic
Bind
CSE
Check
Closure
CompatibleTypes
CompilerM
ConfigOptions
DeclHash
DependsOn
ElimDead
ElimDeadBranches
FVarUtil
FixedParams
FloatLetIn
ForEachExpr
InferType
Internalize
JoinPoints
LCtx
LambdaLifting
Level
Main
MonadScope
MonoTypes
OtherDecl
PassManager
Passes
PhaseExt
PrettyPrinter
PullFunDecls
PullLetDecls
ReduceArity
ReduceJpArity
Renaming
ScopeM
SpecInfo
Specialize
Testing
ToDecl
ToExpr
ToLCNF
ToMono
Types
Util
AtMostOnce
BorrowedAnnotation
CSimpAttr
ClosedTermCache
ConstFolding
ExportAttr
ExternAttr
FFI
ImplementedByAttr
InitAttr
InlineAttrs
Main
NameMangling
NeverExtractAttr
NoncomputableAttr
Old
Options
Specialize
Data (file)
Json (file)
Basic
Elab
FromToJson
Parser
Printer
Stream
Lsp (file)
Basic
Capabilities
Client
CodeActions
Communication
Diagnostics
Extra
InitShutdown
Internal
Ipc
LanguageFeatures
TextSync
Utf16
Workspace
Xml (file)
Basic
Parser
Array
AssocList
Format
FuzzyMatching
HashMap
HashSet
JsonRpc
KVMap
LBool
LOption
Name
NameMap
NameTrie
OpenDecl
Options
Parsec
PersistentArray
PersistentHashMap
PersistentHashSet
Position
PrefixTree
RBMap
RBTree
Rat
SMap
SSet
Trie
DocString (file)
Extension
Elab (file)
Deriving (file)
BEq
Basic
DecEq
FromToJson
Hashable
Inhabited
Nonempty
Ord
Repr
SizeOf
TypeName
Util
InfoTree (file)
Main
Types
PreDefinition (file)
Structural (file)
BRecOn
Basic
Eqns
FindRecArg
IndGroupInfo
IndPred
Main
Preprocess
RecArgInfo
SmartUnfolding
WF (file)
Eqns
Fix
GuessLex
Ite
Main
PackMutual
Preprocess
Rel
Basic
Eqns
Main
MkInhabitant
TerminationArgument
TerminationHint
Quotation (file)
Precheck
Util
Tactic (file)
Conv (file)
Basic
Change
Congr
Delta
Pattern
Rewrite
Simp
Unfold
Omega (file)
Core
Frontend
MinNatAbs
OmegaM
Basic
BuiltinTactic
Cache
Calc
Change
Config
Congr
Delta
DiscrTreeKey
Doc
ElabTerm
Ext
FalseOrByContra
Generalize
Guard
Induction
Injection
LibrarySearch
Location
Match
Meta
NormCast
RCases
Repeat
Rewrite
Rewrites
Rfl
ShowTerm
Simp
SimpTrace
Simpa
Simproc
SolveByElim
Split
Symm
Unfold
App
Arg
Attributes
AutoBound
AuxDef
BinderPredicates
Binders
BindersUtil
BuiltinCommand
BuiltinNotation
BuiltinTerm
Calc
CheckTactic
Command
ComputedFields
Config
DeclModifiers
DeclNameGen
DeclUtil
Declaration
DeclarationRange
DefView
Do
ElabRules
Eval
Exception
Extra
Frontend
GenInjective
GuardMsgs
Import
Inductive
InheritDoc
LetRec
Level
Macro
MacroArgUtil
MacroRules
Match
MatchAltView
MatchExpr
Mixfix
MutualDef
Notation
Open
ParseImportsFast
PatternVar
Print
RecAppSyntax
SetOption
StructInst
Structure
Syntax
SyntheticMVars
Term
Util
Language
Lean (file)
Types
Basic
Linter (file)
Basic
Builtin
ConstructorAsVariable
Deprecated
MissingDocs
Omit
UnusedVariables
Util
Meta (file)
ArgsPacker (file)
Basic
Constructions (file)
BRecOn
CasesOn
NoConfusion
RecOn
Match (file)
MatcherApp
Basic
Transform
Basic
CaseArraySizes
CaseValues
Match
MatchEqs
MatchEqsExt
MatchPatternAttr
MatcherInfo
Value
Tactic (file)
AC (file)
Main
Grind (file)
Attr
Cases
Core
Injection
Preprocessor
RevertAll
Types
Util
LinearArith (file)
Nat (file)
Basic
Simp
Solver
Basic
Main
Simp
Solver
Simp (file)
BuiltinSimprocs (file)
Array
BitVec
Char
Core
Fin
Int
List
Nat
String
UInt
Util
Attr
Diagnostics
Main
RegisterCommand
Rewrite
SimpAll
SimpCongrTheorems
SimpTheorems
Simproc
Types
Acyclic
Apply
Assert
Assumption
AuxLemma
Backtrack
Cases
Cleanup
Clear
Congr
Constructor
Contradiction
Delta
ElimInfo
FVarSubst
FunInd
Generalize
IndependentOf
Induction
Injection
Intro
LibrarySearch
NormCast
Refl
Rename
Repeat
Replace
Revert
Rewrite
Rewrites
Rfl
SolveByElim
Split
SplitIf
Subst
Symm
TryThis
Unfold
UnifyEq
Util
ACLt
AbstractMVars
AbstractNestedProofs
AppBuilder
Basic
Canonicalizer
Check
CheckTactic
Closure
Coe
CoeAttr
CollectFVars
CollectMVars
CompletionName
CongrTheorems
CtorRecognizer
DecLevel
Diagnostics
DiscrTree
DiscrTreeTypes
Eqns
Eval
ExprDefEq
ExprLens
ExprTraverse
ForEachExpr
FunInfo
GeneralizeTelescope
GeneralizeVars
GetUnfoldableConst
GlobalInstances
IndPredBelow
Inductive
InferType
Injective
Instances
Iterator
KAbstract
KExprMap
LazyDiscrTree
LevelDefEq
LitValues
MatchUtil
NatInstTesters
Offset
PPGoal
PProdN
RecursorInfo
Reduce
ReduceEval
SizeOf
Structure
SynthInstance
Transform
TransparencyMode
UnificationHint
WHNF
Parser (file)
Tactic (file)
Doc
Attr
Basic
Command
Do
Extension
Extra
Level
Module
StrInterpolation
Syntax
Term
Types
ParserCompiler (file)
Attribute
PrettyPrinter (file)
Delaborator (file)
Attributes
Basic
Builtins
FieldNotation
Options
SubExpr
TopDownAnalyze
Basic
Formatter
Parenthesizer
Server (file)
CodeActions (file)
Attr
Basic
Provider
FileWorker (file)
RequestHandling
SetupFile
Utils
WidgetRequests
Rpc (file)
Basic
Deriving
RequestHandling
AsyncList
Completion
CompletionItemData
FileSource
GoTo
ImportCompletion
InfoUtils
References
Requests
Snapshots
Utils
Watchdog
Util (file)
CollectAxioms
CollectFVars
CollectLevelParams
CollectMVars
Diff
FileSetupInfo
FindExpr
FindLevelMVar
FindMVar
FoldConsts
ForEachExpr
ForEachExprWhere
HasConstCache
Heartbeats
InstantiateLevelParams
LakePath
LeanOptions
MonadBacktrack
MonadCache
NumObjs
OccursCheck
PPExt
Path
Paths
Profile
Profiler
PtrSet
RecDepth
Recognizers
ReplaceExpr
ReplaceLevel
SCC
SafeExponentiation
SearchPath
ShareCommon
Sorry
TestExtern
Trace
Widget (file)
Basic
Diff
InteractiveCode
InteractiveDiagnostic
InteractiveGoal
TaggedText
Types
UserWidget
AddDecl
Attributes
AuxRecursor
BuiltinDocAttr
Class
CoreM
Declaration
DeclarationRange
Environment
Eval
Exception
Expr
HeadIndex
Hygiene
ImportingFlag
InternalExceptionId
KeyedDeclsAttribute
LabelAttribute
LazyInitExtension
Level
LoadDynlib
LocalContext
Log
Message
MetavarContext
Modifiers
MonadEnv
ProjFns
ReducibilityAttrs
ReservedNameAction
ResolveName
Runtime
ScopedEnvExtension
Structure
SubExpr
Syntax
ToExpr
LeanColls (file)
Classes
IndexType
Basic
Instances
Indexed
Basic
Notation
Ops (file)
Fold
Insert
Bag
Dict
Seq
Data
Transformer
FixSize
Slice
View
Array
AssocList
HashMap
List
RBMap
Range
Util
Cached
MathlibUpstream
Mathlib
Algebra
BigOperators
Group
List
Multiset
CharZero
Defs
Lemmas
Divisibility
Basic
Units
Field
Basic
Defs
Rat
Group
Action
Defs
Units
Commute
Basic
Defs
Units
Equiv
Basic
Hom
Basic
Defs
Instances
Invertible
Basic
Defs
Pi
Basic
Lemmas
Semiconj
Basic
Defs
Units
Units (file)
Equiv
Hom
WithOne
Defs
Basic
Defs
Embedding
Even
Indicator
InjSurj
Int
Nat
Opposite
Prod
Support
TypeTags
ZeroOne
GroupWithZero
Action
Defs
Units
Units
Basic
Equiv
Lemmas
Basic
Commute
Defs
Divisibility
Hom
InjSurj
Invertible
NeZero
Semiconj
WithZero
Order
Field
Canonical
Defs
Basic
Defs
InjSurj
Rat
Group
Unbundled
Abs
Basic
Int
Abs
Defs
InjSurj
Lattice
Nat
OrderIso
PosPart
Synonym
Units
GroupWithZero
Canonical
Synonym
Unbundled
Monoid
Canonical
Defs
Unbundled
Basic
Defs
ExistsOfLE
MinMax
OrderDual
Pow
WithTop
Basic
Defs
NatCast
OrderDual
TypeTags
Units
WithTop
Nonneg
Field
Ring
Positive
Ring
Ring
Unbundled
Basic
Nonneg
Rat
Abs
Basic
Canonical
Cast
Defs
InjSurj
Int
Nat
Rat
Sub
Unbundled
Basic
Basic
Defs
AddGroupWithTop
Invertible
ZeroLEOne
Ring
Divisibility
Basic
Hom
Basic
Defs
Basic
Commute
Defs
InjSurj
Int
Invertible
Nat
Parity
Rat
Semiconj
Units
NeZero
Opposites
Control
Basic
Combinators
EquivFunctor
Functor
ULift
Data
Array
Defs
Bool
Basic
Set
Fin
Tuple
Basic
Basic
Finite
Defs
Finset
Attr
Basic
Image
Union
Fintype
Basic
FunLike
Basic
Embedding
Equiv
Int
Cast
Basic
Defs
Field
Lemmas
Order
Basic
CharZero
Defs
Notation
Sqrt
List
Basic
Chain
Count
Dedup
Defs
Duplicate
FinRange
Forall2
Infix
InsertNth
Join
Lattice
Lemmas
Lex
Monad
Nodup
OfFn
Pairwise
Perm
Permutation
ProdSigma
Range
Rotate
Multiset
Basic
Bind
Dedup
FinsetOps
Nodup
Range
NNRat
Defs
Lemmas
Nat
Cast
Order
Basic
Ring
Basic
Commute
Defs
Field
NeZero
Factorial
Basic
Defs
Find
Notation
Set
Sqrt
Option
Basic
Defs
NAry
Ordering
Basic
PNat
Basic
Defs
Equiv
Prod
Basic
PProd
Rat
Cast
CharZero
Defs
Lemmas
Order
Defs
Init
Lemmas
Set
Pairwise
Basic
Basic
Defs
Function
Image
Lattice
List
NAry
Operations
Prod
Subsingleton
Sigma
Basic
String
Defs
Sum
Basic
Tree
Basic
Bracket
Quot
SProd
Subtype
ULift
Init (file)
Algebra
Classes
Data
List
Lemmas
Nat
Lemmas
Quot
Logic
Lean
Elab
Tactic
Basic
Term
Expr
Basic
ReplaceRec
Meta (file)
Basic
CongrTheorems
Simp
PrettyPrinter
Delaborator
EnvExtension
Name
Logic
Embedding
Basic
Equiv
Basic
Defs
Option
Set
Function
Basic
Conjugate
Defs
Iterate
ULift
Nontrivial
Basic
Defs
Basic
IsEmpty
Nonempty
Pairwise
Relation
Relator
Unique
Order
Bounds
Basic
OrderIso
ConditionallyCompleteLattice
Basic
Heyting
Basic
Hom
Basic
Set
Interval
Set
Basic
Image
OrdConnected
OrderEmbedding
UnorderedInterval
WithBotTop
Monotone
Basic
RelIso
Basic
Antichain
Antisymmetrization
Basic
BooleanAlgebra
BoundedOrder
Compare
CompleteBooleanAlgebra
CompleteLattice
CompleteLatticeIntervals
Cover
Defs
Directed
Disjoint
GaloisConnection
Lattice
LatticeIntervals
Max
MinMax
Notation
PropInstances
RelClasses
SetNotation
SymmDiff
Synonym
TypeTags
ULift
WellFounded
WithBot
Tactic
Attr
Core
Register
Bound
Attribute
Init
CC (file)
Addition
Datatypes
Lemmas
CancelDenoms
Core
GCongr
Core
ForwardAttr
Linarith (file)
Oracle
SimplexAlgorithm (file)
Datatypes
Gauss
PositiveVector
SimplexAlgorithm
Datatypes
Frontend
Lemmas
Parsing
Preprocessing
Verification
Linter (file)
GlobalAttributeIn
HashCommandLinter
HaveLetLinter
Lint
MinImports
OldObtain
RefineLinter
Style
TextBased
UnusedTactic
Monotonicity
Attr
Nontriviality (file)
Core
NormNum (file)
Basic
Core
DivMod
Eq
Ineq
Inv
OfScientific
Pow
Result
Positivity
Basic
Core
Relation
Rfl
Symm
Trans
Ring (file)
Basic
PNat
RingNF
Simps
Basic
NotationClass
ToAdditive (file)
Frontend
Widget
Calc
CongrM
Conv
SelectInsertParamsClass
SelectPanelUtils
AdaptationNote
ApplyAt
ApplyCongr
ApplyWith
Basic
ByContra
Cases
CasesM
Check
Choose
ClearExcept
ClearExclamation
Clear_
Coe
Common
CongrExclamation
CongrM
Constructor
Contrapose
Conv
Convert
Core
DefEqTransformations
DeprecateMe
DeriveToExpr
Eqns
ExistsI
ExtendDoc
ExtractGoal
ExtractLets
FBinop
FailIfNoProgress
FinCases
Find
GeneralizeProofs
GuardGoalNums
GuardHypNums
HaveI
HelpCmd
HigherOrder
Hint
InferParam
Inhabit
IrreducibleDef
Lemma
Lift
MinImports
MkIffOfInductiveProp
MoveAdd
NthRewrite
Observe
PPWithUniv
ProjectionNotation
Propose
ProxyType
PushNeg
RSuffices
Recover
Rename
RenameBVar
Says
ScopedNS
Set
SimpIntro
SimpRw
SplitIfs
Spread
Subsingleton
Substs
SuccessIfFailWithMsg
SudoSetOption
SwapVar
Tauto
TermCongr
ToExpr
ToLevel
Trace
TryThis
TypeCheck
TypeStar
UnsetOption
Use
Variable
WLOG
Zify
Util
AssertExists
AssertExistsExt
AtomM
CompileInductive
CountHeartbeats
Delaborators
MemoFix
Notation3
Qq
SynthesizeUsing
Tactic
WhatsNew
WithWeakNamespace
ProofWidgets
Component
Basic
MakeEditLink
OfRpcMethod
Data
Html
Cancellable
Compat
Util
Qq (file)
ForLean
Do
ReduceEval
ToExpr
AssertInstancesCommute
Delab
Macro
Match
MetaM
SortLocalDecls
Typ
Std (file)
Data (file)
DHashMap (file)
Internal
AssocList
Basic
Lemmas
List
Associative
Defs
HashesTo
Pairwise
Perm
Sublist
Defs
Index
Model
Raw
RawLemmas
WF
AdditionalOperations
Basic
Lemmas
Raw
RawDef
RawLemmas
HashMap (file)
AdditionalOperations
Basic
Lemmas
Raw
RawLemmas
HashSet (file)
Basic
Lemmas
Raw
RawLemmas

Color scheme