@thi.ng/grid-iterators 2.2.4 → 2.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-04-07T14:17:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+## [2.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@2.3.0) (2022-04-07)
+
+#### 🚀 Features
+
+- add diamondSquare() ([4fabaad](https://github.com/thi-ng/umbrella/commit/4fabaad))
+
 ### [2.2.4](https://github.com/thi-ng/umbrella/tree/@thi.ng/grid-iterators@2.2.4) (2021-12-13)
 
 #### 🩹 Bug fixes

package/README.md

@@ -225,7 +225,7 @@ node --experimental-repl-await
 > const gridIterators = await import("@thi.ng/grid-iterators");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 2.22 KB
+Package sizes (gzipped, pre-treeshake): ESM: 2.43 KB
 
 ## Dependencies
 
@@ -283,4 +283,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2019 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2019 - 2022 Karsten Schmidt // Apache Software License 2.0

package/circle.d.ts

@@ -4,14 +4,14 @@ export declare function circle(cx: number, cy: number, r: number, fill?: boolean
  * `left,top`..`right,bottom`. Returns undefined if circle lies completely
  * outside given clip rectangle.
  *
- * @param cx
- * @param cy
- * @param r
- * @param left
- * @param top
- * @param right
- * @param bottom
- * @param fill
+ * @param cx -
+ * @param cy -
+ * @param r -
+ * @param left -
+ * @param top -
+ * @param right -
+ * @param bottom -
+ * @param fill -
  */
 export declare const circleClipped: (cx: number, cy: number, r: number, left: number, top: number, right: number, bottom: number, fill?: boolean) => Generator<number[], void, unknown> | undefined;
 //# sourceMappingURL=circle.d.ts.map

package/circle.js

@@ -57,14 +57,14 @@ export function* circle(cx, cy, r, fill = true) {
  * `left,top`..`right,bottom`. Returns undefined if circle lies completely
  * outside given clip rectangle.
  *
- * @param cx
- * @param cy
- * @param r
- * @param left
- * @param top
- * @param right
- * @param bottom
- * @param fill
+ * @param cx -
+ * @param cy -
+ * @param r -
+ * @param left -
+ * @param top -
+ * @param right -
+ * @param bottom -
+ * @param fill -
  */
 export const circleClipped = (cx, cy, r, left, top, right, bottom, fill = true) => {
     return intersectRectCircle(left, top, right, bottom, cx, cy, r)

package/clipping.d.ts

@@ -3,23 +3,23 @@ import type { FnU7, FnU8, Tuple } from "@thi.ng/api";
  * Filters points from `src` iterable to remove any falling outside the rect
  * defined by `left,top`..`right,bottom`.
  *
- * @param src
- * @param left
- * @param top
- * @param right
- * @param bottom
+ * @param src -
+ * @param left -
+ * @param top -
+ * @param right -
+ * @param bottom -
  */
 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.
  *
- * @param x
- * @param y
- * @param w
- * @param h
- * @param cx
- * @param cy
- * @param r
+ * @param x -
+ * @param y -
+ * @param w -
+ * @param h -
+ * @param cx -
+ * @param cy -
+ * @param r -
  *
  * @internal
  */
@@ -27,14 +27,14 @@ export declare const intersectRectCircle: FnU7<number, boolean>;
 /**
  * Based on {@link @thi.ng/geom-clip-line#liangBarsky2Raw}, but with diff return type.
  *
- * @param ax
- * @param ay
- * @param bx
- * @param by
- * @param minx
- * @param miny
- * @param maxx
- * @param maxy
+ * @param ax -
+ * @param ay -
+ * @param bx -
+ * @param by -
+ * @param minx -
+ * @param miny -
+ * @param maxx -
+ * @param maxy -
  *
  * @internal
  */

package/clipping.js

@@ -2,11 +2,11 @@
  * Filters points from `src` iterable to remove any falling outside the rect
  * defined by `left,top`..`right,bottom`.
  *
- * @param src
- * @param left
- * @param top
- * @param right
- * @param bottom
+ * @param src -
+ * @param left -
+ * @param top -
+ * @param right -
+ * @param bottom -
  */
 export function* clipped(src, left, top, right, bottom) {
     for (let p of src) {
@@ -19,13 +19,13 @@ 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.
  *
- * @param x
- * @param y
- * @param w
- * @param h
- * @param cx
- * @param cy
- * @param r
+ * @param x -
+ * @param y -
+ * @param w -
+ * @param h -
+ * @param cx -
+ * @param cy -
+ * @param r -
  *
  * @internal
  */
@@ -33,14 +33,14 @@ export const intersectRectCircle = (x, y, w, h, cx, cy, r) => axis(cx, x, w) + a
 /**
  * Based on {@link @thi.ng/geom-clip-line#liangBarsky2Raw}, but with diff return type.
  *
- * @param ax
- * @param ay
- * @param bx
- * @param by
- * @param minx
- * @param miny
- * @param maxx
- * @param maxy
+ * @param ax -
+ * @param ay -
+ * @param bx -
+ * @param by -
+ * @param minx -
+ * @param miny -
+ * @param maxx -
+ * @param maxy -
  *
  * @internal
  */

package/columns.d.ts

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

package/columns.js

@@ -4,7 +4,7 @@ import { swapxy } from "./utils.js";
 /**
  * Yields sequence of 2D grid coordinates in column-major order.
  *
- * @param cols
- * @param rows
+ * @param cols -
+ * @param rows -
  */
 export const columns2d = (cols, rows = cols) => map(swapxy, range2d(rows | 0, cols | 0));

package/diamond-square.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Yields iterator of 2D grid coordinates based on the recursive Diamond Square
+ * algorithm. The given `exp` is a power of 2 exponent and the resulting
+ * coordinates (in both directions) will be in the closed [0..2^exp] interval
+ * (i.e. each axis is always a power-of-2 plus 1).
+ *
+ * @remarks
+ * Reference: https://en.wikipedia.org/wiki/Diamond-square_algorithm
+ *
+ * @example
+ * ```ts
+ * // generate coords for a 17x17 grid
+ * [...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],
+ * //   [4, 16], [8, 4],  [8, 12],  [4, 8],  [12, 8], [0, 4],
+ * //   ...
+ * // ]
+ * ```
+ *
+ * @param exp
+ */
+export declare function diamondSquare(exp: number): Generator<number[], void, undefined>;
+//# sourceMappingURL=diamond-square.d.ts.map

package/diamond-square.js

@@ -0,0 +1,74 @@
+import { defBitField } from "@thi.ng/bitfield/bitfield";
+/**
+ * Yields iterator of 2D grid coordinates based on the recursive Diamond Square
+ * algorithm. The given `exp` is a power of 2 exponent and the resulting
+ * coordinates (in both directions) will be in the closed [0..2^exp] interval
+ * (i.e. each axis is always a power-of-2 plus 1).
+ *
+ * @remarks
+ * Reference: https://en.wikipedia.org/wiki/Diamond-square_algorithm
+ *
+ * @example
+ * ```ts
+ * // generate coords for a 17x17 grid
+ * [...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],
+ * //   [4, 16], [8, 4],  [8, 12],  [4, 8],  [12, 8], [0, 4],
+ * //   ...
+ * // ]
+ * ```
+ *
+ * @param exp
+ */
+export function* diamondSquare(exp) {
+    const size = 1 << exp;
+    const size1 = size + 1;
+    const s2 = size >> 1;
+    let res = size;
+    const idx = defBitField(size1 * size1);
+    const acc = [];
+    const $ = (x, y) => {
+        !idx.setAt(x + y * size1) && acc.push([x, y]);
+    };
+    $(0, 0);
+    $(res, 0);
+    $(res, res);
+    $(0, res);
+    yield* acc;
+    while (res > 1) {
+        const r2 = res >> 1;
+        for (let y = 0; y <= s2; y += res) {
+            const y1 = y + r2;
+            const y2 = y + res;
+            for (let x = r2; x <= s2; x += res) {
+                acc.length = 0;
+                const x1 = x - r2;
+                const x2 = x + r2;
+                $(x, y);
+                $(size - x, y);
+                $(size - x, size - y);
+                $(x, size - y);
+                $(x2, y1);
+                $(size - x2, y1);
+                $(size - x2, size - y1);
+                $(x2, size - y1);
+                $(x, y2);
+                $(size - x, y2);
+                $(size - x, size - y2);
+                $(x, size - y2);
+                $(x1, y1);
+                $(size - x1, y1);
+                $(size - x1, size - y1);
+                $(x1, size - y1);
+                $(x, y1);
+                $(size - x, y1);
+                $(size - x, size - y1);
+                $(x, size - y1);
+                yield* acc;
+            }
+        }
+        res = r2;
+    }
+}

package/flood-fill.d.ts

@@ -27,11 +27,11 @@ import type { Predicate2 } from "@thi.ng/api";
  * // ]
  * ```
  *
- * @param pred
- * @param x
- * @param y
- * @param width
- * @param height
+ * @param pred -
+ * @param x -
+ * @param y -
+ * @param width -
+ * @param height -
  */
 export declare function floodFill(pred: Predicate2<number>, x: number, y: number, width: number, height: number): Generator<number[], void, unknown>;
 //# sourceMappingURL=flood-fill.d.ts.map

package/flood-fill.js

@@ -27,11 +27,11 @@ import { defBitField } from "@thi.ng/bitfield/bitfield";
  * // ]
  * ```
  *
- * @param pred
- * @param x
- * @param y
- * @param width
- * @param height
+ * @param pred -
+ * @param x -
+ * @param y -
+ * @param width -
+ * @param height -
  */
 export function* floodFill(pred, x, y, width, height) {
     x |= 0;

package/index.d.ts

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

package/index.js

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

package/line.d.ts

@@ -4,14 +4,14 @@ export declare function line(ax: number, ay: number, bx: number, by: number): Ge
  * `left,top`..`right,bottom`. Returns undefined if circle lies completely
  * outside given clip rectangle.
  *
- * @param x1
- * @param y1
- * @param x2
- * @param y2
- * @param left
- * @param top
- * @param right
- * @param bottom
+ * @param x1 -
+ * @param y1 -
+ * @param x2 -
+ * @param y2 -
+ * @param left -
+ * @param top -
+ * @param right -
+ * @param bottom -
  */
 export declare const lineClipped: (x1: number, y1: number, x2: number, y2: number, left: number, top: number, right: number, bottom: number) => Generator<number[], void, unknown> | undefined;
 //# sourceMappingURL=line.d.ts.map

package/line.js

@@ -27,14 +27,14 @@ export function* line(ax, ay, bx, by) {
  * `left,top`..`right,bottom`. Returns undefined if circle lies completely
  * outside given clip rectangle.
  *
- * @param x1
- * @param y1
- * @param x2
- * @param y2
- * @param left
- * @param top
- * @param right
- * @param bottom
+ * @param x1 -
+ * @param y1 -
+ * @param x2 -
+ * @param y2 -
+ * @param left -
+ * @param top -
+ * @param right -
+ * @param bottom -
  */
 export const lineClipped = (x1, y1, x2, y2, left, top, right, bottom) => {
     const res = liangBarsky(x1, y1, x2, y2, left, top, right - 1, bottom - 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/grid-iterators",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "description": "2D grid and shape iterators w/ multiple orderings",
   "type": "module",
   "module": "./index.js",
@@ -35,21 +35,21 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3",
-    "@thi.ng/arrays": "^2.1.3",
-    "@thi.ng/binary": "^3.1.3",
-    "@thi.ng/bitfield": "^2.1.4",
-    "@thi.ng/morton": "^3.1.3",
-    "@thi.ng/random": "^3.2.3",
-    "@thi.ng/transducers": "^8.1.3"
+    "@thi.ng/api": "^8.3.5",
+    "@thi.ng/arrays": "^2.2.1",
+    "@thi.ng/binary": "^3.2.1",
+    "@thi.ng/bitfield": "^2.1.6",
+    "@thi.ng/morton": "^3.1.5",
+    "@thi.ng/random": "^3.2.5",
+    "@thi.ng/transducers": "^8.3.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.5",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "2d",
@@ -81,64 +81,67 @@
   ],
   "exports": {
     ".": {
-      "import": "./index.js"
+      "default": "./index.js"
     },
     "./circle": {
-      "import": "./circle.js"
+      "default": "./circle.js"
     },
     "./clipping": {
-      "import": "./clipping.js"
+      "default": "./clipping.js"
     },
     "./column-ends": {
-      "import": "./column-ends.js"
+      "default": "./column-ends.js"
     },
     "./columns": {
-      "import": "./columns.js"
+      "default": "./columns.js"
     },
     "./diagonal-ends": {
-      "import": "./diagonal-ends.js"
+      "default": "./diagonal-ends.js"
     },
     "./diagonal": {
-      "import": "./diagonal.js"
+      "default": "./diagonal.js"
+    },
+    "./diamond-square": {
+      "default": "./diamond-square.js"
     },
     "./flood-fill": {
-      "import": "./flood-fill.js"
+      "default": "./flood-fill.js"
     },
     "./hilbert": {
-      "import": "./hilbert.js"
+      "default": "./hilbert.js"
     },
     "./hvline": {
-      "import": "./hvline.js"
+      "default": "./hvline.js"
     },
     "./interleave": {
-      "import": "./interleave.js"
+      "default": "./interleave.js"
     },
     "./line": {
-      "import": "./line.js"
+      "default": "./line.js"
     },
     "./random": {
-      "import": "./random.js"
+      "default": "./random.js"
     },
     "./row-ends": {
-      "import": "./row-ends.js"
+      "default": "./row-ends.js"
     },
     "./rows": {
-      "import": "./rows.js"
+      "default": "./rows.js"
     },
     "./spiral": {
-      "import": "./spiral.js"
+      "default": "./spiral.js"
     },
     "./zcurve": {
-      "import": "./zcurve.js"
+      "default": "./zcurve.js"
     },
     "./zigzag-columns": {
-      "import": "./zigzag-columns.js"
+      "default": "./zigzag-columns.js"
     },
     "./zigzag-diagonal": {
-      "import": "./zigzag-diagonal.js"
+      "default": "./zigzag-diagonal.js"
     },
     "./zigzag-rows": {
-      "import": "./zigzag-rows.js"
+      "default": "./zigzag-rows.js"
     }
   },
   "thi.ng": {
@@ -149,5 +152,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "2db9dd34c0c2c60cbfde3dad0bca352b20292f5c\n"
+  "gitHead": "5ee1feb590dd935593b1dd4e7f38a3ed3ba64765\n"
 }

package/rows.d.ts

@@ -2,8 +2,8 @@
  * Yields sequence of 2D grid coordinates in row-major order. Same as
  * {@link @thi.ng/transducers#range2d}.
  *
- * @param cols
- * @param rows
+ * @param cols -
+ * @param rows -
  */
 export declare const rows2d: (cols: number, rows?: number) => IterableIterator<[number, number]>;
 //# sourceMappingURL=rows.d.ts.map

package/rows.js

@@ -3,7 +3,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}.
  *
- * @param cols
- * @param rows
+ * @param cols -
+ * @param rows -
  */
 export const rows2d = (cols, rows = cols) => range2d(cols | 0, rows | 0);

package/utils.d.ts

@@ -1,7 +1,7 @@
 /**
  * Swaps XY in-place.
  *
- * @param p
+ * @param p -
  *
  * @internal
  */

package/utils.js

@@ -2,7 +2,7 @@
 /**
  * Swaps XY in-place.
  *
- * @param p
+ * @param p -
  *
  * @internal
  */