@thi.ng/grid-iterators 4.0.73 → 4.0.75

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-23T07:02:18Z
+- **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/circle.js

@@ -3,8 +3,7 @@ import { clipped, intersectRectCircle } from "./clipping.js";
 import { hline } from "./hvline.js";
 function* circle(cx, cy, r, fill = true) {
   [cx, cy, r] = asInt(cx, cy, r);
-  if (r < 1)
-    return;
+  if (r < 1) return;
   let x = 0;
   let y = r;
   let y2 = r * r;
@@ -14,25 +13,20 @@ function* circle(cx, cy, r, fill = true) {
   while (x <= y) {
     if (fill) {
       yield* hline(cx - y, cy + x, y << 1);
-      if (x)
-        yield* hline(cx - y, cy - x, y << 1);
+      if (x) yield* hline(cx - y, cy - x, y << 1);
     } else {
       yield [cx - y, cy + x];
-      if (y)
-        yield [cx + y, cy + x];
+      if (y) yield [cx + y, cy + x];
       if (x) {
         yield [cx - y, cy - x];
-        if (y)
-          yield [cx + y, cy - x];
+        if (y) yield [cx + y, cy - x];
       }
       if (x !== y) {
         yield [cx - x, cy - y];
-        if (x)
-          yield [cx + x, cy - y];
+        if (x) yield [cx + x, cy - y];
         if (y) {
           yield [cx - x, cy + y];
-          if (x)
-            yield [cx + x, cy + y];
+          if (x) yield [cx + x, cy + y];
         }
       }
     }
@@ -40,8 +34,7 @@ function* circle(cx, cy, r, fill = true) {
     if (sum <= y2) {
       if (fill && x !== y) {
         yield* hline(cx - x, cy - y, x << 1);
-        if (y)
-          yield* hline(cx - x, cy + y, x << 1);
+        if (y) yield* hline(cx - x, cy + y, x << 1);
       }
       y--;
       y2 -= dy2;

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;
@@ -14,13 +14,11 @@ const liangBarsky = (ax, ay, bx, by, minx, miny, maxx, maxy) => {
   const clip = (p, q) => {
     if (p < 0) {
       const r = q / p;
-      if (r > beta)
-        return false;
+      if (r > beta) return false;
       r > alpha && (alpha = r);
     } else if (p > 0) {
       const r = q / p;
-      if (r < alpha)
-        return false;
+      if (r < alpha) return false;
       r < beta && (beta = r);
     } else if (q < 0) {
       return false;

package/diagonal-ends.js

@@ -10,8 +10,7 @@ function* diagonalEnds2d(opts) {
   for (let p of diagonal2d({ cols, rows })) {
     if (check(i)) {
       const [x, y] = p;
-      if (x === 0 || x === maxX || y === 0 || y === maxY)
-        yield tx(x, y);
+      if (x === 0 || x === maxX || y === 0 || y === maxY) yield tx(x, y);
     }
     i++;
   }

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/diagonal-slope.js

@@ -15,24 +15,19 @@ function* diagonalSlopeY(opts) {
     n = slope;
     x = nx;
     y = ny;
-    if (nx < maxX)
-      nx++;
-    else
-      ny += slope;
+    if (nx < maxX) nx++;
+    else ny += slope;
   };
   for (let i = 0; i <= num; i++) {
     yield tx(x, y);
     if (--n > 0) {
       y++;
-      if (y >= rows)
-        reset();
+      if (y >= rows) reset();
     } else {
       x--;
       y++;
-      if (x < 0 || y >= rows)
-        reset();
-      else
-        n = slope;
+      if (x < 0 || y >= rows) reset();
+      else n = slope;
     }
   }
 }
@@ -62,15 +57,12 @@ function* diagonalSlopeX(opts) {
     yield tx(x, y);
     if (--n > 0) {
       x--;
-      if (x < 0)
-        reset();
+      if (x < 0) reset();
     } else {
       x--;
       y++;
-      if (x < 0 || y >= rows)
-        reset();
-      else
-        n = slope;
+      if (x < 0 || y >= rows) reset();
+      else n = slope;
     }
   }
 }

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

@@ -2,21 +2,26 @@ import { BitField, defBitField } from "@thi.ng/bitfield/bitfield";
 function* floodFill(pred, x, y, width, height) {
   x |= 0;
   y |= 0;
-  if (!pred(x, y))
-    return;
+  if (!pred(x, y)) return;
   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;
+  if (visited.at(idx)) return;
   let scanUp = false;
   let scanDown = false;
   while (x >= 0 && x < width && pred(x, y)) {
@@ -30,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/hilbert.js

@@ -3,8 +3,7 @@ function* hilbert2d(opts) {
   const { cols, rows, tx } = __opts(opts);
   let hIndex = 0;
   let hOrder = 0;
-  while ((1 << hOrder < cols || 1 << hOrder < rows) && hOrder < 15)
-    hOrder++;
+  while ((1 << hOrder < cols || 1 << hOrder < rows) && hOrder < 15) hOrder++;
   const numBuckets = 1 << 2 * hOrder;
   for (let i = 0, n = cols * rows; i < n; i++) {
     let hx, hy;

package/hvline.js

@@ -13,8 +13,7 @@ function* vline(x, y, len) {
 }
 function* hlineClipped(x, y, len, left, top, right, bottom) {
   [x, y, len] = asInt(x, y, len);
-  if (x >= right || y < top || y >= bottom)
-    return;
+  if (x >= right || y < top || y >= bottom) return;
   if (x < left) {
     len += x - left;
     x = left;
@@ -23,8 +22,7 @@ function* hlineClipped(x, y, len, left, top, right, bottom) {
 }
 function* vlineClipped(x, y, len, left, top, right, bottom) {
   [x, y, len] = asInt(x, y, len);
-  if (x < left || x >= right || y >= bottom)
-    return;
+  if (x < left || x >= right || y >= bottom) return;
   if (y < top) {
     len += y - top;
     y = top;

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/line.js

@@ -9,8 +9,7 @@ function* line(ax, ay, bx, by) {
   let err = dx + dy;
   while (true) {
     yield [ax, ay];
-    if (ax === bx && ay === by)
-      return;
+    if (ax === bx && ay === by) return;
     let t = err << 1;
     if (t < dx) {
       err += dx;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/grid-iterators",
-  "version": "4.0.73",
+  "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.1",
-    "@thi.ng/arrays": "^2.9.5",
-    "@thi.ng/binary": "^3.4.24",
-    "@thi.ng/bitfield": "^2.3.40",
-    "@thi.ng/errors": "^2.5.6",
-    "@thi.ng/morton": "^3.1.85",
-    "@thi.ng/random": "^3.7.5",
-    "@thi.ng/transducers": "^9.0.4"
+    "@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.0",
-    "esbuild": "^0.20.2",
-    "typedoc": "^0.25.12",
-    "typescript": "^5.4.3"
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "2d",
@@ -166,5 +166,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "aed3421c21044c005fbcb7cc37965ccf85a870d2\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }