Documentation

Lean.Meta.Tactic.Simp.Types

The result of simplifying some expression e.

  • expr : Lean.Expr

    The simplified version of e

  • proof? : Option Lean.Expr

    A proof that $e = $expr, where the simplified expression is on the RHS. If none, the proof is assumed to be refl.

  • cache : Bool

    If cache := true the result is cached. Warning: we will remove this field in the future. It is currently used by arith := true, but we can now refactor the code to avoid the hack.

Instances For

    Flip the proof in a Simp.Result.

    Equations
    • One or more equations did not get rendered due to their size.
    Instances For
      • maxDischargeDepth : UInt32
      • parent? : Option Lean.Expr

        Stores the "parent" term for the term being simplified. If a simplification procedure result depends on this value, then it is its reponsability to set Result.cache := false.

        Motivation for this field: Suppose we have a simplification procedure for normalizing arithmetic terms. Then, given a term such as t_1 + ... + t_n, we don't want to apply the procedure to every subterm t_1 + ... + t_i for i < n for performance issues. The procedure can accomplish this by checking whether the parent term is also an arithmetical expression and do nothing if it is. However, it should set Result.cache := false to ensure we don't miss simplification opportunities. For example, consider the following:

        example (x y : Nat) (h : y = 0) : id ((x + x) + y) = id (x + x) := by
          simp_arith only
          ...
        

        If we don't set Result.cache := false for the first x + x, then we get the resulting state:

        ... |- id (2*x + y) = id (x + x)
        

        instead of

        ... |- id (2*x + y) = id (2*x)
        

        as expected.

        Remark: given an application f a b c the "parent" term for f, a, b, and c is f a b c.

      • dischargeDepth : UInt32
      • lctxInitIndices : Nat

        Number of indices in the local context when starting simp. We use this information to decide which assumptions we can use without invalidating the cache.

      • inDSimp : Bool

        If inDSimp := true, then simp is in dsimp mode, and only applying transformations that presereve definitional equality.

      Instances For
        def Lean.Meta.Simp.mkContext (config : Lean.Meta.Simp.Config := { maxSteps := Lean.Meta.Simp.defaultMaxSteps, maxDischargeDepth := 2, contextual := false, memoize := true, singlePass := false, zeta := true, beta := true, eta := true, etaStruct := Lean.Meta.EtaStructMode.all, iota := true, proj := true, decide := false, arith := false, autoUnfold := false, dsimp := true, failIfUnchanged := true, ground := false, unfoldPartialApp := false, zetaDelta := false, index := true, implicitDefEqProofs := true }) (simpTheorems : Lean.Meta.SimpTheoremsArray := ) (congrTheorems : Lean.Meta.SimpCongrTheorems := { lemmas := { stage₁ := true, map₁ := , map₂ := { root := Lean.PersistentHashMap.Node.entries Lean.PersistentHashMap.mkEmptyEntriesArray } } }) :
        Instances For
          Equations
          • One or more equations did not get rendered due to their size.
          Instances For
            Equations
            • One or more equations did not get rendered due to their size.
            Instances For
              Equations
              • One or more equations did not get rendered due to their size.
              Instances For
                Equations
                • One or more equations did not get rendered due to their size.
                Instances For
                  Equations
                  • One or more equations did not get rendered due to their size.
                  Instances For
                    Instances For
                      Equations
                      Equations
                      @[reducible, inline]
                      Instances For
                        @[inline]
                        Equations
                        • One or more equations did not get rendered due to their size.
                        Instances For
                          @[inline]
                          Equations
                          • One or more equations did not get rendered due to their size.
                          Instances For
                            @[inline]
                            Instances For
                              @[inline]

                              Executes x using a MetaM configuration for indexing terms. It is inferred from Simp.Config. For example, if the user has set simp (config := { zeta := false }), isDefEq and whnf in MetaM should not perform zeta reduction.

                              Instances For

                                Result type for a simplification procedure. We have pre and post simplification procedures.

                                Instances For
                                  @[reducible, inline]

                                  A simplification procedure. Recall that we have pre and post procedures. See Step.

                                  Instances For
                                    @[reducible, inline]
                                    Instances For
                                      @[reducible, inline]

                                      Similar to Simproc, but resulting expression should be definitionally equal to the input one.

                                      Instances For
                                        @[always_inline]

                                        "Compose" the two given simplification procedures. We use the following semantics.

                                        • If f produces done or visit, then return f's result.
                                        • If f produces continue, then apply g to new expression returned by f.

                                        See Simp.Step type.

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

                                          Simproc .olean entry.

                                          Instances For
                                            Equations

                                            Simproc entry. It is the .olean entry plus the actual function.

                                            Instances For
                                              @[reducible, inline]
                                              Instances For
                                                Instances For
                                                  Equations
                                                  @[implemented_by Lean.Meta.Simp.Methods.toMethodsRefImpl]
                                                  @[implemented_by Lean.Meta.Simp.MethodsRef.toMethodsImpl]
                                                  Equations
                                                  Instances For
                                                    Equations
                                                    Instances For
                                                      @[inline]
                                                      Instances For

                                                        Returns true if simp is in dsimp mode. That is, only transformations that preserve definitional equality should be applied.

                                                        Equations
                                                        Instances For
                                                          @[inline]
                                                          Instances For
                                                            @[inline]

                                                            Save current cache, reset it, execute x, and then restore original cache.

                                                            Equations
                                                            • One or more equations did not get rendered due to their size.
                                                            Instances For
                                                              @[inline]
                                                              def Lean.Meta.Simp.withDischarger {α : Type} (discharge? : Lean.ExprLean.Meta.SimpM (Option Lean.Expr)) (wellBehavedDischarge : Bool) (x : Lean.Meta.SimpM α) :
                                                              Instances For
                                                                Equations
                                                                • One or more equations did not get rendered due to their size.
                                                                Instances For
                                                                  Equations
                                                                  • One or more equations did not get rendered due to their size.
                                                                  Instances For
                                                                    Equations
                                                                    Instances For

                                                                      Similar to Result.getProof, but adds a mkExpectedTypeHint if proof? is none (i.e., result is definitionally equal to input), but we cannot establish that source and r.expr are definitionally when using TransparencyMode.reducible.

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

                                                                        Construct the Expr cast h e, from a Simp.Result with proof h.

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

                                                                              Given the application e, remove unnecessary casts of the form Eq.rec a rfl and Eq.ndrec a rfl.

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

                                                                                  Given a simplified function result r and arguments args, simplify arguments using simp and dsimp. The resulting proof is built using congr and congrFun theorems.

                                                                                  Instances For

                                                                                    Retrieve auto-generated congruence lemma for f.

                                                                                    Remark: If all argument kinds are fixed or eq, it returns none because using simple congruence theorems congr, congrArg, and congrFun produces a more compact proof.

                                                                                    Instances For

                                                                                      Try to use automatically generated congruence theorems. See mkCongrSimp?.

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

                                                                                            Auxiliary method. Given the current target of mvarId, apply r which is a new target and proof that it is equal to the current one.

                                                                                            Instances For