functionalscript 0.0.215 → 0.0.216

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "functionalscript",
-   "version": "0.0.215",
+   "version": "0.0.216",
    "description": "FunctionalScript is a functional subset of JavaScript",
    "main": "index.js",
    "scripts": {

package/sequence/index.js

@@ -185,8 +185,8 @@ const last = def => input => {
 /** @type {<T, R>(s: seqOp.ExclusiveScan<T, R>) => (input: Sequence<T>) => R} */
 const reduce = ([first, s]) => input => last(first)(scan(s)(input))
 
-/** @type {<T, R>(ro: op.ReduceOperator<R, T>) => (first: R) => (input: Sequence<T>) => R} */
-const fold = ro => first => reduce(seqOp.exclusiveScan(ro)(first))
+/** @type {<T, R>(operator: op.ReduceOperator<R, T>) => (first: R) => (input: Sequence<T>) => R} */
+const fold = operator => first => reduce(seqOp.exclusiveScan(operator)(first))
 
 const entries = scan(seqOp.entries)
 

package/sequence/operator/README.md

@@ -0,0 +1,41 @@
+# Sequence Operators
+
+## A `FlatMap` Operator
+
+`flatMap = combine(flat)(map)`
+
+## A `Scan` Operator
+
+```ts
+type Scan<A, T> = (accumulator: A) => (value: T) => A
+type ExclusiveScan<A, T> = [first, Scan<A, T>]
+```
+
+`scan`
+
+`reduce = last(first)(scan)`
+
+An alternative definition of a scan:
+
+```ts
+type Scan2<A, T> = (value: T) => [A, Scan2<A, T>]
+type ExclusiveScan2<A, T> = [first, Scan2<A, T>]
+```
+
+`takeWhile`, `find` can use `scan`. Optimization: if a `Scan2` part is `emptyScan` then we can stop searching.
+
+## A Universal Operator `FlatScan`
+
+```ts
+type FlatScan<A, T> = (value: T) => FlatScanSequence<A, T>
+type FlatScanSequence<A, T> = () => FlatScanResult<A, T>
+type FlatScanResult<A, T> =
+    ['value', A, FlatScanSequence<A, T>] | 
+    ['novalue', FlatScan<A, T>]
+```
+
+Optimization: if result is `empty`, then we can stop.
+
+```ts
+const empty = ['novalue', () => empty]
+```