General documentation
index
foundational types
Library
Batteries (
file
)
Classes
Cast
Order
RatCast
SatisfiesM
CodeAction (
file
)
Attr
Basic
Deprecated
Misc
Control
ForInStep (
file
)
Basic
Lemmas
Nondet
Basic
Lemmas
Data
Array (
file
)
Init
Lemmas
Basic
Lemmas
Match
Merge
Monadic
OfFn
Pairwise
BinomialHeap (
file
)
Basic
Lemmas
DList (
file
)
Basic
Lemmas
Fin (
file
)
Basic
Fold
Lemmas
HashMap (
file
)
Basic
Lemmas
WF
List (
file
)
Init
Lemmas
Basic
Count
EraseIdx
FinRange
Lemmas
Matcher
Monadic
OfFn
Pairwise
Perm
MLList (
file
)
Basic
Heartbeats
IO
Nat (
file
)
Basic
Bisect
Gcd
Lemmas
RBMap (
file
)
Alter
Basic
Depth
Lemmas
WF
Range (
file
)
Lemmas
Rat (
file
)
Basic
Float
Lemmas
String (
file
)
Basic
Lemmas
Matcher
UnionFind (
file
)
Basic
Lemmas
Vector (
file
)
Basic
Lemmas
AssocList
BinaryHeap
ByteArray
ByteSubarray
Char
FloatArray
LazyList
PairingHeap
Stream
UInt
Lean
IO
Process
Meta
Basic
DiscrTree
Expr
Inaccessible
InstantiateMVars
SavedState
Simp
UnusedNames
System
IO
Util
EnvSearch
AttributeExtra
EStateM
Except
Expr
Float
HashMap
HashSet
Json
LawfulMonad
MonadBacktrack
NameMap
NameMapAttribute
PersistentHashMap
PersistentHashSet
Position
SatisfiesM
Syntax
TagAttribute
Linter (
file
)
UnnecessarySeqFocus
UnreachableTactic
Tactic
Lint (
file
)
Basic
Frontend
Misc
Simp
TypeClass
Alias
Basic
Case
Congr
Exact
HelpCmd
Init
Instances
Lemma
NoMatch
OpenPrivate
PermuteGoals
PrintDependents
PrintPrefix
SeqFocus
ShowUnused
SqueezeScope
Trans
Unreachable
Where
Util
Cache
ExtendedBinder
LibraryNote
Panic
Pickle
ProofWanted
Logic
WF
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
Bootstrap
DecidableEq
GetLit
InsertionSort
Lemmas
MapIdx
Mem
QSort
TakeDrop
BitVec (
file
)
Basic
BasicAux
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
LemmasAux
Order
Pow
List (
file
)
Nat (
file
)
BEq
Basic
Count
Erase
Find
Modify
Pairwise
Range
Sublist
TakeDrop
Sort (
file
)
Basic
Impl
Lemmas
Attach
Basic
BasicAux
Control
Count
Erase
Find
Impl
Lemmas
MapIdx
MinMax
Monadic
Notation
Pairwise
Perm
Range
Sublist
TakeDrop
ToArray
Zip
Nat (
file
)
Bitwise (
file
)
Basic
Lemmas
Basic
Compare
Control
Div
Dvd
Gcd
Lcm
Lemmas
Linear
Log2
MinMax
Mod
Power2
SOM
Simproc
Option (
file
)
Attach
Basic
BasicAux
Instances
Lemmas
List
SInt (
file
)
Basic
String (
file
)
Basic
Extra
Lemmas
Sum (
file
)
Basic
Lemmas
ToString (
file
)
Basic
Macro
UInt (
file
)
Basic
BasicAux
Bitwise
Lemmas
Log2
AC
BEq
Basic
Bool
Cast
Channel
Float
Function
Hashable
NeZero
OfScientific
Ord
PLift
Prod
Queue
Random
Range
Repr
Stream
Subtype
ULift
Zero
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
While
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
Date
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
Reservoir
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
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
)
Nonrec
Eqns
Structural (
file
)
BRecOn
Basic
Eqns
FindRecArg
IndGroupInfo
IndPred
Main
Preprocess
RecArgInfo
SmartUnfolding
WF (
file
)
Basic
Eqns
Fix
GuessLex
Ite
Main
PackMutual
Preprocess
Rel
Basic
EqUnfold
Eqns
Main
MkInhabitant
TerminationArgument
TerminationHint
Quotation (
file
)
Precheck
Util
Tactic (
file
)
BVDecide (
file
)
Frontend (
file
)
BVDecide (
file
)
Reflect
ReifiedBVExpr
ReifiedBVLogical
ReifiedBVPred
ReifiedLemmas
Reify
SatAtBVLogical
Attr
BVCheck
BVTrace
LRAT
Normalize
LRAT (
file
)
Trim
External
Conv (
file
)
Basic
Change
Congr
Delta
Pattern
Rewrite
Simp
Unfold
Omega (
file
)
Core
Frontend
MinNatAbs
OmegaM
Basic
BoolToPropSimps
BuiltinTactic
Cache
Calc
Change
Classical
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
BuiltinEvalCommand
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
Time
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
CollectLevelMVars
CollectLevelParams
CollectMVars
Diff
FileSetupInfo
FindExpr
FindLevelMVar
FindMVar
FoldConsts
ForEachExpr
ForEachExprWhere
HasConstCache
Heartbeats
InstantiateLevelParams
LakePath
LeanOptions
MonadBacktrack
MonadCache
NumApps
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
Exception
Expr
HeadIndex
Hygiene
ImportingFlag
InternalExceptionId
KeyedDeclsAttribute
LabelAttribute
Level
LoadDynlib
LocalContext
Log
Message
MetavarContext
Modifiers
MonadEnv
ProjFns
ReducibilityAttrs
Replay
ReservedNameAction
ResolveName
Runtime
ScopedEnvExtension
Structure
SubExpr
Syntax
ToExpr
Std (
file
)
Data (
file
)
DHashMap (
file
)
Internal
AssocList
Basic
Lemmas
List
Associative
Defs
HashesTo
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
Internal (
file
)
Parsec (
file
)
Basic
ByteArray
String
Sat (
file
)
AIG (
file
)
RefVecOperator (
file
)
Fold
Map
Zip
Basic
CNF
Cached
CachedGates
CachedGatesLemmas
CachedLemmas
If
LawfulOperator
LawfulVecOperator
Lemmas
RefVec
Relabel
RelabelNat
CNF (
file
)
Basic
Dimacs
Literal
Relabel
RelabelFin
Tactic (
file
)
BVDecide (
file
)
Bitblast (
file
)
BVExpr (
file
)
Circuit (
file
)
Impl (
file
)
Operations
Add
Append
Eq
Extract
GetLsbD
Mul
Neg
Not
Replicate
RotateLeft
RotateRight
ShiftLeft
ShiftRight
SignExtend
Sub
Udiv
Ult
Umod
ZeroExtend
Carry
Const
Expr
Pred
Var
Lemmas (
file
)
Operations
Add
Append
Eq
Extract
GetLsbD
Mul
Neg
Not
Replicate
RotateLeft
RotateRight
ShiftLeft
ShiftRight
SignExtend
Sub
Udiv
Ult
Umod
ZeroExtend
Basic
Carry
Const
Expr
Pred
Var
Basic
BoolExpr (
file
)
Basic
Circuit
LRAT (
file
)
Internal
Formula (
file
)
Class
Implementation
Instance
Lemmas
RatAddResult
RatAddSound
RupAddResult
RupAddSound
Actions
Assignment
CNF
Clause
Convert
Entails
LRATChecker
LRATCheckerSound
PosFin
Actions
Checker
Parser
Normalize (
file
)
BitVec
Bool
Canonicalize
Equal
Prop
Reflect
Syntax
Time (
file
)
Calendar
CalendarDiffDays
Clip
Days
Gregorian
MonthDay
OrdinalDate
Week
WeekDate
Clock
DiffTime
SystemTime
UTCTime
Data
Int
Order
List
Basic
Format (
file
)
Parse (
file
)
Class
Instances
Locale
LocalTime
LocalTime
TimeOfDay
TimeZone
ZonedTime
Verify (
file
)
Calendar
DayOfYear
Gregorian
MonthDay
MonthLength
OrdinalDate
Fixed
Interval
Specifier
ZeroPad
references (
file
)
Color scheme
dark
system
light