control.monad.writer | Mathlib porting status

Changes since the initial port

The following section lists changes to this file in mathlib3 and mathlib4 that occured after the initial port. Most recent changes are shown first. Hovering over a commit will show all commits associated with the same mathlib3 commit.

Changes in mathlib3

9407b033

(last sync)

Changes in mathlib3port

mathlib3

mathlib3port

9407b033

bump to nightly-2023-09-24-06

mathlib commit https://github.com/leanprover-community/mathlib/commit/ce64cd319bb6b3e82f31c2d38e79080d377be451

5655435f

Diff

@@ -5,8 +5,8 @@ Authors: Simon Hudon
 
 The writer monad transformer for passing immutable state.
 -/
-import Mathbin.Algebra.Group.Defs
-import Mathbin.Logic.Equiv.Defs
+import Algebra.Group.Defs
+import Logic.Equiv.Defs
 
 #align_import control.monad.writer from "leanprover-community/mathlib"@"9407b03373c8cd201df99d6bc5514fc2db44054f"

9407b033

bump to nightly-2023-07-20-09

mathlib commit https://github.com/leanprover-community/mathlib/commit/8ea5598db6caeddde6cb734aa179cc2408dbd345

9c56d0dd

Diff

@@ -4,15 +4,12 @@ Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon
 
 The writer monad transformer for passing immutable state.
-
-! This file was ported from Lean 3 source module control.monad.writer
-! leanprover-community/mathlib commit 9407b03373c8cd201df99d6bc5514fc2db44054f
-! Please do not edit these lines, except to modify the commit id
-! if you have ported upstream changes.
 -/
 import Mathbin.Algebra.Group.Defs
 import Mathbin.Logic.Equiv.Defs
 
+#align_import control.monad.writer from "leanprover-community/mathlib"@"9407b03373c8cd201df99d6bc5514fc2db44054f"
+
 universe u v w u₀ u₁ v₀ v₁
 
 structure WriterT (ω : Type u) (m : Type u → Type v) (α : Type u) : Type max u v where

9407b033

bump to nightly-2023-06-13-21

mathlib commit https://github.com/leanprover-community/mathlib/commit/9fb8964792b4237dac6200193a0d533f1b3f7423

829520ac

Diff

@@ -186,6 +186,7 @@ instance {ω : Type u} {m : Type u → Type v} [Monad m] [MonadWriter ω m] : Mo
   listen := fun α ⟨cmd⟩ => ⟨(uncurry fun x y => flip Prod.mk y <$> x) <$> listen cmd⟩
   pass := fun α ⟨cmd⟩ => ⟨pass (OptionT.passAux <$> cmd)⟩
 
+#print MonadWriterAdapter /-
 /-- Adapt a monad stack, changing the type of its top-most environment.
 
 This class is comparable to
