data.string.defs | 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

e7131068

(last sync)

Changes in mathlib3port

mathlib3

mathlib3port

9d2f0748

bump to nightly-2023-09-24-06

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

5655435f

Diff

@@ -3,7 +3,7 @@ Copyright (c) 2019 Simon Hudon. All rights reserved.
 Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon, Keeley Hoek, Floris van Doorn
 -/
-import Mathbin.Data.List.Defs
+import Data.List.Defs
 
 #align_import data.string.defs from "leanprover-community/mathlib"@"9d2f0748e6c50d7a2657c564b1ff2c695b39148d"

9d2f0748

bump to nightly-2023-07-20-09

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

9c56d0dd

Diff

@@ -2,14 +2,11 @@
 Copyright (c) 2019 Simon Hudon. All rights reserved.
 Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon, Keeley Hoek, Floris van Doorn
-
-! This file was ported from Lean 3 source module data.string.defs
-! leanprover-community/mathlib commit 9d2f0748e6c50d7a2657c564b1ff2c695b39148d
-! Please do not edit these lines, except to modify the commit id
-! if you have ported upstream changes.
 -/
 import Mathbin.Data.List.Defs
 
+#align_import data.string.defs from "leanprover-community/mathlib"@"9d2f0748e6c50d7a2657c564b1ff2c695b39148d"
+
 /-!
 # Definitions for `string`

9d2f0748

bump to nightly-2023-07-16-17

mathlib commit https://github.com/leanprover-community/mathlib/commit/2fe465deb81bcd7ccafa065bb686888a82f15372

6db63fa6

Diff

@@ -44,12 +44,10 @@ def isPrefixOf (x y : String) : Bool :=
 #align string.is_prefix_of String.isPrefixOf
 -/
 
-#print String.isSuffixOf /-
 /-- Tests whether the first string is a suffix of the second string. -/
 def isSuffixOf (x y : String) : Bool :=
   x.toList.isSuffixOfₓ y.toList
 #align string.is_suffix_of String.isSuffixOf
--/
 
 #print String.startsWith /-
 /-- `x.starts_with y` is true if `y` is a prefix of `x`, and is false otherwise. -/

9d2f0748

bump to nightly-2023-06-13-21

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

829520ac

Diff

@@ -22,10 +22,12 @@ This file defines a bunch of functions for the `string` datatype.
 
 namespace String
 
+#print String.splitOn /-
 /-- `s.split_on c` tokenizes `s : string` on `c : char`. -/
 def splitOn (s : String) (c : Char) : List String :=
   split (· = c) s
 #align string.split_on String.splitOn
+-/
 
 #print String.mapTokens /-
 /-- `string.map_tokens c f s` tokenizes `s : string` on `c : char`, maps `f` over each token, and

9d2f0748

bump to nightly-2023-05-28-06

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

ba5d8b97

Diff

@@ -22,12 +22,6 @@ This file defines a bunch of functions for the `string` datatype.
 
 namespace String
 
-/- warning: string.split_on -> String.splitOn is a dubious translation:
-lean 3 declaration is
-  String -> Char -> (List.{0} String)
-but is expected to have type
-  String -> (optParam.{1} String " ") -> (List.{0} String)
-Case conversion may be inaccurate. Consider using '#align string.split_on String.splitOnₓ'. -/
 /-- `s.split_on c` tokenizes `s : string` on `c : char`. -/
 def splitOn (s : String) (c : Char) : List String :=
   split (· = c) s

9d2f0748

bump to nightly-2023-05-17-14

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

20ad7900

Diff

@@ -77,11 +77,11 @@ def getRest (s t : String) : Option String :=
 #align string.get_rest String.getRest
 -/
 
-#print String.popn /-
+#print String.drop /-
 /-- Removes the first `n` elements from the string `s` -/
-def popn (s : String) (n : Nat) : String :=
+def drop (s : String) (n : Nat) : String :=
   (s.mkIterator.nextn n).nextToString
