@thi.ng/grid-iterators 2.3.26 → 3.0.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-20T16:33:11Z
+- **Last updated**: 2022-12-22T21:47:07Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,21 @@ 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.
 
+# [3.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@3.0.0) (2022-12-22)
+
+#### 🛑 Breaking changes
+
+- add point transforms & global options ([1861154](https://github.com/thi-ng/umbrella/commit/1861154))
+- BREAKING CHANGE: update function signatures, switch to using options object as arg
+  - add `GridIterOpts` interface
+  - add `PointTransform` and implementations:
+  - add flipX/Y/XY, swapXY transforms
+  - update most iterators to use new options
+
+#### 🩹 Bug fixes
+
+- fix imports ([d4cede6](https://github.com/thi-ng/umbrella/commit/d4cede6))
+
 ## [2.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@2.3.0) (2022-04-07)
 
 #### 🚀 Features

package/README.md

@@ -22,8 +22,9 @@ This project is part of the
   - [Zigzag columns](#zigzag-columns)
   - [Zigzag diagonal](#zigzag-diagonal)
   - [Zigzag rows](#zigzag-rows)
+  - [Mirror symmetries & arbitrary coordinate transformations](#mirror-symmetries--arbitrary-coordinate-transformations)
   - [Flood filling](#flood-filling)
-  - [Miscellaneous](#miscellaneous)
+  - [Shape iterators](#shape-iterators)
 - [Status](#status)
 - [Related packages](#related-packages)
 - [Installation](#installation)
@@ -35,11 +36,11 @@ 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,
-processing in general:
+Provides the altogether 25 following orderings (excluding symmetries) to
+generate grid coordinates, including iterators for shape rasterization, drawing,
+clipping, filling, processing in general:
 
 ### Columns
 
@@ -140,6 +141,15 @@ For more basic 2D/3D grid iteration, also see `range2d()` & `range3d()`
 in
 [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers).
 
+### Mirror symmetries & arbitrary coordinate transformations
+
+All of the above mentioned grid iterators support point (grid coordinate)
+transformations to create variations of their base orderings. The package
+provides the `flipX`, `flipY` and `flipXY` preset transforms to mirror one or
+both axes, but custom transforms can be easily implemented via the same
+underlying mechanism. These transforms can be specified via the `tx` option
+passed to the iterators (see code example further below).
+
 ### Flood filling
 
 The `floodFill()` iterator can be used to iterate arbitrary 2D grids using an
@@ -180,7 +190,7 @@ img
 // ]
 ```
 
-### Miscellaneous
+### Shape iterators
 
 Additionally, the following shape iterators are available, all also with
 optional clipping:
@@ -222,7 +232,7 @@ For Node.js REPL:
 const gridIterators = await import("@thi.ng/grid-iterators");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.19 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.31 KB
 
 ## Dependencies
 
@@ -253,7 +263,7 @@ A selection:
 ```ts
 import * as gi from "@thi.ng/grid-iterators";
 
-[...gi.zigzagRows2d(4, 4)]
+[...gi.zigzagRows2d({ cols: 4, rows: 4 })]
 
 // [
 //   [ 0, 0 ], [ 1, 0 ], [ 2, 0 ], [ 3, 0 ],
@@ -261,6 +271,15 @@ import * as gi from "@thi.ng/grid-iterators";
 //   [ 0, 2 ], [ 1, 2 ], [ 2, 2 ], [ 3, 2 ],
 //   [ 3, 3 ], [ 2, 3 ], [ 1, 3 ], [ 0, 3 ]
 // ]
+
+// with applied horizontal mirroring
+[...gi.zigzagRows2d({ cols: 4, tx: gi.flipX })]
+// [
+//   [ 3, 0 ], [ 2, 0 ], [ 1, 0 ], [ 0, 0 ],
+//   [ 0, 1 ], [ 1, 1 ], [ 2, 1 ], [ 3, 1 ],
+//   [ 3, 2 ], [ 2, 2 ], [ 1, 2 ], [ 0, 2 ],
+//   [ 0, 3 ], [ 1, 3 ], [ 2, 3 ], [ 3, 3 ]
+// ]
 ```
 
 ## Authors

package/api.d.ts

@@ -0,0 +1,25 @@
+import type { FnU2 } from "@thi.ng/api";
+/**
+ * Higher order point coordinate transformation function. First is called with
+ * grid resolution (cols,rows), then returns a function which is applied to each
+ * generated grid coordinate.
+ */
+export type PointTransform = FnU2<number, FnU2<number, [number, number]>>;
+export interface GridIterOpts {
+    /**
+     * Number of grid columns
+     */
+    cols: number;
+    /**
+     * Number of grid rows, by default same as columns.
+     */
+    rows?: number;
+    /**
+     * Point coordinate transformation function, e.g. to mirror iteration order
+     * along X or Y. See {@link flipX}, {@link flipY}, {@link flipXY} etc.
+     *
+     * @defaultValue {@link ident}
+     */
+    tx?: PointTransform;
+}
+//# sourceMappingURL=api.d.ts.map

package/api.js

@@ -0,0 +1 @@
+export {};

package/column-ends.d.ts

@@ -1,9 +1,9 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Filtered version of {@link columns2d}, only including end points of
  * each column.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function columnEnds2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function columnEnds2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=column-ends.d.ts.map

package/column-ends.js

@@ -1,16 +1,15 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Filtered version of {@link columns2d}, only including end points of
  * each column.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* columnEnds2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* columnEnds2d(opts) {
+    let { cols, rows, tx } = __opts(opts);
     rows--;
     for (let x = 0; x < cols; x++) {
-        yield [x, 0];
-        yield [x, rows];
+        yield tx(x, 0);
+        yield tx(x, rows);
     }
 }

package/columns.d.ts

@@ -1,8 +1,8 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields sequence of 2D grid coordinates in column-major order.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare const columns2d: (cols: number, rows?: number) => IterableIterator<number[]>;
+export declare const columns2d: (opts: GridIterOpts) => IterableIterator<[number, number]>;
 //# sourceMappingURL=columns.d.ts.map

package/columns.js

@@ -1,10 +1,12 @@
-import { range2d } from "@thi.ng/transducers/range2d";
 import { map } from "@thi.ng/transducers/map";
-import { swapxy } from "./utils.js";
+import { range2d } from "@thi.ng/transducers/range2d";
+import { __opts } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates in column-major order.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export const columns2d = (cols, rows = cols) => map(swapxy, range2d(rows | 0, cols | 0));
+export const columns2d = (opts) => {
+    const { cols, rows, tx } = __opts(opts);
+    return map((p) => tx(p[1], p[0]), range2d(rows | 0, cols | 0));
+};

package/diagonal-ends.d.ts

@@ -1,3 +1,4 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Filtered version of {@link diagonal2d}, only including end points of
  * the diagonals, apart from the very first and last points: `[0,0]` and
@@ -6,8 +7,7 @@
  * @remarks
  * `cols` and `rows` MUST be both >= 2.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function diagonalEnds2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function diagonalEnds2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=diagonal-ends.d.ts.map

package/diagonal-ends.js

@@ -1,5 +1,5 @@
-import { asInt } from "@thi.ng/api/typedarray";
 import { diagonal2d } from "./diagonal.js";
+import { __opts } from "./utils.js";
 /**
  * Filtered version of {@link diagonal2d}, only including end points of
  * the diagonals, apart from the very first and last points: `[0,0]` and
@@ -8,20 +8,19 @@ import { diagonal2d } from "./diagonal.js";
  * @remarks
  * `cols` and `rows` MUST be both >= 2.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* diagonalEnds2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* diagonalEnds2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const num = cols * rows - 1;
     const maxX = cols - 1;
     const maxY = rows - 1;
     let i = 0;
-    for (let p of diagonal2d(cols, rows)) {
+    for (let p of diagonal2d({ cols, rows })) {
         if (i > 0 && i < num) {
             const [x, y] = p;
             if (x === 0 || x === maxX || y === 0 || y === maxY)
-                yield p;
+                yield tx(x, y);
         }
         i++;
     }

package/diagonal.d.ts

@@ -1,3 +1,4 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * 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
@@ -6,8 +7,7 @@
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/DiagonalBucketOrder.java
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function diagonal2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function diagonal2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=diagonal.d.ts.map

package/diagonal.js

@@ -1,4 +1,4 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * 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
@@ -7,14 +7,13 @@ import { asInt } from "@thi.ng/api/typedarray";
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/DiagonalBucketOrder.java
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* diagonal2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* diagonal2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const num = cols * rows - 1;
     for (let x = 0, y = 0, nx = 1, ny = 0, i = 0; i <= num; i++) {
-        yield [x, y];
+        yield tx(x, y);
         if (i != num) {
             do {
                 if (y === ny) {

package/hilbert.d.ts

@@ -1,3 +1,4 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields sequence of 2D grid coordinates along 2D Hilbert curve using given
  * `cols` and `rows` (each max. 32768 (2^15)).
@@ -5,8 +6,7 @@
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/HilbertBucketOrder.java
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function hilbert2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function hilbert2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=hilbert.d.ts.map

package/hilbert.js

@@ -1,4 +1,4 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates along 2D Hilbert curve using given
  * `cols` and `rows` (each max. 32768 (2^15)).
@@ -6,11 +6,10 @@ import { asInt } from "@thi.ng/api/typedarray";
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/HilbertBucketOrder.java
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* hilbert2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* hilbert2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     let hIndex = 0; // hilbert curve index
     let hOrder = 0; // hilbert curve order
     // fit to number of buckets
@@ -61,6 +60,6 @@ export function* hilbert2d(cols, rows = cols) {
         // Dont't emit any outside cells
         (hx >= cols || hy >= rows || hx < 0 || hy < 0) &&
             hIndex < numBuckets);
-        yield [hx, hy];
+        yield tx(hx, hy);
     }
 }

package/index.d.ts

@@ -14,6 +14,7 @@ export * from "./random.js";
 export * from "./row-ends.js";
 export * from "./rows.js";
 export * from "./spiral.js";
+export * from "./transforms.js";
 export * from "./zcurve.js";
 export * from "./zigzag-columns.js";
 export * from "./zigzag-diagonal.js";

package/index.js

@@ -14,6 +14,7 @@ export * from "./random.js";
 export * from "./row-ends.js";
 export * from "./rows.js";
 export * from "./spiral.js";
+export * from "./transforms.js";
 export * from "./zcurve.js";
 export * from "./zigzag-columns.js";
 export * from "./zigzag-diagonal.js";

package/interleave.d.ts

@@ -1,33 +1,42 @@
+import type { GridIterOpts } from "./api.js";
+interface InterleaveOpts extends GridIterOpts {
+    /**
+     * Row or column stride.
+     *
+     * @defaultValue 2
+     */
+    step?: number;
+}
 /**
  * Yields 2D grid coordinates in the order of interleaved columns with
- * configurable `step` size (default: 2). I.e. returns columns in this
- * order:
+ * configurable `step` size (default: 2).
+ *
+ * @remarks
+ * Returns columns in this order:
  *
  * - 0, step, 2 * step, 3 * step...
  * - 1, 2 * step + 1, 3 * step + 1...
  * - etc.
  *
- * {@link interleaveRows2d}
+ * Also see {@link interleaveRows2d}.
  *
- * @param cols -
- * @param rows -
- * @param step - column stride
+ * @param opts -
  */
-export declare function interleaveColumns2d(cols: number, rows?: number, step?: number): Generator<number[], void, undefined>;
+export declare function interleaveColumns2d(opts: InterleaveOpts): Generator<[number, number], void, undefined>;
 /**
  * Similar to {@link interleaveColumns2d}, but yields 2D grid coordinates in
  * the order of interleaved rows with configurable `step` size (default:
- * 2). I.e. returns rows in this order:
+ * 2).
+ *
+ * @remarks
+ * Returns rows in this order:
  *
  * - 0, step, 2 * step, 3 * step...
  * - 1, 2 * step + 1, 3 * step + 1...
  * - etc.
  *
- * {@link interleaveColumns2d}
- *
- * @param cols -
- * @param rows -
- * @param step - row stride
+ * @param opts -
  */
-export declare function interleaveRows2d(cols: number, rows?: number, step?: number): Generator<[number, number], void, undefined>;
+export declare function interleaveRows2d(opts: InterleaveOpts): Generator<[number, number], void, undefined>;
+export {};
 //# sourceMappingURL=interleave.d.ts.map

package/interleave.js

@@ -1,43 +1,46 @@
-import { range2d } from "@thi.ng/transducers/range2d";
 import { map } from "@thi.ng/transducers/map";
-import { swapxy } from "./utils.js";
+import { range2d } from "@thi.ng/transducers/range2d";
+import { __opts } from "./utils.js";
 /**
  * Yields 2D grid coordinates in the order of interleaved columns with
- * configurable `step` size (default: 2). I.e. returns columns in this
- * order:
+ * configurable `step` size (default: 2).
+ *
+ * @remarks
+ * Returns columns in this order:
  *
  * - 0, step, 2 * step, 3 * step...
  * - 1, 2 * step + 1, 3 * step + 1...
  * - etc.
  *
- * {@link interleaveRows2d}
+ * Also see {@link interleaveRows2d}.
  *
- * @param cols -
- * @param rows -
- * @param step - column stride
+ * @param opts -
  */
-export function* interleaveColumns2d(cols, rows = cols, step = 2) {
+export function* interleaveColumns2d(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(swapxy, range2d(0, rows | 0, j, cols | 0, 1, step | 0));
+        yield* map((p) => tx(p[1], p[0]), range2d(0, rows, j, cols, 1, step));
     }
 }
 /**
  * Similar to {@link interleaveColumns2d}, but yields 2D grid coordinates in
  * the order of interleaved rows with configurable `step` size (default:
- * 2). I.e. returns rows in this order:
+ * 2).
+ *
+ * @remarks
+ * Returns rows in this order:
  *
  * - 0, step, 2 * step, 3 * step...
  * - 1, 2 * step + 1, 3 * step + 1...
  * - etc.
  *
- * {@link interleaveColumns2d}
- *
- * @param cols -
- * @param rows -
- * @param step - row stride
+ * @param opts -
  */
-export function* interleaveRows2d(cols, rows = cols, step = 2) {
+export 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* range2d(0, cols | 0, j, rows | 0, 1, step | 0);
+        yield* map((p) => tx(p[0], p[1]), range2d(0, cols, j, rows, 1, step));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/grid-iterators",
-  "version": "2.3.26",
+  "version": "3.0.0",
   "description": "2D grid and shape iterators w/ multiple orderings",
   "type": "module",
   "module": "./index.js",
@@ -35,17 +35,17 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@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"
+    "@thi.ng/api": "^8.6.2",
+    "@thi.ng/arrays": "^2.4.7",
+    "@thi.ng/binary": "^3.3.15",
+    "@thi.ng/bitfield": "^2.2.17",
+    "@thi.ng/morton": "^3.1.26",
+    "@thi.ng/random": "^3.3.20",
+    "@thi.ng/transducers": "^8.3.28"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.7",
+    "@thi.ng/testament": "^0.3.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.22",
@@ -83,6 +83,9 @@
     ".": {
       "default": "./index.js"
     },
+    "./api": {
+      "default": "./api.js"
+    },
     "./circle": {
       "default": "./circle.js"
     },
@@ -131,6 +134,9 @@
     "./spiral": {
       "default": "./spiral.js"
     },
+    "./transforms": {
+      "default": "./transforms.js"
+    },
     "./zcurve": {
       "default": "./zcurve.js"
     },
@@ -152,5 +158,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
+  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
 }

package/random.d.ts

@@ -1,4 +1,13 @@
 import type { IRandom } from "@thi.ng/random";
+import type { GridIterOpts } from "./api.js";
+interface Random2DOpts extends GridIterOpts {
+    /**
+     * PRNG instance to use
+     *
+     * @defaultValue `SYSTEM`
+     */
+    rnd?: IRandom;
+}
 /**
  * Yields 2D grid coordinates in random order w/ support for optional
  * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
@@ -6,9 +15,8 @@ import type { IRandom } from "@thi.ng/random";
  * [`SYSTEM`](https://docs.thi.ng/umbrella/random/variables/SYSTEM.html) aka
  * `Math.random`).
  *
- * @param cols -
- * @param rows -
- * @param rnd - PRNG
+ * @param opts -
  */
-export declare function random2d(cols: number, rows?: number, rnd?: IRandom): Generator<number[], void, unknown>;
+export declare function random2d(opts: Random2DOpts): Generator<[number, number], void, unknown>;
+export {};
 //# sourceMappingURL=random.d.ts.map

package/random.js

@@ -1,7 +1,7 @@
-import { asInt } from "@thi.ng/api/typedarray";
 import { shuffle } from "@thi.ng/arrays/shuffle";
 import { SYSTEM } from "@thi.ng/random/system";
 import { range } from "@thi.ng/transducers/range";
+import { __opts } from "./utils.js";
 /**
  * Yields 2D grid coordinates in random order w/ support for optional
  * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
@@ -9,13 +9,12 @@ import { range } from "@thi.ng/transducers/range";
  * [`SYSTEM`](https://docs.thi.ng/umbrella/random/variables/SYSTEM.html) aka
  * `Math.random`).
  *
- * @param cols -
- * @param rows -
- * @param rnd - PRNG
+ * @param opts -
  */
-export function* random2d(cols, rows = cols, rnd = SYSTEM) {
-    [cols, rows] = asInt(cols, rows);
+export function* random2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
+    const rnd = opts.rnd || SYSTEM;
     for (let i of shuffle([...range(cols * rows)], undefined, rnd)) {
-        yield [i % cols, (i / cols) | 0];
+        yield tx(i % cols, (i / cols) | 0);
     }
 }

package/row-ends.d.ts

@@ -1,9 +1,9 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Filtered version of {@link rows2d}, only including end points of
  * each row.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function rowEnds2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function rowEnds2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=row-ends.d.ts.map

package/row-ends.js

@@ -1,16 +1,15 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Filtered version of {@link rows2d}, only including end points of
  * each row.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* rowEnds2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* rowEnds2d(opts) {
+    let { cols, rows, tx } = __opts(opts);
     cols--;
     for (let y = 0; y < rows; y++) {
-        yield [0, y];
-        yield [cols, y];
+        yield tx(0, y);
+        yield tx(cols, y);
     }
 }

package/rows.d.ts

@@ -1,9 +1,9 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields sequence of 2D grid coordinates in row-major order. Same as
  * [`range2d()`](https://docs.thi.ng/umbrella/transducers/functions/range2d.html).
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare const rows2d: (cols: number, rows?: number) => IterableIterator<[number, number]>;
+export declare const rows2d: (opts: GridIterOpts) => IterableIterator<[number, number]>;
 //# sourceMappingURL=rows.d.ts.map

package/rows.js

@@ -1,9 +1,13 @@
+import { map } from "@thi.ng/transducers/map";
 import { range2d } from "@thi.ng/transducers/range2d";
+import { __opts } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates in row-major order. Same as
  * [`range2d()`](https://docs.thi.ng/umbrella/transducers/functions/range2d.html).
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export const rows2d = (cols, rows = cols) => range2d(cols | 0, rows | 0);
+export const rows2d = (opts) => {
+    const { cols, rows, tx } = __opts(opts);
+    return map((p) => tx(p[0], p[1]), range2d(cols, rows));
+};

package/spiral.d.ts

@@ -1,3 +1,4 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields sequence of 2D grid coordinates in outward spiral order starting from
  * the center, given `cols` and `rows`.
@@ -5,8 +6,7 @@
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function spiral2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function spiral2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=spiral.d.ts.map

package/spiral.js

@@ -1,4 +1,4 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates in outward spiral order starting from
  * the center, given `cols` and `rows`.
@@ -6,11 +6,10 @@ import { asInt } from "@thi.ng/api/typedarray";
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* spiral2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* spiral2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const num = cols * rows;
     const center = (Math.min(cols, rows) - 1) >> 1;
     for (let i = 0; i < num; i++) {
@@ -44,6 +43,6 @@ export function* spiral2d(cols, rows = cols) {
                 by = -m2;
             }
         }
-        yield [bx + center, by + center];
+        yield tx(bx + center, by + center);
     }
 }

package/transforms.d.ts

@@ -0,0 +1,21 @@
+import type { PointTransform } from "./api.js";
+/**
+ * No-op / identity {@link PointTransform}.
+ */
+export declare const ident: PointTransform;
+export declare const flipX: PointTransform;
+export declare const flipY: PointTransform;
+export declare const flipXY: PointTransform;
+/**
+ * {@link PointTransform} to swaps X & Y coords.
+ */
+export declare const swapXY: PointTransform;
+/**
+ * Higher order {@link PointTransform} to compose given transforms in
+ * left-to-right order.
+ *
+ * @param a
+ * @param b
+ */
+export declare const compTransforms: (a: PointTransform, b: PointTransform) => PointTransform;
+//# sourceMappingURL=transforms.d.ts.map

package/transforms.js

@@ -0,0 +1,23 @@
+/**
+ * No-op / identity {@link PointTransform}.
+ */
+export const ident = () => (x, y) => [x, y];
+export const flipX = (cols) => (x, y) => [cols - 1 - x, y];
+export const flipY = (_, rows) => (x, y) => [x, rows - 1 - y];
+export const flipXY = (cols, rows) => (x, y) => [cols - 1 - x, rows - 1 - y];
+/**
+ * {@link PointTransform} to swaps X & Y coords.
+ */
+export const swapXY = () => (x, y) => [y, x];
+/**
+ * Higher order {@link PointTransform} to compose given transforms in
+ * left-to-right order.
+ *
+ * @param a
+ * @param b
+ */
+export const compTransforms = (a, b) => (cols, rows) => {
+    const $a = a(cols, rows);
+    const $b = b(cols, rows);
+    return (x, y) => $b(...$a(x, y));
+};

package/utils.d.ts

@@ -1,9 +1,7 @@
-/**
- * Swaps XY in-place.
- *
- * @param p -
- *
- * @internal
- */
-export declare const swapxy: (p: number[]) => number[];
+import type { GridIterOpts } from "./api.js";
+export declare const __opts: (opts: GridIterOpts) => {
+    cols: number;
+    rows: number;
+    tx: import("@thi.ng/api").FnU2<number, [number, number]>;
+};
 //# sourceMappingURL=utils.d.ts.map

package/utils.js

@@ -1,14 +1,8 @@
 // thing:no-export
-/**
- * Swaps XY in-place.
- *
- * @param p -
- *
- * @internal
- */
-export const swapxy = (p) => {
-    const t = p[0];
-    p[0] = p[1];
-    p[1] = t;
-    return p;
+import { asInt } from "@thi.ng/api/typedarray";
+import { ident } from "./transforms.js";
+export const __opts = (opts) => {
+    let { cols, rows, tx } = { rows: opts.cols, tx: ident, ...opts };
+    [cols, rows] = asInt(cols, rows);
+    return { cols, rows, tx: tx(cols, rows) };
 };

package/zcurve.d.ts

@@ -1,11 +1,11 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields 2D grid coordinates in Z-curve (Morton) order. A perfect
  * Z-curve is only generated if `cols` AND `rows` are equal and a power
  * of 2. Due to using 32bit morton codes, only supports grid sizes up to
  * 32767 (0x7fff) in either dimension.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function zcurve2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function zcurve2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=zcurve.d.ts.map

package/zcurve.js

@@ -1,22 +1,21 @@
-import { asInt } from "@thi.ng/api/typedarray";
 import { ceilPow2 } from "@thi.ng/binary/pow";
 import { demux2 } from "@thi.ng/morton/mux";
+import { __opts } from "./utils.js";
 /**
  * Yields 2D grid coordinates in Z-curve (Morton) order. A perfect
  * Z-curve is only generated if `cols` AND `rows` are equal and a power
  * of 2. Due to using 32bit morton codes, only supports grid sizes up to
  * 32767 (0x7fff) in either dimension.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* zcurve2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* zcurve2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const max = ceilPow2(Math.pow(Math.max(cols, rows), 2));
     for (let i = 0; i < max; i++) {
-        const p = demux2(i);
-        if (p[0] < cols && p[1] < rows) {
-            yield p;
+        const [x, y] = demux2(i);
+        if (x < cols && y < rows) {
+            yield tx(x, y);
         }
     }
 }

package/zigzag-columns.d.ts

@@ -1,3 +1,4 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields sequence of 2D grid coordinates in zigzag column order starting from
  * [0,0], given `cols` and `rows`.
@@ -5,9 +6,7 @@
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
- * @param cols -
- * @param rows -
- *
+ * @param opts -
  */
-export declare function zigzagColumns2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function zigzagColumns2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=zigzag-columns.d.ts.map

package/zigzag-columns.js

@@ -1,4 +1,4 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates in zigzag column order starting from
  * [0,0], given `cols` and `rows`.
@@ -6,17 +6,15 @@ import { asInt } from "@thi.ng/api/typedarray";
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
- * @param cols -
- * @param rows -
- *
+ * @param opts -
  */
-export function* zigzagColumns2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* zigzagColumns2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const num = cols * rows;
     for (let i = 0; i < num; i++) {
         const x = (i / rows) | 0;
         let y = i % rows;
         x & 1 && (y = rows - 1 - y);
-        yield [x, y];
+        yield tx(x, y);
     }
 }

package/zigzag-diagonal.d.ts

@@ -1,9 +1,9 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Similar to {@link diagonal2d}, but yields 2D grid coordinates in zigzag
  * diagonal order starting at [0,0] and using given `cols` and `rows`.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export declare function zigzagDiagonal2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function zigzagDiagonal2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=zigzag-diagonal.d.ts.map

package/zigzag-diagonal.js

@@ -1,16 +1,15 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Similar to {@link diagonal2d}, but yields 2D grid coordinates in zigzag
  * diagonal order starting at [0,0] and using given `cols` and `rows`.
  *
- * @param cols -
- * @param rows -
+ * @param opts -
  */
-export function* zigzagDiagonal2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* zigzagDiagonal2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const num = cols * rows - 1;
     for (let x = 0, y = 0, ny = 0, dx = -1, dy = 1, d = 0, down = true, i = 0; i <= num; i++) {
-        yield [x, y];
+        yield tx(x, y);
         if (i !== num) {
             do {
                 if (y === ny) {

package/zigzag-rows.d.ts

@@ -1,3 +1,4 @@
+import type { GridIterOpts } from "./api.js";
 /**
  * Yields sequence of 2D grid coordinates in zigzag row order starting from
  * [0,0], given `cols` and `rows`.
@@ -5,9 +6,7 @@
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
- * @param cols -
- * @param rows -
- *
+ * @param opts -
  */
-export declare function zigzagRows2d(cols: number, rows?: number): Generator<number[], void, unknown>;
+export declare function zigzagRows2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=zigzag-rows.d.ts.map

package/zigzag-rows.js

@@ -1,4 +1,4 @@
-import { asInt } from "@thi.ng/api/typedarray";
+import { __opts } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates in zigzag row order starting from
  * [0,0], given `cols` and `rows`.
@@ -6,17 +6,15 @@ import { asInt } from "@thi.ng/api/typedarray";
  * Ported & modified from original Java code by Christopher Kulla.
  * https://sourceforge.net/p/sunflow/code/HEAD/tree/trunk/src/org/sunflow/core/bucket/SpiralBucketOrder.java
  *
- * @param cols -
- * @param rows -
- *
+ * @param opts -
  */
-export function* zigzagRows2d(cols, rows = cols) {
-    [cols, rows] = asInt(cols, rows);
+export function* zigzagRows2d(opts) {
+    const { cols, rows, tx } = __opts(opts);
     const num = cols * rows;
     for (let i = 0; i < num; i++) {
         let x = i % cols;
         const y = (i / cols) | 0;
         y & 1 && (x = cols - 1 - x);
-        yield [x, y];
+        yield tx(x, y);
     }
 }