@@ -203,6 +204,7 @@ class monad_reader_functor (ρ ρ' : out_param (Type u)) (n n' : Type u → Type
 class MonadWriterAdapter (ω ω' : outParam (Type u)) (m m' : Type u → Type v) where
   adaptWriter {α : Type u} : (ω → ω') → m α → m' α
 #align monad_writer_adapter MonadWriterAdapter
+-/
 
 export MonadWriterAdapter (adaptWriter)
 
@@ -210,6 +212,7 @@ section
 
 variable {ω ω' : Type u} {m m' : Type u → Type v}
 
+#print monadWriterAdapterTrans /-
 /-- Transitivity.
 
 This instance generates the type-class problem with a metavariable argument (which is why this
@@ -223,6 +226,7 @@ instance (priority := 100) monadWriterAdapterTrans {n n' : Type u → Type v}
     [MonadWriterAdapter ω ω' m m'] [MonadFunctor m m' n n'] : MonadWriterAdapter ω ω' n n' :=
   ⟨fun α f => monadMap fun α => (adaptWriter f : m α → m' α)⟩
 #align monad_writer_adapter_trans monadWriterAdapterTrans
+-/
 
 instance [Monad m] : MonadWriterAdapter ω ω' (WriterT ω m) (WriterT ω' m) :=
   ⟨fun α => WriterT.adapt⟩

9407b033

bump to nightly-2023-06-01-16

mathlib commit https://github.com/leanprover-community/mathlib/commit/cca40788df1b8755d5baf17ab2f27dacc2e17acb

b9c87c70

Diff

@@ -82,9 +82,9 @@ instance [One ω] [Mul ω] : Monad (WriterT ω m)
 
 instance [Monoid ω] [LawfulMonad m] : LawfulMonad (WriterT ω m)
     where
-  id_map := by intros ; cases x; simp [(· <$> ·), WriterT.bind, WriterT.pure]
-  pure_bind := by intros ; simp [Pure.pure, WriterT.pure, (· >>= ·), WriterT.bind]; ext <;> rfl
-  bind_assoc := by intros ; simp [(· >>= ·), WriterT.bind, mul_assoc, functor_norm]
+  id_map := by intros; cases x; simp [(· <$> ·), WriterT.bind, WriterT.pure]
+  pure_bind := by intros; simp [Pure.pure, WriterT.pure, (· >>= ·), WriterT.bind]; ext <;> rfl
+  bind_assoc := by intros; simp [(· >>= ·), WriterT.bind, mul_assoc, functor_norm]
 
 @[inline]
 protected def lift [One ω] (a : m α) : WriterT ω m α :=

9407b033

bump to nightly-2023-05-28-04

mathlib commit https://github.com/leanprover-community/mathlib/commit/917c3c072e487b3cccdbfeff17e75b40e45f66cb

6797a637

Diff

@@ -82,17 +82,9 @@ instance [One ω] [Mul ω] : Monad (WriterT ω m)
 
 instance [Monoid ω] [LawfulMonad m] : LawfulMonad (WriterT ω m)
     where
-  id_map := by
-    intros
-    cases x
-    simp [(· <$> ·), WriterT.bind, WriterT.pure]
-  pure_bind := by
-    intros
-    simp [Pure.pure, WriterT.pure, (· >>= ·), WriterT.bind]
-    ext <;> rfl
-  bind_assoc := by
-    intros
-    simp [(· >>= ·), WriterT.bind, mul_assoc, functor_norm]
+  id_map := by intros ; cases x; simp [(· <$> ·), WriterT.bind, WriterT.pure]
+  pure_bind := by intros ; simp [Pure.pure, WriterT.pure, (· >>= ·), WriterT.bind]; ext <;> rfl
+  bind_assoc := by intros ; simp [(· >>= ·), WriterT.bind, mul_assoc, functor_norm]
 
 @[inline]
 protected def lift [One ω] (a : m α) : WriterT ω m α :=

9407b033

bump to nightly-2023-02-21-16

mathlib commit https://github.com/leanprover-community/mathlib/commit/bd9851ca476957ea4549eb19b40e7b5ade9428cc

1107b979

Changes in mathlib4

mathlib3

mathlib4

9407b033

chore(*): replace $ with <| (#9319)

See Zulip thread for the discussion.

9f6d3388

Diff

@@ -72,16 +72,16 @@ This is used to derive instances for both `[EmptyCollection ω] [Append ω]` and
 -/
 @[reducible, inline]
 def monad (empty : ω) (append : ω → ω → ω) : Monad (WriterT ω M) where
-  map := fun f (cmd : M _) ↦ WriterT.mk $ (fun (a,w) ↦ (f a, w)) <$> cmd
+  map := fun f (cmd : M _) ↦ WriterT.mk <| (fun (a,w) ↦ (f a, w)) <$> cmd
   pure := fun a ↦ pure (f := M) (a, empty)
   bind := fun (cmd : M _) f ↦
-    WriterT.mk $ cmd >>= fun (a, w₁) ↦
+    WriterT.mk <| cmd >>= fun (a, w₁) ↦
       (fun (b, w₂) ↦ (b, append w₁ w₂)) <$> (f a)
 
 /-- Lift an `M` to a `WriterT ω M`, using the given `empty` as the monoid unit. -/
 @[inline]
 protected def liftTell (empty : ω) : MonadLift M (WriterT ω M) where
-  monadLift := fun cmd ↦ WriterT.mk $ (fun a ↦ (a, empty)) <$> cmd
+  monadLift := fun cmd ↦ WriterT.mk <| (fun a ↦ (a, empty)) <$> cmd
 
 instance [EmptyCollection ω] [Append ω] : Monad (WriterT ω M) := monad ∅ (· ++ ·)
 instance [EmptyCollection ω] : MonadLift M (WriterT ω M) := WriterT.liftTell ∅
@@ -96,13 +96,13 @@ instance [Monoid ω] [LawfulMonad M] : LawfulMonad (WriterT ω M) := LawfulMonad
   (bind_assoc := by intros; simp [Bind.bind, mul_assoc, WriterT.mk, ← bind_pure_comp])
 
 instance : MonadWriter ω (WriterT ω M) where
-  tell := fun w ↦ WriterT.mk $ pure (⟨⟩, w)
-  listen := fun cmd ↦ WriterT.mk $ (fun (a,w) ↦ ((a,w), w)) <$> cmd
-  pass := fun cmd ↦ WriterT.mk $ (fun ((a,f), w) ↦ (a, f w)) <$> cmd
+  tell := fun w ↦ WriterT.mk <| pure (⟨⟩, w)
+  listen := fun cmd ↦ WriterT.mk <| (fun (a,w) ↦ ((a,w), w)) <$> cmd
+  pass := fun cmd ↦ WriterT.mk <| (fun ((a,f), w) ↦ (a, f w)) <$> cmd
 
 instance [MonadExcept ε M] : MonadExcept ε (WriterT ω M) where
-  throw := fun e ↦ WriterT.mk $ throw e
-  tryCatch := fun cmd c ↦ WriterT.mk $ tryCatch cmd fun e ↦ (c e).run
+  throw := fun e ↦ WriterT.mk <| throw e
+  tryCatch := fun cmd c ↦ WriterT.mk <| tryCatch cmd fun e ↦ (c e).run
 
 instance [MonadLiftT M (WriterT ω M)] : MonadControl M (WriterT ω M) where
   stM := fun α ↦ α × ω
@@ -110,11 +110,11 @@ instance [MonadLiftT M (WriterT ω M)] : MonadControl M (WriterT ω M) where
   restoreM := WriterT.mk
 
 instance : MonadFunctor M (WriterT ω M) where
-  monadMap := fun k (w : M _) ↦ WriterT.mk $ k w
+  monadMap := fun k (w : M _) ↦ WriterT.mk <| k w
 
 @[inline] protected def adapt {ω' : Type u} {α : Type u} (f : ω → ω') :
     WriterT ω M α → WriterT ω' M α :=
-  fun cmd ↦ WriterT.mk $ Prod.map id f <$> cmd
+  fun cmd ↦ WriterT.mk <| Prod.map id f <$> cmd
 
 end WriterT
 
@@ -144,7 +144,7 @@ their underlying monad -/
 def WriterT.equiv {m₁ : Type u₀ → Type v₀} {m₂ : Type u₁ → Type v₁}
     {α₁ ω₁ : Type u₀} {α₂ ω₂ : Type u₁} (F : (m₁ (α₁ × ω₁)) ≃ (m₂ (α₂ × ω₂))) :
     WriterT ω₁ m₁ α₁ ≃ WriterT ω₂ m₂ α₂ where
-  toFun (f : m₁ _) := WriterT.mk $ F f
-  invFun (f : m₂ _) := WriterT.mk $ F.symm f
-  left_inv (f : m₁ _) := congr_arg WriterT.mk $ F.left_inv f
-  right_inv (f : m₂ _) := congr_arg WriterT.mk $ F.right_inv f
+  toFun (f : m₁ _) := WriterT.mk <| F f
+  invFun (f : m₂ _) := WriterT.mk <| F.symm f
+  left_inv (f : m₁ _) := congr_arg WriterT.mk <| F.left_inv f
+  right_inv (f : m₂ _) := congr_arg WriterT.mk <| F.right_inv f

9407b033

fix: disable autoImplicit globally (#6528)

Autoimplicits are highly controversial and also defeat the performance-improving work in #6474.

The intent of this PR is to make autoImplicit opt-in on a per-file basis, by disabling it in the lakefile and enabling it again with set_option autoImplicit true in the few files that rely on it.

That also keeps this PR small, as opposed to attempting to "fix" files to not need it any more.

I claim that many of the uses of autoImplicit in these files are accidental; situations such as:

Assuming variables are in scope, but pasting the lemma in the wrong section
Pasting in a lemma from a scratch file without checking to see if the variable names are consistent with the rest of the file
Making a copy-paste error between lemmas and forgetting to add an explicit arguments.

Having set_option autoImplicit false as the default prevents these types of mistake being made in the 90% of files where autoImplicits are not used at all, and causes them to be caught by CI during review.

I think there were various points during the port where we encouraged porters to delete the universes u v lines; I think having autoparams for universe variables only would cover a lot of the cases we actually use them, while avoiding any real shortcomings.

A Zulip poll (after combining overlapping votes accordingly) was in favor of this change with 5:5:18 as the no:dontcare:yes vote ratio.

While this PR was being reviewed, a handful of files gained some more likely-accidental autoImplicits. In these places, set_option autoImplicit true has been placed locally within a section, rather than at the top of the file.

0c24f831

Diff

@@ -21,6 +21,8 @@ computation progresses.
 
 -/
 
+set_option autoImplicit true
+
 def WriterT (ω : Type u) (M : Type u → Type v) (α : Type u) : Type v :=
   M (α × ω)

9407b033

chore: script to replace headers with #align_import statements (#5979)

depends on: #5966

Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Scott Morrison <scott.morrison@gmail.com>

89aa3a3b

Diff

@@ -2,15 +2,12 @@
 Copyright (c) 2019 Microsoft Corporation. All rights reserved.
 Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon, E.W.Ayers
-
-! This file was ported from Lean 3 source module control.monad.writer
-! leanprover-community/mathlib commit 9407b03373c8cd201df99d6bc5514fc2db44054f
-! Please do not edit these lines, except to modify the commit id
-! if you have ported upstream changes.
 -/
 import Mathlib.Algebra.Group.Defs
 import Mathlib.Logic.Equiv.Defs
 
+#align_import control.monad.writer from "leanprover-community/mathlib"@"9407b03373c8cd201df99d6bc5514fc2db44054f"
+
 /-!
 # Writer monads

9407b033

chore: cleanup whitespace (#5988)

Grepping for [^ .:{-] [^ :] and reviewing the results. Once I started I couldn't stop. :-)

Co-authored-by: Scott Morrison <scott.morrison@gmail.com>

12343aa5

Diff

@@ -40,7 +40,7 @@ export MonadWriter (tell listen pass)
 variable {M : Type u → Type v} [Monad M]
 
 instance [MonadWriter ω M] : MonadWriter ω (ReaderT ρ M) where
-  tell w :=  (tell w : M _)
+  tell w := (tell w : M _)
   listen x r := listen <| x r
   pass x r := pass <| x r

9407b033

chore: formatting issues (#4947)

Co-authored-by: Scott Morrison <scott.morrison@anu.edu.au> Co-authored-by: Parcly Taxel <reddeloostw@gmail.com>

5068808d

Diff

@@ -52,7 +52,7 @@ instance [MonadWriter ω M] : MonadWriter ω (StateT σ M) where
 namespace WriterT
 
 @[inline]
-protected def mk {ω : Type u} (cmd :  M (α × ω)) : WriterT ω M α:= cmd
+protected def mk {ω : Type u} (cmd :  M (α × ω)) : WriterT ω M α := cmd
 @[inline]
 protected def run {ω : Type u} (cmd : WriterT ω M α) : M (α × ω) := cmd
 @[inline]

9407b033

chore(Control.Monad.Writer): add SHA & missing definitions (#4923)

41b99048

Diff

@@ -2,8 +2,14 @@
 Copyright (c) 2019 Microsoft Corporation. All rights reserved.
 Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon, E.W.Ayers
+
+! This file was ported from Lean 3 source module control.monad.writer
+! leanprover-community/mathlib commit 9407b03373c8cd201df99d6bc5514fc2db44054f
+! Please do not edit these lines, except to modify the commit id
+! if you have ported upstream changes.
 -/
 import Mathlib.Algebra.Group.Defs
+import Mathlib.Logic.Equiv.Defs
 
 /-!
 # Writer monads
@@ -45,10 +51,16 @@ instance [MonadWriter ω M] : MonadWriter ω (StateT σ M) where
 
 namespace WriterT
 
+@[inline]
 protected def mk {ω : Type u} (cmd :  M (α × ω)) : WriterT ω M α:= cmd
+@[inline]
 protected def run {ω : Type u} (cmd : WriterT ω M α) : M (α × ω) := cmd
+@[inline]
 protected def runThe (ω : Type u) (cmd : WriterT ω M α) : M (α × ω) := cmd
 
+@[ext]
+protected theorem ext {ω : Type u} (x x' : WriterT ω M α) (h : x.run = x'.run) : x = x' := h
+
 variable {ω : Type u} {α β : Type u}
 
 /-- Creates an instance of Monad, with an explicitly given empty and append operation.
@@ -59,6 +71,7 @@ monoids with `Mul` and `One` can make `WriterT` cumbersome to use.
 
 This is used to derive instances for both `[EmptyCollection ω] [Append ω]` and `[Monoid ω]`.
 -/
+@[reducible, inline]
 def monad (empty : ω) (append : ω → ω → ω) : Monad (WriterT ω M) where
   map := fun f (cmd : M _) ↦ WriterT.mk $ (fun (a,w) ↦ (f a, w)) <$> cmd
   pure := fun a ↦ pure (f := M) (a, empty)
@@ -67,6 +80,7 @@ def monad (empty : ω) (append : ω → ω → ω) : Monad (WriterT ω M) where
       (fun (b, w₂) ↦ (b, append w₁ w₂)) <$> (f a)
 
 /-- Lift an `M` to a `WriterT ω M`, using the given `empty` as the monoid unit. -/
+@[inline]
 protected def liftTell (empty : ω) : MonadLift M (WriterT ω M) where
   monadLift := fun cmd ↦ WriterT.mk $ (fun a ↦ (a, empty)) <$> cmd
 
@@ -75,6 +89,13 @@ instance [EmptyCollection ω] : MonadLift M (WriterT ω M) := WriterT.liftTell 
 instance [Monoid ω] : Monad (WriterT ω M) := monad 1 (· * ·)
 instance [Monoid ω] : MonadLift M (WriterT ω M) := WriterT.liftTell 1
 
+instance [Monoid ω] [LawfulMonad M] : LawfulMonad (WriterT ω M) := LawfulMonad.mk'
+  (bind_pure_comp := by
+    intros; simp [Bind.bind, Functor.map, Pure.pure, WriterT.mk, bind_pure_comp])
+  (id_map := by intros; simp [Functor.map, WriterT.mk])
+  (pure_bind := by intros; simp [Bind.bind, Pure.pure, WriterT.mk])
+  (bind_assoc := by intros; simp [Bind.bind, mul_assoc, WriterT.mk, ← bind_pure_comp])
+
 instance : MonadWriter ω (WriterT ω M) where
   tell := fun w ↦ WriterT.mk $ pure (⟨⟩, w)
   listen := fun cmd ↦ WriterT.mk $ (fun (a,w) ↦ ((a,w), w)) <$> cmd
@@ -92,4 +113,39 @@ instance [MonadLiftT M (WriterT ω M)] : MonadControl M (WriterT ω M) where
 instance : MonadFunctor M (WriterT ω M) where
   monadMap := fun k (w : M _) ↦ WriterT.mk $ k w
 
+@[inline] protected def adapt {ω' : Type u} {α : Type u} (f : ω → ω') :
+    WriterT ω M α → WriterT ω' M α :=
+  fun cmd ↦ WriterT.mk $ Prod.map id f <$> cmd
+
 end WriterT
+
+/-- Adapt a monad stack, changing the type of its top-most environment.
+
+This class is comparable to [Control.Lens.Magnify](https://hackage.haskell.org/package/lens-4.15.4/docs/Control-Lens-Zoom.html#t:Magnify),
+but does not use lenses (why would it), and is derived automatically for any transformer
+implementing `MonadFunctor`.
+-/
+class MonadWriterAdapter (ω : outParam (Type u)) (m : Type u → Type v) where
+  adaptWriter {α : Type u} : (ω → ω) → m α → m α
+
+export MonadWriterAdapter (adaptWriter)
+
+/-- Transitivity.
+
+see Note [lower instance priority] -/
+instance (priority := 100) monadWriterAdapterTrans {n : Type u → Type v}
+    [MonadWriterAdapter ω m] [MonadFunctor m n] : MonadWriterAdapter ω n where
+  adaptWriter f := monadMap (fun {α} ↦ (adaptWriter f : m α → m α))
+
+instance [Monad m] : MonadWriterAdapter ω (WriterT ω m) where
+  adaptWriter := WriterT.adapt
+
+/-- reduce the equivalence between two writer monads to the equivalence between
+their underlying monad -/
+def WriterT.equiv {m₁ : Type u₀ → Type v₀} {m₂ : Type u₁ → Type v₁}
+    {α₁ ω₁ : Type u₀} {α₂ ω₂ : Type u₁} (F : (m₁ (α₁ × ω₁)) ≃ (m₂ (α₂ × ω₂))) :
+    WriterT ω₁ m₁ α₁ ≃ WriterT ω₂ m₂ α₂ where
+  toFun (f : m₁ _) := WriterT.mk $ F f
+  invFun (f : m₂ _) := WriterT.mk $ F.symm f
+  left_inv (f : m₁ _) := congr_arg WriterT.mk $ F.left_inv f
+  right_inv (f : m₂ _) := congr_arg WriterT.mk $ F.right_inv f

`control.monad.writer` ⟷ `Mathlib.Control.Monad.Writer`

Changes since the initial port

Changes in mathlib3

Changes in mathlib3port

Changes in mathlib4

Dependencies 11

control.monad.writer ⟷ Mathlib.Control.Monad.Writer

Changes since the initial port

Changes in mathlib3

Changes in mathlib3port

Changes in mathlib4

Dependencies 11

`control.monad.writer` ⟷ `Mathlib.Control.Monad.Writer`