@thi.ng/grid-iterators 3.0.11 → 3.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-03-14T13:27:19Z
+- **Last updated**: 2023-03-25T17:04:52Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,22 @@ 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.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@3.1.0) (2023-03-25)
+
+#### 🚀 Features
+
+- add diagonalSlopeX/Y() ([f63dc6e](https://github.com/thi-ng/umbrella/commit/f63dc6e))
+  - add diagonal iterators with configurable slope (X & Y versions)
+  - update pkg deps
+
+#### ♻️ Refactoring
+
+- update diagonalEnds2d() ([e20bf7b](https://github.com/thi-ng/umbrella/commit/e20bf7b))
+  - add `all` option to include first & last points
+- extract DiagonalSlopeOpts ([e08857d](https://github.com/thi-ng/umbrella/commit/e08857d))
+- update diagonalEnds2d() opts ([d14458a](https://github.com/thi-ng/umbrella/commit/d14458a))
+  - make `all` optional
+
 ### [3.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@3.0.1) (2022-12-29)
 
 #### 🩹 Bug fixes

package/README.md

@@ -11,7 +11,8 @@ This project is part of the
 
 - [About](#about)
   - [Columns](#columns)
-  - [Diagonal](#diagonal)
+  - [Diagonal (45 degrees)](#diagonal-45-degrees)
+  - [Diagonal with configurable slope](#diagonal-with-configurable-slope)
   - [Hilbert curve](#hilbert-curve)
   - [Interleave columns](#interleave-columns)
   - [Interleave rows](#interleave-rows)
@@ -52,7 +53,7 @@ Also see the filtered version
 [`columnEnds2d()`](https://github.com/thi-ng/umbrella/tree/develop/packages/grid-iterators/src/column-ends.ts),
 which only includes the end points of each column.
 
-### Diagonal
+### Diagonal (45 degrees)
 
 ![anim](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/grid-iterators/diagonal2d-small.gif)
 
@@ -62,6 +63,13 @@ Also see the filtered version
 [`diagonalEnds2d()`](https://github.com/thi-ng/umbrella/tree/develop/packages/grid-iterators/src/diagonal-ends.ts),
 which only includes the end points of the diagonals.
 
+### Diagonal with configurable slope
+
+![anim](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/grid-iterators/diagonalslopex-small.gif)
+![anim](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/grid-iterators/diagonalslopey-small.gif)
+
+[Source](https://github.com/thi-ng/umbrella/tree/develop/packages/grid-iterators/src/diagonal-slope.ts)
+
 ### Hilbert curve
 
 ![anim](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/grid-iterators/hilbert2d-small.gif)
@@ -123,7 +131,7 @@ which only includes the end points of each row.
 
 ### Zigzag diagonal
 
-![anim](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/grid-iterators/zigzagdiag2d-small.gif)
+![anim](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/grid-iterators/zigzagdiagonal2d-small.gif)
 
 [Source](https://github.com/thi-ng/umbrella/tree/develop/packages/grid-iterators/src/zigzag-diagonal.ts)
 
@@ -232,7 +240,7 @@ For Node.js REPL:
 const gridIterators = await import("@thi.ng/grid-iterators");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.31 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.52 KB
 
 ## Dependencies
 
@@ -240,6 +248,7 @@ Package sizes (brotli'd, pre-treeshake): ESM: 2.31 KB
 - [@thi.ng/arrays](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays)
 - [@thi.ng/binary](https://github.com/thi-ng/umbrella/tree/develop/packages/binary)
 - [@thi.ng/bitfield](https://github.com/thi-ng/umbrella/tree/develop/packages/bitfield)
+- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 - [@thi.ng/morton](https://github.com/thi-ng/umbrella/tree/develop/packages/morton)
 - [@thi.ng/random](https://github.com/thi-ng/umbrella/tree/develop/packages/random)
 - [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers)
@@ -273,6 +282,7 @@ import * as gi from "@thi.ng/grid-iterators";
 // ]
 
 // with applied horizontal mirroring
+// also, if `rows` is missing, it defaults to same value as `cols`
 [...gi.zigzagRows2d({ cols: 4, tx: gi.flipX })]
 // [
 //   [ 3, 0 ], [ 2, 0 ], [ 1, 0 ], [ 0, 0 ],

package/diagonal-ends.d.ts

@@ -1,13 +1,15 @@
 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
- * `[cols-1, rows-1]`.
+ * Filtered version of {@link diagonal2d}, only including end points of the
+ * diagonals. Unless `all` option is enabled (default: false), the very first
+ * and last points are skipped, i.e. `[0,0]` and `[cols-1, rows-1]`.
  *
  * @remarks
  * `cols` and `rows` MUST be both >= 2.
  *
  * @param opts -
  */
-export declare function diagonalEnds2d(opts: GridIterOpts): Generator<[number, number], void, unknown>;
+export declare function diagonalEnds2d(opts: GridIterOpts & {
+    all?: boolean;
+}): Generator<[number, number], void, unknown>;
 //# sourceMappingURL=diagonal-ends.d.ts.map

package/diagonal-ends.js

@@ -1,9 +1,9 @@
 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
- * `[cols-1, rows-1]`.
+ * Filtered version of {@link diagonal2d}, only including end points of the
+ * diagonals. Unless `all` option is enabled (default: false), the very first
+ * and last points are skipped, i.e. `[0,0]` and `[cols-1, rows-1]`.
  *
  * @remarks
  * `cols` and `rows` MUST be both >= 2.
@@ -15,9 +15,10 @@ export function* diagonalEnds2d(opts) {
     const num = cols * rows - 1;
     const maxX = cols - 1;
     const maxY = rows - 1;
+    const check = opts.all ? (i) => i > 0 && i < num : () => true;
     let i = 0;
     for (let p of diagonal2d({ cols, rows })) {
-        if (i > 0 && i < num) {
+        if (check(i)) {
             const [x, y] = p;
             if (x === 0 || x === maxX || y === 0 || y === maxY)
                 yield tx(x, y);

package/diagonal-slope.d.ts

@@ -0,0 +1,44 @@
+import type { GridIterOpts } from "./api.js";
+interface DiagonalSlopeOpts extends GridIterOpts {
+    /**
+     * Diagonal slope / step size
+     */
+    slope: number;
+}
+/**
+ * Similar to {@link diagonalSlopeX}. Yields sequence of 2D grid coordinates in
+ * diagonal order with configurable slope, starting at [0,0]. Each diagonal
+ * starts at y=0 and progresses in +y direction and every `step` steps, one
+ * step in -x direction.
+ *
+ * @example
+ * ```ts
+ * // iterate grid in diagonals of 1:3 ratio (x:y)
+ * [...diagonalSlopeY({ cols: 5, step: 3 })]
+ * // [
+ * //   [0, 0], [0, 1 ], [0, 2 ],
+ * //   [1, 0], [1, 1 ], [1, 2 ],
+ * //   [0, 3], [0, 4 ], [2, 0 ],
+ * //   [2, 1], [2, 2 ], [1, 3 ],
+ * //   [1, 4], [3, 0 ], [3, 1 ],
+ * //   [3, 2], [2, 3 ], [2, 4 ],
+ * //   [4, 0], [4, 1 ], [4, 2 ],
+ * //   [3, 3], [3, 4 ], [4, 3 ],
+ * //   [4, 4]
+ * // ]
+ * ```
+ *
+ * @param opts -
+ */
+export declare function diagonalSlopeY(opts: DiagonalSlopeOpts): Generator<[number, number], void, unknown>;
+/**
+ * Similar to {@link diagonalSlopeY}. Yields sequence of 2D grid coordinates in
+ * diagonal order with configurable slope, starting at [step-1,0]. Each
+ * diagonal starts at y=0 and progresses in -x direction and every `step`
+ * steps, one step in +y direction.
+ *
+ * @param opts -
+ */
+export declare function diagonalSlopeX(opts: DiagonalSlopeOpts): Generator<[number, number], void, unknown>;
+export {};
+//# sourceMappingURL=diagonal-slope.d.ts.map

package/diagonal-slope.js

@@ -0,0 +1,112 @@
+import { assert } from "@thi.ng/errors/assert";
+import { __opts } from "./utils.js";
+/**
+ * Similar to {@link diagonalSlopeX}. Yields sequence of 2D grid coordinates in
+ * diagonal order with configurable slope, starting at [0,0]. Each diagonal
+ * starts at y=0 and progresses in +y direction and every `step` steps, one
+ * step in -x direction.
+ *
+ * @example
+ * ```ts
+ * // iterate grid in diagonals of 1:3 ratio (x:y)
+ * [...diagonalSlopeY({ cols: 5, step: 3 })]
+ * // [
+ * //   [0, 0], [0, 1 ], [0, 2 ],
+ * //   [1, 0], [1, 1 ], [1, 2 ],
+ * //   [0, 3], [0, 4 ], [2, 0 ],
+ * //   [2, 1], [2, 2 ], [1, 3 ],
+ * //   [1, 4], [3, 0 ], [3, 1 ],
+ * //   [3, 2], [2, 3 ], [2, 4 ],
+ * //   [4, 0], [4, 1 ], [4, 2 ],
+ * //   [3, 3], [3, 4 ], [4, 3 ],
+ * //   [4, 4]
+ * // ]
+ * ```
+ *
+ * @param opts -
+ */
+export function* diagonalSlopeY(opts) {
+    const { cols, rows, tx } = __opts(opts);
+    const maxX = cols - 1;
+    const slope = opts.slope | 0;
+    assert(slope > 0, "slope must be > 0");
+    const num = cols * rows - 1;
+    let x = 0;
+    let y = 0;
+    let nx = Math.min(1, maxX);
+    let ny = nx > 0 ? 0 : slope;
+    let n = slope;
+    const reset = () => {
+        n = slope;
+        x = nx;
+        y = ny;
+        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();
+        }
+        else {
+            x--;
+            y++;
+            if (x < 0 || y >= rows)
+                reset();
+            else
+                n = slope;
+        }
+    }
+}
+/**
+ * Similar to {@link diagonalSlopeY}. Yields sequence of 2D grid coordinates in
+ * diagonal order with configurable slope, starting at [step-1,0]. Each
+ * diagonal starts at y=0 and progresses in -x direction and every `step`
+ * steps, one step in +y direction.
+ *
+ * @param opts -
+ */
+export function* diagonalSlopeX(opts) {
+    const { cols, rows, tx } = __opts(opts);
+    const maxX = cols - 1;
+    const slope = opts.slope | 0;
+    assert(slope > 0, "slope must be > 0");
+    const num = cols * rows - 1;
+    let x = Math.min(slope - 1, maxX);
+    let y = 0;
+    let n = x + 1;
+    let nx = Math.min(x + slope, maxX);
+    let ny = nx > 0 ? 0 : slope;
+    const reset = () => {
+        x = nx;
+        y = ny;
+        if (nx < maxX) {
+            nx = Math.min(nx + slope, maxX);
+            n = slope;
+        }
+        else {
+            ny++;
+            n = (x % slope) + 1;
+        }
+    };
+    for (let i = 0; i <= num; i++) {
+        yield tx(x, y);
+        if (--n > 0) {
+            x--;
+            if (x < 0)
+                reset();
+        }
+        else {
+            x--;
+            y++;
+            if (x < 0 || y >= rows)
+                reset();
+            else
+                n = slope;
+        }
+    }
+}

package/diagonal.js

@@ -14,7 +14,7 @@ export function* diagonal2d(opts) {
     const num = cols * rows - 1;
     for (let x = 0, y = 0, nx = 1, ny = 0, i = 0; i <= num; i++) {
         yield tx(x, y);
-        if (i != num) {
+        if (i !== num) {
             do {
                 if (y === ny) {
                     y = 0;

package/index.d.ts

@@ -5,6 +5,7 @@ export * from "./column-ends.js";
 export * from "./columns.js";
 export * from "./diagonal.js";
 export * from "./diagonal-ends.js";
+export * from "./diagonal-slope.js";
 export * from "./diamond-square.js";
 export * from "./flood-fill.js";
 export * from "./hilbert.js";

package/index.js

@@ -5,6 +5,7 @@ export * from "./column-ends.js";
 export * from "./columns.js";
 export * from "./diagonal.js";
 export * from "./diagonal-ends.js";
+export * from "./diagonal-slope.js";
 export * from "./diamond-square.js";
 export * from "./flood-fill.js";
 export * from "./hilbert.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/grid-iterators",
-  "version": "3.0.11",
+  "version": "3.1.0",
   "description": "2D grid and shape iterators w/ multiple orderings",
   "type": "module",
   "module": "./index.js",
@@ -32,16 +32,18 @@
     "doc:readme": "yarn doc:stats && tools:readme",
     "doc:stats": "tools:module-stats",
     "pub": "yarn npm publish --access public",
-    "test": "testament test"
+    "test": "testament test",
+    "tool:assets": "tools:node-esm tools/build-assets.ts"
   },
   "dependencies": {
     "@thi.ng/api": "^8.7.4",
     "@thi.ng/arrays": "^2.5.8",
     "@thi.ng/binary": "^3.3.21",
     "@thi.ng/bitfield": "^2.2.24",
+    "@thi.ng/errors": "^2.2.13",
     "@thi.ng/morton": "^3.1.32",
     "@thi.ng/random": "^3.3.27",
-    "@thi.ng/transducers": "^8.3.38"
+    "@thi.ng/transducers": "^8.4.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.34.4",
@@ -101,6 +103,9 @@
     "./diagonal-ends": {
       "default": "./diagonal-ends.js"
     },
+    "./diagonal-slope": {
+      "default": "./diagonal-slope.js"
+    },
     "./diagonal": {
       "default": "./diagonal.js"
     },
@@ -158,5 +163,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "cc46c097a3a173fb1ef41f57a858d03037063141\n"
+  "gitHead": "f5c562f74466d36a6df27ddd6957eeb280831fa9\n"
 }