rename to Seq.unfoldMany

Author: jmagaram

CHANGELOG.md

@@ -1,6 +1,6 @@
-## Version 4.4.0
+## Version 4.4.1
 
-- `Seq.expand` is new and similar to `Seq.unfold` but recursively generates a sequence of sequences.
+- `Seq.unfoldMany` is new and similar to `Seq.unfold` but recursively generates a sequence of sequences.
 
 ## Version 4.3.0
 

README.md

@@ -56,7 +56,7 @@ let cons: ('a, t<'a>) => t<'a>
 let cycle: t<'a> => t<'a>
 let delay: (unit => t<'a>) => t<'a>
 let empty: t<'a>
-let expand: ('a, 'a => t<('b, 'a)>) => t<t<'b>>
+let unfoldMany: ('a, 'a => t<('b, 'a)>) => t<t<'b>>
 let forever: 'a => t<'a>
 let foreverWith: (unit => 'a) => t<'a>
 let fromArray: (~start: int=?, ~end: int=?, array<'a>) => t<'a>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmagaram/rescript-seq",
-  "version": "4.4.0",
+  "version": "4.4.1",
   "module": "",
   "description": "Lazy sequences for ReScript.",
   "keywords": [

src/Seq.res

@@ -953,8 +953,8 @@ let iterateWhile = (seed, f) => () => {
   Next(seed, go(seed))
 }
 
-let rec expand = (seed, f) =>
+let rec unfoldMany = (seed, f) =>
   seed
   ->f
-  ->flatMap(((n, seed)) => expand(seed, f)->map(result => cons(n, result)))
+  ->flatMap(((n, seed)) => unfoldMany(seed, f)->map(result => cons(n, result)))
   ->orElse(empty->once)

src/Seq.resi

@@ -36,10 +36,10 @@ Seq.unfold(1, i => i < 100 ? Some(i, i * 2) : None) // [1, 2, 4, 8, 16, 32, 64]
 let unfold: ('seed, 'seed => option<('a, 'seed)>) => t<'a>
 
 /**
-`expand(seed, f)` creates a sequence of sequences through a recursive
-computation. Similar to `unfold`.
+`unfoldMany(seed, f)` creates a sequence of sequences through a recursive
+computation.
 */
-let expand: ('seed, 'seed => t<('a, 'seed)>) => t<t<'a>>
+let unfoldMany: ('seed, 'seed => t<('a, 'seed)>) => t<t<'a>>
 
 /**
 `init(count, f)` initializes a sequence based on a `count` and a function `f`

tests/Seq__SeqTests.res

@@ -797,7 +797,7 @@ let unfoldTests =
     ),
   ])
 
-let expandTests = {
+let unfoldManyTests = {
   // for a given seed string, return each character and a new seed which is all
   // the characters that follow it
   let combos = s => {
@@ -815,14 +815,19 @@ let expandTests = {
     ->Seq.fromArray
 
   makeSeqEqualsTests(
-    ~title="expand",
+    ~title="unfoldMany",
     [
-      (S.expand("abcd", combos)->format, ["abcd", "abd", "acd", "ad", "bcd", "bd", "cd", "d"], ""),
-      (S.expand("abc", combos)->format, ["abc", "ac", "bc", "c"], ""),
-      (S.expand("ab", combos)->format, ["ab", "b"], ""),
-      (S.expand("a", combos)->format, ["a"], ""),
       (
-        S.expand("abcdefghijklmnopqrstuv", combos)
+        S.unfoldMany("abcd", combos)->format,
+        ["abcd", "abd", "acd", "ad", "bcd", "bd", "cd", "d"],
+        "",
+      ),
+      (S.unfoldMany("abc", combos)->format, ["abc", "ac", "bc", "c"], ""),
+      (S.unfoldMany("ab", combos)->format, ["ab", "b"], ""),
+      (S.unfoldMany("a", combos)->format, ["a"], ""),
+      (S.unfoldMany("", combos)->format, [""], ""),
+      (
+        S.unfoldMany("abcdefghijklmnopqrstuv", combos)
         ->Seq.last
         ->Option.map(s => s->Seq.once->format)
         ->Option.getExn,
@@ -2265,7 +2270,7 @@ let tests =
     everySomeTests,
     everyTests,
     exactlyOneTests,
-    expandTests,
+    unfoldManyTests,
     filterMapiTests,
     filterMapTests,
     filterOkTests,