-#align string.popn String.popn
+#align string.popn String.drop
 -/
 
 #print String.isNat /-

9d2f0748

bump to nightly-2023-04-28-02

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

473bb540

Diff

@@ -4,7 +4,7 @@ Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon, Keeley Hoek, Floris van Doorn
 
 ! This file was ported from Lean 3 source module data.string.defs
-! leanprover-community/mathlib commit e7131068d9696deec51e6cd7668b6d9ac69af6a4
+! leanprover-community/mathlib commit 9d2f0748e6c50d7a2657c564b1ff2c695b39148d
 ! Please do not edit these lines, except to modify the commit id
 ! if you have ported upstream changes.
 -/
@@ -13,6 +13,9 @@ import Mathbin.Data.List.Defs
 /-!
 # Definitions for `string`
 
+> THIS FILE IS SYNCHRONIZED WITH MATHLIB4.
+> Any changes to this file require a corresponding PR to mathlib4.
+
 This file defines a bunch of functions for the `string` datatype.
 -/

e7131068

bump to nightly-2023-04-24-06

mathlib commit https://github.com/leanprover-community/mathlib/commit/09079525fd01b3dda35e96adaa08d2f943e1648c

ff662d55

Diff

@@ -45,10 +45,12 @@ def isPrefixOf (x y : String) : Bool :=
 #align string.is_prefix_of String.isPrefixOf
 -/
 
+#print String.isSuffixOf /-
 /-- Tests whether the first string is a suffix of the second string. -/
 def isSuffixOf (x y : String) : Bool :=
   x.toList.isSuffixOfₓ y.toList
 #align string.is_suffix_of String.isSuffixOf
+-/
 
 #print String.startsWith /-
 /-- `x.starts_with y` is true if `y` is a prefix of `x`, and is false otherwise. -/
@@ -64,11 +66,13 @@ abbrev endsWith (x y : String) : Bool :=
 #align string.ends_with String.endsWith
 -/
 
+#print String.getRest /-
 /-- `get_rest s t` returns `some r` if `s = t ++ r`.
   If `t` is not a prefix of `s`, returns `none` -/
 def getRest (s t : String) : Option String :=
   List.asString <$> s.toList.getRest t.toList
 #align string.get_rest String.getRest
+-/
 
 #print String.popn /-
 /-- Removes the first `n` elements from the string `s` -/

e7131068

bump to nightly-2023-04-05-20

mathlib commit https://github.com/leanprover-community/mathlib/commit/1a4df69ca1a9a0e5e26bfe12e2b92814216016d0

d79d18db

Diff

@@ -70,10 +70,12 @@ def getRest (s t : String) : Option String :=
   List.asString <$> s.toList.getRest t.toList
 #align string.get_rest String.getRest
 
+#print String.popn /-
 /-- Removes the first `n` elements from the string `s` -/
 def popn (s : String) (n : Nat) : String :=
   (s.mkIterator.nextn n).nextToString
 #align string.popn String.popn
+-/
 
 #print String.isNat /-
 /-- `is_nat s` is true iff `s` is a nonempty sequence of digits. -/
@@ -82,10 +84,12 @@ def isNat (s : String) : Bool :=
 #align string.is_nat String.isNat
 -/
 
+#print String.head /-
 /-- Produce the head character from the string `s`, if `s` is not empty, otherwise 'A'. -/
 def head (s : String) : Char :=
   s.mkIterator.curr
 #align string.head String.head
+-/
 
 end String

e7131068

bump to nightly-2023-02-21-16

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

1107b979

Changes in mathlib4

mathlib3

mathlib4

e7131068

