@thi.ng/grid-iterators 2.3.24 → 2.3.26

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-11-30T22:27:37Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![grid-iterators](https://media.thi.ng/umbrella/banners-20220914/thing-grid-iterators.svg?9ea1cbba)
+# ![@thi.ng/grid-iterators](https://media.thi.ng/umbrella/banners-20220914/thing-grid-iterators.svg?9ea1cbba)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/grid-iterators.svg)](https://www.npmjs.com/package/@thi.ng/grid-iterators)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/grid-iterators.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -35,7 +35,7 @@ This project is part of the
 
 ## About
 
-2D grid and shape iterators w/ multiple orderings.
+2D grid and shape iterators w/ multiple orderings
 
 Provides the altogether 25 following orderings to generate grid coordinates,
 including iterators for shape rasterization, drawing, clipping, filling,
@@ -218,11 +218,8 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const gridIterators = await import("@thi.ng/grid-iterators");
+```js
+const gridIterators = await import("@thi.ng/grid-iterators");
 ```
 
 Package sizes (brotli'd, pre-treeshake): ESM: 2.19 KB
@@ -268,7 +265,7 @@ import * as gi from "@thi.ng/grid-iterators";
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -283,4 +280,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2019 - 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2019 - 2022 Karsten Schmidt // Apache License 2.0

package/clipping.d.ts

@@ -11,7 +11,8 @@ import type { FnU7, FnU8, Tuple } from "@thi.ng/api";
  */
 export declare function clipped(src: Iterable<number[]>, left: number, top: number, right: number, bottom: number): Generator<number[], void, unknown>;
 /**
- * Based on {@link @thi.ng/geom-isec}, but inlined to avoid dependency.
+ * Based on [thi.ng/geom-isec](https://thi.ng/geom-isec), but inlined to avoid
+ * dependency.
  *
  * @param x -
  * @param y -
@@ -25,7 +26,7 @@ export declare function clipped(src: Iterable<number[]>, left: number, top: numb
  */
 export declare const intersectRectCircle: FnU7<number, boolean>;
 /**
- * Based on {@link @thi.ng/geom-clip-line#liangBarsky2Raw}, but with diff return type.
+ * Based on [`liangBarsky2Raw()`](https://docs.thi.ng/umbrella/geom-clip-line/functions/liangBarsky2Raw.html), but with diff return type.
  *
  * @param ax -
  * @param ay -

package/clipping.js

@@ -17,7 +17,8 @@ export function* clipped(src, left, top, right, bottom) {
 /** @internal */
 const axis = (a, b, c) => (a < b ? a - b : a > b + c ? a - b - c : 0) ** 2;
 /**
- * Based on {@link @thi.ng/geom-isec}, but inlined to avoid dependency.
+ * Based on [thi.ng/geom-isec](https://thi.ng/geom-isec), but inlined to avoid
+ * dependency.
  *
  * @param x -
  * @param y -
@@ -31,7 +32,7 @@ const axis = (a, b, c) => (a < b ? a - b : a > b + c ? a - b - c : 0) ** 2;
  */
 export const intersectRectCircle = (x, y, w, h, cx, cy, r) => axis(cx, x, w) + axis(cy, y, h) <= r * r;
 /**
- * Based on {@link @thi.ng/geom-clip-line#liangBarsky2Raw}, but with diff return type.
+ * Based on [`liangBarsky2Raw()`](https://docs.thi.ng/umbrella/geom-clip-line/functions/liangBarsky2Raw.html), but with diff return type.
  *
  * @param ax -
  * @param ay -

package/diagonal.d.ts

@@ -1,10 +1,10 @@
 /**
- * Yields sequence of 2D grid coordinates in diagonal order starting at
- * [0,0] and using given `cols` and `rows`. Each diagonal starts at y=0
- * and progresses in -x,+y direction.
+ * Yields sequence of 2D grid coordinates in diagonal order starting at [0,0]
+ * and using given `cols` and `rows`. Each diagonal starts at y=0 and progresses
+ * in -x,+y direction.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/DiagonalBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/DiagonalBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/diagonal.js

@@ -1,11 +1,11 @@
 import { asInt } from "@thi.ng/api/typedarray";
 /**
- * Yields sequence of 2D grid coordinates in diagonal order starting at
- * [0,0] and using given `cols` and `rows`. Each diagonal starts at y=0
- * and progresses in -x,+y direction.
+ * Yields sequence of 2D grid coordinates in diagonal order starting at [0,0]
+ * and using given `cols` and `rows`. Each diagonal starts at y=0 and progresses
+ * in -x,+y direction.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/DiagonalBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/DiagonalBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/hilbert.d.ts

@@ -1,9 +1,9 @@
 /**
- * Yields sequence of 2D grid coordinates along 2D Hilbert curve using
- * given `cols` and `rows` (each max. 32768 (2^15)).
+ * Yields sequence of 2D grid coordinates along 2D Hilbert curve using given
+ * `cols` and `rows` (each max. 32768 (2^15)).
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/HilbertBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/HilbertBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/hilbert.js

@@ -1,10 +1,10 @@
 import { asInt } from "@thi.ng/api/typedarray";
 /**
- * Yields sequence of 2D grid coordinates along 2D Hilbert curve using
- * given `cols` and `rows` (each max. 32768 (2^15)).
+ * Yields sequence of 2D grid coordinates along 2D Hilbert curve using given
+ * `cols` and `rows` (each max. 32768 (2^15)).
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/HilbertBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/HilbertBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/grid-iterators",
-  "version": "2.3.24",
+  "version": "2.3.26",
   "description": "2D grid and shape iterators w/ multiple orderings",
   "type": "module",
   "module": "./index.js",
@@ -21,12 +21,12 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
     "build:assets": "node tools/build-assets",
-    "clean": "rimraf '*.js' '*.d.ts' '*.map' doc",
+    "clean": "rimraf '*.js' '*.d.ts' '*.map' doc internal",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "yarn doc:stats && tools:readme",
@@ -35,21 +35,21 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/arrays": "^2.4.4",
-    "@thi.ng/binary": "^3.3.12",
-    "@thi.ng/bitfield": "^2.2.14",
-    "@thi.ng/morton": "^3.1.23",
-    "@thi.ng/random": "^3.3.17",
-    "@thi.ng/transducers": "^8.3.25"
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/arrays": "^2.4.6",
+    "@thi.ng/binary": "^3.3.14",
+    "@thi.ng/bitfield": "^2.2.16",
+    "@thi.ng/morton": "^3.1.25",
+    "@thi.ng/random": "^3.3.19",
+    "@thi.ng/transducers": "^8.3.27"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "2d",
@@ -152,5 +152,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }

package/random.d.ts

@@ -1,8 +1,10 @@
 import type { IRandom } from "@thi.ng/random";
 /**
  * Yields 2D grid coordinates in random order w/ support for optional
- * {@link @thi.ng/random#IRandom} implementation (default:
- * {@link @thi.ng/random#SYSTEM} aka `Math.random`).
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
+ * implementation (default:
+ * [`SYSTEM`](https://docs.thi.ng/umbrella/random/variables/SYSTEM.html) aka
+ * `Math.random`).
  *
  * @param cols -
  * @param rows -

package/random.js

@@ -4,8 +4,10 @@ import { SYSTEM } from "@thi.ng/random/system";
 import { range } from "@thi.ng/transducers/range";
 /**
  * Yields 2D grid coordinates in random order w/ support for optional
- * {@link @thi.ng/random#IRandom} implementation (default:
- * {@link @thi.ng/random#SYSTEM} aka `Math.random`).
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
+ * implementation (default:
+ * [`SYSTEM`](https://docs.thi.ng/umbrella/random/variables/SYSTEM.html) aka
+ * `Math.random`).
  *
  * @param cols -
  * @param rows -

package/rows.d.ts

@@ -1,6 +1,6 @@
 /**
  * Yields sequence of 2D grid coordinates in row-major order. Same as
- * {@link @thi.ng/transducers#range2d}.
+ * [`range2d()`](https://docs.thi.ng/umbrella/transducers/functions/range2d.html).
  *
  * @param cols -
  * @param rows -

package/rows.js

@@ -1,7 +1,7 @@
 import { range2d } from "@thi.ng/transducers/range2d";
 /**
  * Yields sequence of 2D grid coordinates in row-major order. Same as
- * {@link @thi.ng/transducers#range2d}.
+ * [`range2d()`](https://docs.thi.ng/umbrella/transducers/functions/range2d.html).
  *
  * @param cols -
  * @param rows -

package/spiral.d.ts

@@ -1,9 +1,9 @@
 /**
- * Yields sequence of 2D grid coordinates in outward spiral order
- * starting from the center, given `cols` and `rows`.
+ * Yields sequence of 2D grid coordinates in outward spiral order starting from
+ * the center, given `cols` and `rows`.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/spiral.js

@@ -1,10 +1,10 @@
 import { asInt } from "@thi.ng/api/typedarray";
 /**
- * Yields sequence of 2D grid coordinates in outward spiral order
- * starting from the center, given `cols` and `rows`.
+ * Yields sequence of 2D grid coordinates in outward spiral order starting from
+ * the center, given `cols` and `rows`.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/zigzag-columns.d.ts

@@ -1,9 +1,9 @@
 /**
- * Yields sequence of 2D grid coordinates in zigzag column order
- * starting from [0,0], given `cols` and `rows`.
+ * Yields sequence of 2D grid coordinates in zigzag column order starting from
+ * [0,0], given `cols` and `rows`.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/zigzag-columns.js

@@ -1,10 +1,10 @@
 import { asInt } from "@thi.ng/api/typedarray";
 /**
- * Yields sequence of 2D grid coordinates in zigzag column order
- * starting from [0,0], given `cols` and `rows`.
+ * Yields sequence of 2D grid coordinates in zigzag column order starting from
+ * [0,0], given `cols` and `rows`.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/zigzag-rows.d.ts

@@ -1,9 +1,9 @@
 /**
- * Yields sequence of 2D grid coordinates in zigzag row order starting
- * from [0,0], given `cols` and `rows`.
+ * Yields sequence of 2D grid coordinates in zigzag row order starting from
+ * [0,0], given `cols` and `rows`.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
  * @param cols -
  * @param rows -

package/zigzag-rows.js

@@ -1,10 +1,10 @@
 import { asInt } from "@thi.ng/api/typedarray";
 /**
- * Yields sequence of 2D grid coordinates in zigzag row order starting
- * from [0,0], given `cols` and `rows`.
+ * Yields sequence of 2D grid coordinates in zigzag row order starting from
+ * [0,0], given `cols` and `rows`.
  *
  * Ported & modified from original Java code by Christopher Kulla.
- * {@link https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java}
+ * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
  * @param cols -
  * @param rows -