Documentation

Lean.Compiler.LCNF.CompilerM

The pipeline phase a certain Pass is supposed to happen in.

Instances For
    • A LocalContext to store local declarations from let binders and other constructs in as we move through Exprs.

    • nextIdx : Nat

      Next auxiliary variable suffix

    The state managed by the CompilerM Monad.

    Instances For
      @[inline, reducible]
      Instances For

        Erase all free variables occurring in decls from the local context.

        Instances For
          @[inline, reducible]

          A free variable substitution. We use these substitutions when inlining definitions and "internalizing" LCNF code into CompilerM. During the internalization process, we ensure all free variables in the LCNF code do not collide with existing ones at the CompilerM local context. Remark: in LCNF, (computationally relevant) data is in A-normal form, but this is not the case for types and type formers. So, when inlining we often want to replace a free variable with a type or type former.

          The substitution contains entries fvarId ↦ e s.t., e is a valid LCNF argument. That is, it is a free variable, a type (or type former), or lcErased.

          Check.lean contains a substitution validator.

          Instances For

            Result type for normFVar and normFVarImp.

            Instances For

              Interface for monads that have a free substitutions.

              Instances
                @[inline]

                Add the entry fvarId ↦ fvarId' to the free variable substitution.

                Instances For
                  @[inline]

                  Add the substitution fvarId ↦ e, e must be a valid LCNF argument. That is, it must be a free variable, type (or type former), or lcErased.

                  See Check.lean for the free variable substitution checker.

                  Instances For
                    @[inline]

                    Normalize the given free variable. See normExprImp for documentation on the translator parameter. This function is meant to be used in contexts where the input free-variable is computationally relevant. This function panics if the substitution is mapping fvarId to an expression that is not another free variable. That is, it is not a type (or type former), nor lcErased. Recall that a valid FVarSubst contains only expressions that are free variables, lcErased, or type formers.

                    Instances For
                      @[inline]

                      Replace the free variables in e using the given substitution.

                      If translator = true, then we assume the free variables occurring in the range of the substitution are in another local context. For example, translator = true during internalization where we are making sure all free variables in a given expression are replaced with new ones that do not collide with the ones in the current local context.

                      If translator = false, we assume the substitution contains free variable replacements in the same local context, and given entries such as x₁ ↦ x₂, x₂ ↦ x₃, ..., xₙ₋₁ ↦ xₙ, and the expression f x₁ x₂, we want the resulting expression to be f xₙ xₙ. We use this setting, for example, in the simplifier.

                      Instances For
                        @[inline]

                        Replace the free variables in arg using the given substitution.

                        See normExprImp

                        Instances For
                          @[inline]

                          Replace the free variables in e using the given substitution.

                          See normExprImp

                          Instances For
                            @[inline, reducible]

                            Replace the free variables in e using the given substitution.

                            If translator = true, then we assume the free variables occurring in the range of the substitution are in another local context. For example, translator = true during internalization where we are making sure all free variables in a given expression are replaced with new ones that do not collide with the ones in the current local context.

                            If translator = false, we assume the substitution contains free variable replacements in the same local context, and given entries such as x₁ ↦ x₂, x₂ ↦ x₃, ..., xₙ₋₁ ↦ xₙ, and the expression f x₁ x₂, we want the resulting expression to be f xₙ xₙ. We use this setting, for example, in the simplifier.

                            Instances For

                              Normalize the given arguments using the current substitution.

                              Instances For

                                Helper functions for creating LCNF local declarations.

                                @[implemented_by _private.Lean.Compiler.LCNF.CompilerM.0.Lean.Compiler.LCNF.updateParamImp]
                                @[implemented_by _private.Lean.Compiler.LCNF.CompilerM.0.Lean.Compiler.LCNF.updateLetDeclImp]
                                @[implemented_by _private.Lean.Compiler.LCNF.CompilerM.0.Lean.Compiler.LCNF.updateFunDeclImp]
                                @[inline, reducible]
                                abbrev Lean.Compiler.LCNF.NormalizerM (_translator : Bool) (α : Type) :
                                Instances For
                                  @[inline]

                                  If result is .fvar fvarId, then return x fvarId. Otherwise, it is .erased, and method returns let _x.i := .erased; return _x.i.

                                  Instances For
                                    @[inline]

                                    Similar to internalize, but does not refresh FVarIds.

                                    Instances For
                                      Instances For