Documentation

Init.Grind.Tactics

The configuration for grind. Passed to grind using, for example, the grind (config := { matchEqs := true }) syntax.

  • trace : Bool

    If trace is true, grind records used E-matching theorems and case-splits.

  • splits : Nat

    Maximum number of case-splits in a proof search branch. It does not include splits performed during normalization.

  • ematch : Nat

    Maximum number of E-matching (aka heuristic theorem instantiation) rounds before each case split.

  • gen : Nat

    Maximum term generation. The input goal terms have generation 0. When we instantiate a theorem using a term from generation n, the new terms have generation n+1. Thus, this parameter limits the length of an instantiation chain.

  • instances : Nat

    Maximum number of theorem instances generated using E-matching in a proof search tree branch.

  • matchEqs : Bool

    If matchEqs is true, grind uses match-equations as E-matching theorems.

  • splitMatch : Bool

    If splitMatch is true, grind performs case-splitting on match-expressions during the search.

  • splitIte : Bool

    If splitIte is true, grind performs case-splitting on if-then-else expressions during the search.

  • splitIndPred : Bool

    If splitIndPred is true, grind performs case-splitting on inductive predicates. Otherwise, it performs case-splitting only on types marked with [grind cases] attribute.

  • splitImp : Bool

    If splitImp is true, then given an implication p → q or (h : p) → q h, grind splits on p if the implication is true. Otherwise, it will split only if p is an arithmetic predicate.

  • canonHeartbeats : Nat

    Maximum number of heartbeats (in thousands) the canonicalizer can spend per definitional equality test.

  • ext : Bool

    If ext is true, grind uses extensionality theorems that have been marked with [grind ext].

  • extAll : Bool

    If extAll is true, grind uses any extensionality theorems available in the environment.

  • etaStruct : Bool

    If etaStruct is true, then for each term t : S such that S is a structure, and is tagged with [grind ext], grind adds the equation t = ⟨t.1, ..., t.n⟩ which holds by reflexivity. Moreover, the extensionality theorem for S is not used.

  • funext : Bool

    If funext is true, grind creates new opportunities for applying function extensionality by case-splitting on equalities between lambda expressions.

  • lookahead : Bool

    TODO

  • verbose : Bool

    If verbose is false, additional diagnostics information is not collected.

  • clean : Bool

    If clean is true, grind uses expose_names and only generates accessible names.

  • qlia : Bool

    If qlia is true, grind may generate counterexamples for integer constraints using rational numbers, and ignoring divisibility constraints. This approach is cheaper but incomplete.

  • mbtc : Bool

    If mbtc is true, grind will use model-based theory combination for creating new case splits. See paper "Model-based Theory Combination" for details.

  • zetaDelta : Bool

    When set to true (default: true), local definitions are unfolded during normalization and internalization. In other words, given a local context with an entry x : t := e, the free variable x is reduced to e. Note that this behavior is also available in simp, but there its default is false because simp is not always used as a terminal tactic, and it important to preserve the abstractions introduced by users. Additionally, in grind we observed that zetaDelta is particularly important when combined with function induction. In such scenarios, the same let-expressions can be introduced by function induction and also by unfolding the corresponding definition. We want to avoid a situation in which zetaDelta is not applied to let-declarations introduced by function induction while zeta unfolds the definition, causing a mismatch. Finally, note that congruence closure is less effective on terms containing many binders such as lambda and let expressions.

  • zeta : Bool

    When true (default: true), performs zeta reduction of let expressions during normalization. That is, let x := v; e[x] reduces to e[v]. See also zetaDelta.

  • ring : Bool

    When true (default: true), uses procedure for handling equalities over commutative rings.

  • ringSteps : Nat
  • ringNull : Bool

    When true (default: false), the commutative ring procedure in grind constructs stepwise proof terms, instead of a single-step Nullstellensatz certificate

  • linarith : Bool

    When true (default: true), uses procedure for handling linear arithmetic for IntModule, and CommRing.

  • cutsat : Bool

    When true (default: true), uses procedure for handling linear integer arithmetic for Int and Nat.

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

    grind tactic and related tactics.

    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

          grind is a tactic inspired by modern SMT solvers. Picture a virtual whiteboard: every time grind discovers a new equality, inequality, or logical fact, it writes it on the board, groups together terms known to be equal, and lets each reasoning engine read from and contribute to the shared workspace. These engines work together to handle equality reasoning, apply known theorems, propagate new facts, perform case analysis, and run specialized solvers for domains like linear arithmetic and commutative rings.

          grind is not designed for goals whose search space explodes combinatorially, think large pigeonhole instances, graph‑coloring reductions, high‑order N‑queens boards, or a 200‑variable Sudoku encoded as Boolean constraints. Such encodings require thousands (or millions) of case‑splits that overwhelm grind’s branching search.

          For bit‑level or combinatorial problems, consider using bv_decide. bv_decide calls a state‑of‑the‑art SAT solver (CaDiCaL) and then returns a compact, machine‑checkable certificate.

          Equality reasoning #

          grind uses congruence closure to track equalities between terms. When two terms are known to be equal, congruence closure automatically deduces equalities between more complex expressions built from them. For example, if a = b, then congruence closure will also conclude that f a = f b for any function f. This forms the foundation for efficient equality reasoning in grind. Here is an example:

          example (f : Nat → Nat) (h : a = b) : f (f b) = f (f a) := by
            grind
          

          Applying theorems using E-matching #

          To apply existing theorems, grind uses a technique called E-matching, which finds matches for known theorem patterns while taking equalities into account. Combined with congruence closure, E-matching helps grind discover non-obvious consequences of theorems and equalities automatically.

          Consider the following functions and theorems:

          def f (a : Nat) : Nat :=
            a + 1
          
          def g (a : Nat) : Nat :=
            a - 1
          
          @[grind =]
          theorem gf (x : Nat) : g (f x) = x := by
            simp [f, g]
          

          The theorem gf asserts that g (f x) = x for all natural numbers x. The attribute [grind =] instructs grind to use the left-hand side of the equation, g (f x), as a pattern for E-matching. Suppose we now have a goal involving:

          example {a b} (h : f b = a) : g a = b := by
            grind
          

          Although g a is not an instance of the pattern g (f x), it becomes one modulo the equation f b = a. By substituting a with f b in g a, we obtain the term g (f b), which matches the pattern g (f x) with the assignment x := b. Thus, the theorem gf is instantiated with x := b, and the new equality g (f b) = b is asserted. grind then uses congruence closure to derive the implied equality g a = g (f b) and completes the proof.

          The pattern used to instantiate theorems affects the effectiveness of grind. For example, the pattern g (f x) is too restrictive in the following case: the theorem gf will not be instantiated because the goal does not even contain the function symbol g.

          example (h₁ : f b = a) (h₂ : f c = a) : b = c := by
            grind
          

          You can use the command grind_pattern to manually select a pattern for a given theorem. In the following example, we instruct grind to use f x as the pattern, allowing it to solve the goal automatically:

          grind_pattern gf => f x
          
          example {a b c} (h₁ : f b = a) (h₂ : f c = a) : b = c := by
            grind
          

          You can enable the option trace.grind.ematch.instance to make grind print a trace message for each theorem instance it generates.

          You can also specify a multi-pattern to control when grind should apply a theorem. A multi-pattern requires that all specified patterns are matched in the current context before the theorem is applied. This is useful for theorems such as transitivity rules, where multiple premises must be simultaneously present for the rule to apply. The following example demonstrates this feature using a transitivity axiom for a binary relation R:

          opaque R : IntInt → Prop
          axiom Rtrans {x y z : Int} : R x y → R y z → R x z
          
          grind_pattern Rtrans => R x y, R y z
          
          example {a b c d} : R a b → R b c → R c d → R a d := by
            grind
          

          By specifying the multi-pattern R x y, R y z, we instruct grind to instantiate Rtrans only when both R x y and R y z are available in the context. In the example, grind applies Rtrans to derive R a c from R a b and R b c, and can then repeat the same reasoning to deduce R a d from R a c and R c d.

          Instead of using grind_pattern to explicitly specify a pattern, you can use the @[grind] attribute or one of its variants, which will use a heuristic to generate a (multi-)pattern. The complete list is available in the reference manual. The main ones are:

          • @[grind →] will select a multi-pattern from the hypotheses of the theorem (i.e. it will use the theorem for forwards reasoning). In more detail, it will traverse the hypotheses of the theorem from left-to-right, and each time it encounters a minimal indexable (i.e. has a constant as its head) subexpression which "covers" (i.e. fixes the value of) an argument which was not previously covered, it will add that subexpression as a pattern, until all arguments have been covered.
          • @[grind ←] will select a multi-pattern from the conclusion of theorem (i.e. it will use the theorem for backwards reasoning). This may fail if not all the arguments to the theorem appear in the conclusion.
          • @[grind] will traverse the conclusion and then the hypotheses left-to-right, adding patterns as they increase the coverage, stopping when all arguments are covered.
          • @[grind =] checks that the conclusion of the theorem is an equality, and then uses the left-hand-side of the equality as a pattern. This may fail if not all of the arguments appear in the left-hand-side.

          Here is the previous example again but using the attribute [grind →]

          opaque R : IntInt → Prop
          @[grind →] axiom Rtrans {x y z : Int} : R x y → R y z → R x z
          
          example {a b c d} : R a b → R b c → R c d → R a d := by
            grind
          

          To control theorem instantiation and avoid generating an unbounded number of instances, grind uses a generation counter. Terms in the original goal are assigned generation zero. When grind applies a theorem using terms of generation ≤ n n, any new terms it creates are assigned generation n + 1 + 1 1. This limits how far the tactic explores when applying theorems and helps prevent an excessive number of instantiations.

          Key options: #

          • grind (ematch := <num>) controls the number of E-matching rounds.
          • grind [<name>, ...] instructs grind to use the declaration name during E-matching.
          • grind only [<name>, ...] is like grind [<name>, ...] but does not use theorems tagged with @[grind].
          • grind (gen := <num>) sets the maximum generation.

          Linear integer arithmetic (cutsat) #

          grind can solve goals that reduce to linear integer arithmetic (LIA) using an integrated decision procedure called cutsat. It understands

          • equalities   p = 0
          • inequalities  p ≤ 0
          • disequalities p ≠ 0
          • divisibility  d ∣ p

          The solver incrementally assigns integer values to variables; when a partial assignment violates a constraint it adds a new, implied constraint and retries. This model-based search is complete for LIA.

          Key options: #

          • grind -cutsat disable the solver (useful for debugging)
          • grind +qlia accept rational models (shrinks the search space but is incomplete for ℤ)

          Examples: #

          -- Even + even is never odd.
          example {x y : Int} : 2 * x + 4 * y ≠ 5 := by
            grind
          
          -- Mixing equalities and inequalities.
          example {x y : Int} :
              2 * x + 3 * y = 0 → 1 ≤ x → y < 1 := by
            grind
          
          -- Reasoning with divisibility.
          example (a b : Int) :
              2 ∣ a + 1 → 2 ∣ b + a → ¬ 2 ∣ b + 2 * a := by
            grind
          
          example (x y : Int) :
              27 ≤ 11*x + 13*y →
              11*x + 13*y ≤ 45 →
              -10 ≤ 7*x - 9*y →
              7*x - 9*y ≤ 4 → False := by
            grind
          
          -- Types that implement the `ToInt` type-class.
          example (a b c : UInt64)
              : a ≤ 2 → b ≤ 3 → c - a - b = 0 → c ≤ 5 := by
            grind
          

          Algebraic solver (ring) #

          grind ships with an algebraic solver nick-named ring for goals that can be phrased as polynomial equations (or disequations) over commutative rings, semirings, or fields.

          Works out of the box All core numeric types and relevant Mathlib types already provide the required type-class instances, so the solver is ready to use in most developments.

          What it can decide:

          • equalities of the form p = q
          • disequalities p ≠ q
          • basic reasoning under field inverses (a / b := a * b⁻¹)
          • goals that mix ring facts with other grind engines

          Key options: #

          • grind -ring turn the solver off (useful when debugging)
          • grind (ringSteps := n) cap the number of steps performed by this procedure.

          Examples #

          open Lean Grind
          
          example [CommRing α] (x : α) : (x + 1) * (x - 1) = x^2 - 1 := by
            grind
          
          -- Characteristic 256 means 16 * 16 = 0.
          example [CommRing α] [IsCharP α 256] (x : α) :
              (x + 16) * (x - 16) = x^2 := by
            grind
          
          -- Works on built-in rings such as `UInt8`.
          example (x : UInt8) : (x + 16) * (x - 16) = x^2 := by
            grind
          
          example [CommRing α] (a b c : α) :
              a + b + c = 3 →
              a^2 + b^2 + c^2 = 5 →
              a^3 + b^3 + c^3 = 7 →
              a^4 + b^4 = 9 - c^4 := by
            grind
          
          example [Field α] [NoNatZeroDivisors α] (a : α) :
              1 / a + 1 / (2 * a) = 3 / (2 * a) := by
            grind
          

          Other options #

          • grind (splits := <num>) caps the depth of the search tree. Once a branch performs num splits grind stops splitting further in that branch.
          • grind -splitIte disables case splitting on if-then-else expressions.
          • grind -splitMatch disables case splitting on match expressions.
          • grind +splitImp instructs grind to split on any hypothesis A → B whose antecedent A is propositional.
          • grind -linarith disables the linear arithmetic solver for (ordered) modules and rings.

          Additional Examples #

          example {a b} {as bs : List α} : (as ++ bs ++ [b]).getLastD a = b := by
            grind
          
          example (x : BitVec (w+1)) : (BitVec.cons x.msb (x.setWidth w)) = x := by
            grind
          
          example (as : Array α) (lo hi i j : Nat) :
              lo ≤ i → i < j → j ≤ hi → j < as.size → min lo (as.size - 1) ≤ i := by
            grind
          
          Equations
          • One or more equations did not get rendered due to their size.
          Instances For

            grind? takes the same arguments as grind, but reports an equivalent call to grind only that would be sufficient to close the goal. This is useful for reducing the size of the grind theorems in a local invocation.

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

              Sets symbol priorities for the E-matching pattern inference procedure used in grind