feat: 'lake exe pole' computes the longest pole (#8361)

See zulip discussion.

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

0e05cbe2

Diff

@@ -24,13 +24,21 @@ namespace String
 
 /-- Pad `s : String` with repeated occurrences of `c : Char` until it's of length `n`.
   If `s` is initially larger than `n`, just return `s`. -/
-def leftpad (n : Nat) (c : Char) (s : String) : String :=
+def leftpad (n : Nat) (c : Char := ' ') (s : String) : String :=
   ⟨List.leftpad n c s.data⟩
 
 /-- Construct the string consisting of `n` copies of the character `c`. -/
 def replicate (n : Nat) (c : Char) : String :=
   ⟨List.replicate n c⟩
 
+-- TODO bring this definition in line with the above, either by:
+-- adding `List.rightpad` to Std and changing the definition of `rightpad` here to match
+-- or by changing the definition of `leftpad` above to match this
+/-- Pad `s : String` with repeated occurrences of `c : Char` on the right until it's of length `n`.
+  If `s` is initially larger than `n`, just return `s`. -/
+def rightpad (n : Nat) (c : Char := ' ') (s : String) : String :=
+  s ++ String.replicate (n - s.length) c
+
 /-- `s.IsPrefix t` checks if the string `s` is a prefix of the string `t`. -/
 def IsPrefix : String → String → Prop
   | ⟨d1⟩, ⟨d2⟩ => List.IsPrefix d1 d2

e7131068

chore: bump std (#7602)

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

8de3e102

Diff

@@ -31,13 +31,13 @@ def leftpad (n : Nat) (c : Char) (s : String) : String :=
 def replicate (n : Nat) (c : Char) : String :=
   ⟨List.replicate n c⟩
 
-/-- `s.isPrefix t` checks if the string `s` is a prefix of the string `t`. -/
-def isPrefix : String → String → Prop
-  | ⟨d1⟩, ⟨d2⟩ => List.isPrefix d1 d2
+/-- `s.IsPrefix t` checks if the string `s` is a prefix of the string `t`. -/
+def IsPrefix : String → String → Prop
+  | ⟨d1⟩, ⟨d2⟩ => List.IsPrefix d1 d2
 
-/-- `s.isSuffix t` checks if the string `s` is a suffix of the string `t`. -/
-def isSuffix : String → String → Prop
-  | ⟨d1⟩, ⟨d2⟩ => List.isSuffix d1 d2
+/-- `s.IsSuffix t` checks if the string `s` is a suffix of the string `t`. -/
+def IsSuffix : String → String → Prop
+  | ⟨d1⟩, ⟨d2⟩ => List.IsSuffix d1 d2
 
 /-- `String.mapTokens c f s` tokenizes `s : string` on `c : char`, maps `f` over each token, and
 then reassembles the string by intercalating the separator token `c` over the mapped tokens. -/

e7131068

chore: bump Std4 (#6695)

The file Mathlib.Util.Pickle has been upstreamed to std4, as has the declaration String.count.

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

88548040

Diff

@@ -45,10 +45,6 @@ def mapTokens (c : Char) (f : String → String) : String → String :=
   intercalate (singleton c) ∘ List.map f ∘ (·.split (· = c))
 #align string.map_tokens String.mapTokens
 
-/-- Count the occurrences of a character in a string. -/
-def count (s : String) (c : Char) : Nat :=
-  s.foldl (fun n d => if d = c then n + 1 else n) 0
-
 /-- `getRest s t` returns `some r` if `s = t ++ r`.
 If `t` is not a prefix of `s`, it returns `none`. -/
 def getRest (s t : String) : Option String :=

e7131068

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 Simon Hudon. All rights reserved.
 Released under Apache 2.0 license as described in the file LICENSE.
 Authors: Simon Hudon, Keeley Hoek, Floris van Doorn, Chris Bailey
-
-! This file was ported from Lean 3 source module data.string.defs
-! leanprover-community/mathlib commit e7131068d9696deec51e6cd7668b6d9ac69af6a4
-! Please do not edit these lines, except to modify the commit id
-! if you have ported upstream changes.
 -/
 import Std.Data.List.Basic
 import Mathlib.Mathport.Rename
 
+#align_import data.string.defs from "leanprover-community/mathlib"@"e7131068d9696deec51e6cd7668b6d9ac69af6a4"
+
 /-!
 # Definitions for `String`

e7131068

chore: bump to nightly-2023-07-01 (#5409)

depends on: https://github.com/leanprover/std4/pull/163
depends on: #5584
depends on: #5715
depends on: #5729
depends on: https://github.com/leanprover/std4/pull/173

Co-authored-by: Komyyy <pol_tta@outlook.jp> Co-authored-by: Scott Morrison <scott.morrison@gmail.com> Co-authored-by: Scott Morrison <scott.morrison@anu.edu.au> Co-authored-by: Ruben Van de Velde <65514131+Ruben-VandeVelde@users.noreply.github.com> Co-authored-by: Mario Carneiro <di.gama@gmail.com>

906f7221

Diff

@@ -48,31 +48,6 @@ def mapTokens (c : Char) (f : String → String) : String → String :=
   intercalate (singleton c) ∘ List.map f ∘ (·.split (· = c))
 #align string.map_tokens String.mapTokens
 
-/-- `isPrefixOf? pre s` returns `some post` if `s = pre ++ post`.
-If `pre` is not a prefix of `s`, it returns `none`. -/
-def isPrefixOf? (pre s : String) : Option String :=
-  if startsWith s pre then some <| s.drop pre.length else none
-
-/-- Return true iff `p` is a suffix of `s`. -/
-def isSuffixOf (p s : String) : Bool :=
-  substrEq p 0 s (s.endPos - p.endPos) p.endPos.byteIdx
-#align string.is_suffix_of String.isSuffixOf
-
-/-- `isSuffixOf? suff s` returns `some pre` if `s = pre ++ suff`.
-If `suff` is not a suffix of `s`, it returns `none`. -/
-def isSuffixOf? (suff s : String) : Option String :=
-  if s.endsWith suff then some <| s.dropRight suff.length else none
-
-/-- `s.stripPrefix p` will remove `p` from the beginning of `s` if it occurs there,
-or otherwise return `s`. -/
-def stripPrefix (s p : String) :=
-  if s.startsWith p then s.drop p.length else s
-
-/-- `s.stripSuffix p` will remove `p` from the end of `s` if it occurs there,
-or otherwise return `s`. -/
-def stripSuffix (s p : String) :=
-  if s.endsWith p then s.dropRight p.length else s
-
 /-- Count the occurrences of a character in a string. -/
 def count (s : String) (c : Char) : Nat :=
   s.foldl (fun n d => if d = c then n + 1 else n) 0

e7131068

chore: formatting issues (#4947)

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

5068808d

Diff

@@ -36,11 +36,11 @@ def replicate (n : Nat) (c : Char) : String :=
 
 /-- `s.isPrefix t` checks if the string `s` is a prefix of the string `t`. -/
 def isPrefix : String → String → Prop
-| ⟨d1⟩, ⟨d2⟩ => List.isPrefix d1 d2
+  | ⟨d1⟩, ⟨d2⟩ => List.isPrefix d1 d2
 
 /-- `s.isSuffix t` checks if the string `s` is a suffix of the string `t`. -/
 def isSuffix : String → String → Prop
-| ⟨d1⟩, ⟨d2⟩ => List.isSuffix d1 d2
+  | ⟨d1⟩, ⟨d2⟩ => List.isSuffix d1 d2
 
 /-- `String.mapTokens c f s` tokenizes `s : string` on `c : char`, maps `f` over each token, and
 then reassembles the string by intercalating the separator token `c` over the mapped tokens. -/

e7131068

chore: bump dependencies (#4012)

This just bumps the Std dependency, to get access to Mario's new "Try this:" implementation.

Co-authored-by: Bulhwi Cha <chabulhwi@semmalgil.com> Co-authored-by: Kyle Miller <kmill31415@gmail.com> Co-authored-by: Scott Morrison <scott.morrison@anu.edu.au> Co-authored-by: Scott Morrison <scott.morrison@gmail.com> Co-authored-by: Mario Carneiro <di.gama@gmail.com>

f513eb6d

Diff

@@ -83,10 +83,7 @@ def getRest (s t : String) : Option String :=
   List.asString <$> s.toList.getRest t.toList
 #align string.get_rest String.getRest
 
-/-- Removes the first `n` elements from the string `s`. -/
-def popn (s : String) (n : Nat) : String :=
-  ⟨s.toList.drop n⟩
-#align string.popn String.popn
+#align string.popn String.drop
 
 /-- Produce the head character from the string `s`, if `s` is not empty, otherwise `'A'`. -/
 def head (s : String) : Char :=

e7131068

fix: add missing #align lines (#4021)

e93b690b

Diff

@@ -19,6 +19,12 @@ This file defines a bunch of functions for the `String` datatype.
 
 namespace String
 
+#align string.split_on String.splitOn
+#align string.is_prefix_of String.isPrefixOf
+#align string.starts_with String.startsWith
+#align string.ends_with String.endsWith
+#align string.is_nat String.isNat
+
 /-- Pad `s : String` with repeated occurrences of `c : Char` until it's of length `n`.
   If `s` is initially larger than `n`, just return `s`. -/
 def leftpad (n : Nat) (c : Char) (s : String) : String :=

e7131068

doc: fix typo and omission (#3614)

Capitalize the first letter of the docstring of String.leftpad.
Enclose in backticks 'A' in the docstring of String.head.

8dafb519

Diff

@@ -19,7 +19,7 @@ This file defines a bunch of functions for the `String` datatype.
 
 namespace String
 
-/-- pad `s : String` with repeated occurrences of `c : Char` until it's of length `n`.
+/-- Pad `s : String` with repeated occurrences of `c : Char` until it's of length `n`.
   If `s` is initially larger than `n`, just return `s`. -/
 def leftpad (n : Nat) (c : Char) (s : String) : String :=
   ⟨List.leftpad n c s.data⟩
@@ -82,7 +82,7 @@ def popn (s : String) (n : Nat) : String :=
   ⟨s.toList.drop n⟩
 #align string.popn String.popn
 
-/-- Produce the head character from the string `s`, if `s` is not empty, otherwise 'A'. -/
+/-- Produce the head character from the string `s`, if `s` is not empty, otherwise `'A'`. -/
 def head (s : String) : Char :=
   s.iter.curr
 #align string.head String.head

e7131068

feat: port Data.String.Defs (#3612)

Add isSuffixOf, isSuffixOf?, and getRest functions.
Add #align statements.
Indent function bodies.

4ddd2926

Diff

@@ -1,19 +1,32 @@
 /-
-Copyright (c) 2021 Chris Bailey. All rights reserved.
+Copyright (c) 2019 Simon Hudon. All rights reserved.
 Released under Apache 2.0 license as described in the file LICENSE.
-Authors: Chris Bailey
+Authors: Simon Hudon, Keeley Hoek, Floris van Doorn, Chris Bailey
+
+! This file was ported from Lean 3 source module data.string.defs
+! leanprover-community/mathlib commit e7131068d9696deec51e6cd7668b6d9ac69af6a4
+! Please do not edit these lines, except to modify the commit id
+! if you have ported upstream changes.
 -/
 import Std.Data.List.Basic
+import Mathlib.Mathport.Rename
+
+/-!
+# Definitions for `String`
+
+This file defines a bunch of functions for the `String` datatype.
+-/
 
 namespace String
 
 /-- pad `s : String` with repeated occurrences of `c : Char` until it's of length `n`.
   If `s` is initially larger than `n`, just return `s`. -/
 def leftpad (n : Nat) (c : Char) (s : String) : String :=
-⟨List.leftpad n c s.data⟩
+  ⟨List.leftpad n c s.data⟩
 
 /-- Construct the string consisting of `n` copies of the character `c`. -/
-def replicate (n : Nat) (c : Char) : String := ⟨List.replicate n c⟩
+def replicate (n : Nat) (c : Char) : String :=
+  ⟨List.replicate n c⟩
 
 /-- `s.isPrefix t` checks if the string `s` is a prefix of the string `t`. -/
 def isPrefix : String → String → Prop
@@ -26,33 +39,52 @@ def isSuffix : String → String → Prop
 /-- `String.mapTokens c f s` tokenizes `s : string` on `c : char`, maps `f` over each token, and
 then reassembles the string by intercalating the separator token `c` over the mapped tokens. -/
 def mapTokens (c : Char) (f : String → String) : String → String :=
-intercalate (singleton c) ∘ List.map f ∘ (·.split (· = c))
+  intercalate (singleton c) ∘ List.map f ∘ (·.split (· = c))
+#align string.map_tokens String.mapTokens
 
 /-- `isPrefixOf? pre s` returns `some post` if `s = pre ++ post`.
-  If `pre` is not a prefix of `s`, it returns `none`. -/
+If `pre` is not a prefix of `s`, it returns `none`. -/
 def isPrefixOf? (pre s : String) : Option String :=
   if startsWith s pre then some <| s.drop pre.length else none
 
+/-- Return true iff `p` is a suffix of `s`. -/
+def isSuffixOf (p s : String) : Bool :=
+  substrEq p 0 s (s.endPos - p.endPos) p.endPos.byteIdx
+#align string.is_suffix_of String.isSuffixOf
+
+/-- `isSuffixOf? suff s` returns `some pre` if `s = pre ++ suff`.
+If `suff` is not a suffix of `s`, it returns `none`. -/
+def isSuffixOf? (suff s : String) : Option String :=
+  if s.endsWith suff then some <| s.dropRight suff.length else none
+
 /-- `s.stripPrefix p` will remove `p` from the beginning of `s` if it occurs there,
 or otherwise return `s`. -/
 def stripPrefix (s p : String) :=
-if s.startsWith p then s.drop p.length else s
+  if s.startsWith p then s.drop p.length else s
 
 /-- `s.stripSuffix p` will remove `p` from the end of `s` if it occurs there,
 or otherwise return `s`. -/
 def stripSuffix (s p : String) :=
-if s.endsWith p then s.dropRight p.length else s
+  if s.endsWith p then s.dropRight p.length else s
 
 /-- Count the occurrences of a character in a string. -/
 def count (s : String) (c : Char) : Nat :=
-s.foldl (fun n d => if d = c then n + 1 else n) 0
+  s.foldl (fun n d => if d = c then n + 1 else n) 0
+
+/-- `getRest s t` returns `some r` if `s = t ++ r`.
+If `t` is not a prefix of `s`, it returns `none`. -/
+def getRest (s t : String) : Option String :=
+  List.asString <$> s.toList.getRest t.toList
+#align string.get_rest String.getRest
 
-/-- Removes the first `n` elements from the string `s` -/
+/-- Removes the first `n` elements from the string `s`. -/
 def popn (s : String) (n : Nat) : String :=
   ⟨s.toList.drop n⟩
+#align string.popn String.popn
 
 /-- Produce the head character from the string `s`, if `s` is not empty, otherwise 'A'. -/
 def head (s : String) : Char :=
   s.iter.curr
+#align string.head String.head
 
 end String

`data.string.defs` ⟷ `Mathlib.Data.String.Defs`

Changes since the initial port

Changes in mathlib3

Changes in mathlib3port

Changes in mathlib4

Dependencies 5

data.string.defs ⟷ Mathlib.Data.String.Defs

Changes since the initial port

Changes in mathlib3

Changes in mathlib3port

Changes in mathlib4

Dependencies 5

`data.string.defs` ⟷ `Mathlib.Data.String.Defs`