@thi.ng/grid-iterators 4.0.74 → 4.0.75

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:32Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,14 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [4.0.75](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@4.0.75) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- dedupe interleave logic/iteration, add tests ([7bc9f7f](https://github.com/thi-ng/umbrella/commit/7bc9f7f))
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+- internal update floodFill() ([3af4715](https://github.com/thi-ng/umbrella/commit/3af4715))
+
 ### [4.0.71](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@4.0.71) (2024-04-20)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -253,7 +253,7 @@ For Node.js REPL:
 const gi = await import("@thi.ng/grid-iterators");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.58 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.67 KB
 
 ## Dependencies
 

package/clipping.js

@@ -4,8 +4,8 @@ function* clipped(src, left, top, right, bottom) {
       yield p;
   }
 }
-const axis = (a, b, c) => (a < b ? a - b : a > b + c ? a - b - c : 0) ** 2;
-const intersectRectCircle = (x, y, w, h, cx, cy, r) => axis(cx, x, w) + axis(cy, y, h) <= r * r;
+const __axis = (a, b, c) => (a < b ? a - b : a > b + c ? a - b - c : 0) ** 2;
+const intersectRectCircle = (x, y, w, h, cx, cy, r) => __axis(cx, x, w) + __axis(cy, y, h) <= r * r;
 const liangBarsky = (ax, ay, bx, by, minx, miny, maxx, maxy) => {
   const dx = bx - ax;
   const dy = by - ay;

package/diagonal-slope.d.ts

@@ -12,11 +12,13 @@ export interface DiagonalSlopeOpts extends GridIterOpts2D {
  * step in -x direction.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/diagonal-slopey.ts
  * import { diagonalSlopeY } from "@thi.ng/grid-iterators";
  *
  * // iterate grid in diagonals of 1:3 ratio (x:y)
- * [...diagonalSlopeY({ cols: 5, step: 3 })]
+ * console.log(
+ *   [...diagonalSlopeY({ cols: 5, rows: 5, slope: 3 })]
+ * );
  * // [
  * //   [0, 0], [0, 1 ], [0, 2 ],
  * //   [1, 0], [1, 1 ], [1, 2 ],

package/diamond-square.d.ts

@@ -8,11 +8,13 @@
  * Reference: https://en.wikipedia.org/wiki/Diamond-square_algorithm
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/diamond-square.ts
  * import { diamondSquare } from "@thi.ng/grid-iterators";
  *
  * // generate coords for a 17x17 grid
- * [...diamondSquare(4)]
+ * console.log(
+ *   [...diamondSquare(4)]
+ * );
  * // [
  * //   [0, 0],  [16, 0], [16, 16], [0, 16], [8, 0],  [8, 16],
  * //   [16, 8], [0, 8],  [8, 8],   [4, 0],  [12, 0], [12, 16],

package/flood-fill.d.ts

@@ -11,7 +11,7 @@ import type { Predicate2 } from "@thi.ng/api";
  * Grid cells are visited max. once. A bit field is used to mark visited cells.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/flood-fill.ts
  * import { floodFill } from "@thi.ng/grid-iterators";
  *
  * const img = [
@@ -22,7 +22,9 @@ import type { Predicate2 } from "@thi.ng/api";
  * ];
  *
  * // flood fill connected region from point (2,1)
- * [...floodFill((x, y) => img[y * 4 + x] === 0, 2, 1, 4, 4)]
+ * console.log(
+ *   [...floodFill((x, y) => img[y * 4 + x] === 0, 2, 1, 4, 4)]
+ * );
  * // [
  * //   [2, 1], [1, 1], [0, 1], [3, 1], [3, 2],
  * //   [3, 0], [0, 2], [0, 3], [1, 0]

package/flood-fill.js

@@ -6,13 +6,20 @@ function* floodFill(pred, x, y, width, height) {
   const queue = [[x, y]];
   const visited = defBitField(width * height);
   height--;
+  const state = { pred, queue, visited, width, height };
   while (queue.length) {
     [x, y] = queue.pop();
-    yield* partialRow(pred, queue, visited, x, y, width, height, -1);
-    yield* partialRow(pred, queue, visited, x + 1, y, width, height, 1);
+    yield* __partialRow(state, x, y, -1);
+    yield* __partialRow(state, x + 1, y, 1);
   }
 }
-function* partialRow(pred, queue, visited, x, y, width, height1, step) {
+function* __partialRow({
+  pred,
+  queue,
+  visited,
+  width,
+  height
+}, x, y, step) {
   let idx = y * width + x;
   if (visited.at(idx)) return;
   let scanUp = false;
@@ -28,7 +35,7 @@ function* partialRow(pred, queue, visited, x, y, width, height1, step) {
         scanUp = false;
       }
     }
-    if (y < height1) {
+    if (y < height) {
       if (pred(x, y + 1) && !scanDown) {
         queue.push([x, y + 1]);
         scanDown = true;

package/interleave.d.ts

@@ -22,7 +22,7 @@ export interface InterleaveOpts2D extends GridIterOpts2D {
  *
  * @param opts -
  */
-export declare function interleaveColumns2d(opts: InterleaveOpts2D): Generator<import("./api.js").GridCoord2D, void, undefined>;
+export declare const interleaveColumns2d: (opts: InterleaveOpts2D) => Generator<import("./api.js").GridCoord2D, void, undefined>;
 /**
  * Similar to {@link interleaveColumns2d}, but yields 2D grid coordinates in
  * the order of interleaved rows with configurable `step` size (default:
@@ -37,5 +37,6 @@ export declare function interleaveColumns2d(opts: InterleaveOpts2D): Generator<i
  *
  * @param opts -
  */
-export declare function interleaveRows2d(opts: InterleaveOpts2D): Generator<import("./api.js").GridCoord2D, void, undefined>;
+export declare const interleaveRows2d: (opts: InterleaveOpts2D) => Generator<import("./api.js").GridCoord2D, void, undefined>;
+export declare function __interleave(opts: InterleaveOpts2D, order: [number, number], [x, y]: [number, number]): Generator<import("./api.js").GridCoord2D, void, undefined>;
 //# sourceMappingURL=interleave.d.ts.map

package/interleave.js

@@ -1,21 +1,18 @@
 import { map } from "@thi.ng/transducers/map";
 import { range2d } from "@thi.ng/transducers/range2d";
 import { __opts } from "./utils.js";
-function* interleaveColumns2d(opts) {
+const interleaveColumns2d = (opts) => __interleave(opts, [0, 1], [1, 0]);
+const interleaveRows2d = (opts) => __interleave(opts, [1, 0], [0, 1]);
+function* __interleave(opts, order, [x, y]) {
   const { cols, rows, tx } = __opts(opts);
-  const step = (opts.step != null ? opts.step : 2) | 0;
+  const step = (opts.step ?? 2) | 0;
+  const [outer, inner] = order.map((x2) => [cols, rows][x2]);
   for (let j = 0; j < step; j++) {
-    yield* map((p) => tx(p[1], p[0]), range2d(0, rows, j, cols, 1, step));
-  }
-}
-function* interleaveRows2d(opts) {
-  const { cols, rows, tx } = __opts(opts);
-  const step = (opts.step != null ? opts.step : 2) | 0;
-  for (let j = 0; j < step; j++) {
-    yield* map((p) => tx(p[0], p[1]), range2d(0, cols, j, rows, 1, step));
+    yield* map((p) => tx(p[x], p[y]), range2d(0, inner, j, outer, 1, step));
   }
 }
 export {
+  __interleave,
   interleaveColumns2d,
   interleaveRows2d
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/grid-iterators",
-  "version": "4.0.74",
+  "version": "4.0.75",
   "description": "2D grid and shape iterators w/ multiple orderings",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/grid-iterators#readme",
+  "homepage": "https://thi.ng/grid-iterators",
   "funding": [
     {
       "type": "github",
@@ -38,20 +38,20 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2",
-    "@thi.ng/arrays": "^2.9.6",
-    "@thi.ng/binary": "^3.4.25",
-    "@thi.ng/bitfield": "^2.3.41",
-    "@thi.ng/errors": "^2.5.7",
-    "@thi.ng/morton": "^3.1.86",
-    "@thi.ng/random": "^3.8.0",
-    "@thi.ng/transducers": "^9.0.5"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/arrays": "^2.9.7",
+    "@thi.ng/binary": "^3.4.26",
+    "@thi.ng/bitfield": "^2.3.42",
+    "@thi.ng/errors": "^2.5.8",
+    "@thi.ng/morton": "^3.1.87",
+    "@thi.ng/random": "^3.8.1",
+    "@thi.ng/transducers": "^9.0.6"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "esbuild": "^0.21.1",
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "2d",
@@ -166,5 +166,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }