@thi.ng/geom 4.0.1 → 4.0.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/api/text.d.ts

@@ -3,8 +3,9 @@ import type { Vec } from "@thi.ng/vectors";
 /**
  * Basic stub for text elements. Currently, only a minimal set of geometry
  * operations are implemented for this type, however this type implements
- * {@link @this.ng/api#IToHiccup} and so is useful as wrapper for inclusion of
- * text elements in {@link Group}s with other shape types.
+ * [`IToHiccup`](https://docs.thi.ng/umbrella/api/interfaces/IToHiccup.html) and
+ * so is useful as wrapper for inclusion of text elements in {@link Group}s with
+ * other shape types.
  */
 export declare class Text implements IHiccupShape {
     pos: Vec;

package/api/text.js

@@ -3,8 +3,9 @@ import { __copyAttribs } from "../internal/copy.js";
 /**
  * Basic stub for text elements. Currently, only a minimal set of geometry
  * operations are implemented for this type, however this type implements
- * {@link @this.ng/api#IToHiccup} and so is useful as wrapper for inclusion of
- * text elements in {@link Group}s with other shape types.
+ * [`IToHiccup`](https://docs.thi.ng/umbrella/api/interfaces/IToHiccup.html) and
+ * so is useful as wrapper for inclusion of text elements in {@link Group}s with
+ * other shape types.
  */
 export class Text {
     constructor(pos, body, attribs) {

package/as-polygon.d.ts

@@ -3,7 +3,8 @@ import type { IShape, SamplingOpts } from "@thi.ng/geom-api";
 import { Polygon } from "./api/polygon.js";
 /**
  * Converts given shape into a {@link Polygon}, optionally using provided
- * {@link @thi.ng/geom-api#SamplingOpts} or number of target vertices.
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html)
+ * or number of target vertices.
  *
  * @remarks
  * Currently implemented for:

package/as-polygon.js

@@ -5,7 +5,8 @@ import { __dispatch } from "./internal/dispatch.js";
 import { vertices } from "./vertices.js";
 /**
  * Converts given shape into a {@link Polygon}, optionally using provided
- * {@link @thi.ng/geom-api#SamplingOpts} or number of target vertices.
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html)
+ * or number of target vertices.
  *
  * @remarks
  * Currently implemented for:

package/as-polyline.d.ts

@@ -3,7 +3,8 @@ import type { IShape, SamplingOpts } from "@thi.ng/geom-api";
 import { Polyline } from "./api/polyline.js";
 /**
  * Converts given shape into a {@link Polyline}, optionally using provided
- * {@link @thi.ng/geom-api#SamplingOpts} or number of target vertices.
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html)
+ * or number of target vertices.
  *
  * @remarks
  * Currently implemented for:

package/as-polyline.js

@@ -6,7 +6,8 @@ import { __dispatch } from "./internal/dispatch.js";
 import { vertices } from "./vertices.js";
 /**
  * Converts given shape into a {@link Polyline}, optionally using provided
- * {@link @thi.ng/geom-api#SamplingOpts} or number of target vertices.
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html)
+ * or number of target vertices.
  *
  * @remarks
  * Currently implemented for:

package/classify-point.d.ts

@@ -14,9 +14,9 @@ import type { ReadonlyVec } from "@thi.ng/vectors";
  * - {@link Sphere}
  * - {@link Triangle}
  *
- * The {@link @thi.ng/geom-sdf#} package provides a much more comprehensive
- * feature set (incl. support for more shapes) to perform similar checks as this
- * function.
+ * The [thi.ng/geom-sdf](https://thi.ng/thi.ng/geom-sdf) package provides a much
+ * more comprehensive feature set (incl. support for more shapes) to perform
+ * similar checks as this function.
  *
  * Also see {@link pointInside}.
  *

package/classify-point.js

@@ -17,9 +17,9 @@ import { __dispatch } from "./internal/dispatch.js";
  * - {@link Sphere}
  * - {@link Triangle}
  *
- * The {@link @thi.ng/geom-sdf#} package provides a much more comprehensive
- * feature set (incl. support for more shapes) to perform similar checks as this
- * function.
+ * The [thi.ng/geom-sdf](https://thi.ng/thi.ng/geom-sdf) package provides a much
+ * more comprehensive feature set (incl. support for more shapes) to perform
+ * similar checks as this function.
  *
  * Also see {@link pointInside}.
  *

package/clip-convex.d.ts

@@ -7,8 +7,9 @@ import type { ReadonlyVec } from "@thi.ng/vectors";
  * boundary). Returns `undefined` if there're no remaining result vertices.
  *
  * @remarks
- * Internally uses {@link @thi.ng/geom-clip-poly#sutherlandHodgeman}. For
- * groups, calls itself for each child shape individually and returns a new
+ * Internally uses
+ * [`sutherlandHodgeman()`](https://docs.thi.ng/umbrella/geom-clip-poly/functions/sutherlandHodgeman.html).
+ * For groups, calls itself for each child shape individually and returns a new
  * group of results (if any).
  *
  * @param shape

package/clip-convex.js

@@ -14,8 +14,9 @@ import { ensureVertices, vertices } from "./vertices.js";
  * boundary). Returns `undefined` if there're no remaining result vertices.
  *
  * @remarks
- * Internally uses {@link @thi.ng/geom-clip-poly#sutherlandHodgeman}. For
- * groups, calls itself for each child shape individually and returns a new
+ * Internally uses
+ * [`sutherlandHodgeman()`](https://docs.thi.ng/umbrella/geom-clip-poly/functions/sutherlandHodgeman.html).
+ * For groups, calls itself for each child shape individually and returns a new
  * group of results (if any).
  *
  * @param shape

package/convex-hull.d.ts

@@ -4,7 +4,8 @@ import type { IShape } from "@thi.ng/geom-api";
  * Computes the convex hull for given shape and returns it as {@link Polygon}.
  *
  * @remarks
- * Internally uses {@link @thi.ng/geom-hull#grahamScan2}.
+ * Internally uses
+ * [`grahamScan2()`](https://docs.thi.ng/umbrella/geom-hull/functions/grahamScan2.html).
  *
  * Currently implemented for:
  *

package/convex-hull.js

@@ -8,7 +8,8 @@ import { vertices } from "./vertices.js";
  * Computes the convex hull for given shape and returns it as {@link Polygon}.
  *
  * @remarks
- * Internally uses {@link @thi.ng/geom-hull#grahamScan2}.
+ * Internally uses
+ * [`grahamScan2()`](https://docs.thi.ng/umbrella/geom-hull/functions/grahamScan2.html).
  *
  * Currently implemented for:
  *

package/edges.d.ts

@@ -4,7 +4,7 @@ import type { VecPair } from "@thi.ng/vectors";
 /**
  * Extracts the edges of given shape's boundary and returns them as an iterable
  * of vector pairs. Some shapes also support
- * {@link @thi.ng/geom-api#SamplingOpts}.
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html).
  *
  * @remarks
  * Currently implemented for:

package/edges.js

@@ -7,7 +7,7 @@ import { vertices } from "./vertices.js";
 /**
  * Extracts the edges of given shape's boundary and returns them as an iterable
  * of vector pairs. Some shapes also support
- * {@link @thi.ng/geom-api#SamplingOpts}.
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html).
  *
  * @remarks
  * Currently implemented for:

package/internal/bounds.d.ts

@@ -13,8 +13,8 @@ import type { ReadonlyVec, VecPair } from "@thi.ng/vectors";
 export declare const __collBounds: (shapes: IShape[], bounds: Fn<IShape, AABBLike | undefined>) => import("@thi.ng/vectors").Vec[] | undefined;
 /**
  * Takes the position and size vectors of 2
- * {@link @thi.ng/geom-api#AABBLike}s and returns 2-tuple of
- * `[pos,size]` of their union bounds.
+ * [`AABBLike`](https://docs.thi.ng/umbrella/geom-api/interfaces/AABBLike.html)s
+ * and returns 2-tuple of `[pos,size]` of their union bounds.
  *
  * @param apos - bbox 1 min pos
  * @param asize - bbox1 size

package/internal/bounds.js

@@ -29,8 +29,8 @@ export const __collBounds = (shapes, bounds) => {
 };
 /**
  * Takes the position and size vectors of 2
- * {@link @thi.ng/geom-api#AABBLike}s and returns 2-tuple of
- * `[pos,size]` of their union bounds.
+ * [`AABBLike`](https://docs.thi.ng/umbrella/geom-api/interfaces/AABBLike.html)s
+ * and returns 2-tuple of `[pos,size]` of their union bounds.
  *
  * @param apos - bbox 1 min pos
  * @param asize - bbox1 size

package/intersects.d.ts

@@ -2,7 +2,7 @@ import type { MultiFn2 } from "@thi.ng/defmulti";
 import type { IntersectionResult, IShape } from "@thi.ng/geom-api";
 /**
  * Performs intersection tests on given 2 shapes and returns
- * {@link @thi.ng/geom-api#IntersectionResult}.
+ * [`IntersectionResult`](https://docs.thi.ng/umbrella/geom-api/interfaces/IntersectionResult.html).
  *
  * @remarks
  * Currently supported pairs:

package/intersects.js

@@ -12,7 +12,7 @@ import { testAabbAabb, testRectRect } from "@thi.ng/geom-isec/rect-rect";
 import { __dispatch2 } from "./internal/dispatch.js";
 /**
  * Performs intersection tests on given 2 shapes and returns
- * {@link @thi.ng/geom-api#IntersectionResult}.
+ * [`IntersectionResult`](https://docs.thi.ng/umbrella/geom-api/interfaces/IntersectionResult.html).
  *
  * @remarks
  * Currently supported pairs:

package/offset.d.ts

@@ -5,7 +5,8 @@ import type { IShape } from "@thi.ng/geom-api";
  * distance `dist`.
  *
  * @remarks
- * Also see {@link @thi.ng/geom-sdf#} package for more flexible & advanced usage.
+ * Also see [thi.ng/geom-sdf](https://thi.ng/thi.ng/geom-sdf) package for more
+ * flexible & advanced usage.
  *
  * Currently only implemented for:
  *

package/offset.js

@@ -15,7 +15,8 @@ import { rectWithCentroidAndMargin } from "./rect.js";
  * distance `dist`.
  *
  * @remarks
- * Also see {@link @thi.ng/geom-sdf#} package for more flexible & advanced usage.
+ * Also see [thi.ng/geom-sdf](https://thi.ng/thi.ng/geom-sdf) package for more
+ * flexible & advanced usage.
  *
  * Currently only implemented for:
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Functional, polymorphic API for 2D geometry types & SVG generation",
   "type": "module",
   "module": "./index.js",
@@ -35,33 +35,33 @@
     "tool:bpatch": "tools:node-esm tools/bpatch.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0",
-    "@thi.ng/arrays": "^2.4.5",
-    "@thi.ng/associative": "^6.2.19",
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/arrays": "^2.4.6",
+    "@thi.ng/associative": "^6.2.20",
     "@thi.ng/checks": "^3.3.5",
-    "@thi.ng/defmulti": "^2.1.24",
+    "@thi.ng/defmulti": "^2.1.25",
     "@thi.ng/equiv": "^2.1.15",
     "@thi.ng/errors": "^2.2.6",
-    "@thi.ng/geom-api": "^3.3.21",
-    "@thi.ng/geom-arc": "^2.1.39",
-    "@thi.ng/geom-clip-line": "^2.2.1",
-    "@thi.ng/geom-clip-poly": "^2.1.38",
-    "@thi.ng/geom-closest-point": "^2.1.35",
-    "@thi.ng/geom-hull": "^2.1.35",
-    "@thi.ng/geom-isec": "^2.1.38",
-    "@thi.ng/geom-poly-utils": "^2.3.22",
-    "@thi.ng/geom-resample": "^2.1.39",
-    "@thi.ng/geom-splines": "^2.2.13",
-    "@thi.ng/geom-subdiv-curve": "^2.1.38",
-    "@thi.ng/geom-tessellate": "^2.1.38",
-    "@thi.ng/hiccup": "^4.2.26",
-    "@thi.ng/hiccup-svg": "^4.3.24",
-    "@thi.ng/math": "^5.3.16",
-    "@thi.ng/matrices": "^2.1.36",
-    "@thi.ng/random": "^3.3.18",
-    "@thi.ng/strings": "^3.3.20",
-    "@thi.ng/transducers": "^8.3.26",
-    "@thi.ng/vectors": "^7.5.27"
+    "@thi.ng/geom-api": "^3.3.22",
+    "@thi.ng/geom-arc": "^2.1.40",
+    "@thi.ng/geom-clip-line": "^2.2.2",
+    "@thi.ng/geom-clip-poly": "^2.1.39",
+    "@thi.ng/geom-closest-point": "^2.1.36",
+    "@thi.ng/geom-hull": "^2.1.36",
+    "@thi.ng/geom-isec": "^2.1.39",
+    "@thi.ng/geom-poly-utils": "^2.3.23",
+    "@thi.ng/geom-resample": "^2.1.40",
+    "@thi.ng/geom-splines": "^2.2.14",
+    "@thi.ng/geom-subdiv-curve": "^2.1.39",
+    "@thi.ng/geom-tessellate": "^2.1.39",
+    "@thi.ng/hiccup": "^4.2.27",
+    "@thi.ng/hiccup-svg": "^4.3.25",
+    "@thi.ng/math": "^5.3.17",
+    "@thi.ng/matrices": "^2.1.37",
+    "@thi.ng/random": "^3.3.19",
+    "@thi.ng/strings": "^3.3.21",
+    "@thi.ng/transducers": "^8.3.27",
+    "@thi.ng/vectors": "^7.5.28"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
@@ -383,5 +383,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }

package/scatter.d.ts

@@ -1,12 +1,14 @@
 import type { IShape } from "@thi.ng/geom-api";
 import type { Vec } from "@thi.ng/vectors";
 /**
- * Produces `num` random points for which {@link pointInside} succeeeds for the
+ * Produces `num` random points for which {@link pointInside} succeeds for the
  * given `shape`. Writes results into `out` array (or creates a new one).
  *
  * @remarks
  * Samples are only created with the shapes bounding box and are chosen using
- * optionall yprovided `rnd` {@link @thi.ng/random#IRandom} instance.
+ * optionally provided `rnd`
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
+ * instance.
  *
  * @param shape
  * @param num

package/scatter.js

@@ -3,12 +3,14 @@ import { randMinMax } from "@thi.ng/vectors/random";
 import { bounds } from "./bounds.js";
 import { pointInside } from "./point-inside.js";
 /**
- * Produces `num` random points for which {@link pointInside} succeeeds for the
+ * Produces `num` random points for which {@link pointInside} succeeds for the
  * given `shape`. Writes results into `out` array (or creates a new one).
  *
  * @remarks
  * Samples are only created with the shapes bounding box and are chosen using
- * optionall yprovided `rnd` {@link @thi.ng/random#IRandom} instance.
+ * optionally provided `rnd`
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
+ * instance.
  *
  * @param shape
  * @param num

package/simplify.d.ts

@@ -2,8 +2,10 @@ import type { MultiFn2 } from "@thi.ng/defmulti";
 import type { IShape } from "@thi.ng/geom-api";
 /**
  * Simplifies given 2D shape boundary using Douglas-Peucker algorithm
- * (implemented by {@link @thi.ng/geom-resample#simplify}) and given `threshold`
- * distance (default: 0, which removes only co-linear vertices).
+ * (implemented by
+ * [`simplify()`](https://docs.thi.ng/umbrella/geom-resample/functions/simplify.html))
+ * and given `threshold` distance (default: 0, which removes only co-linear
+ * vertices).
  *
  * @remarks
  * Currently only implemented for:

package/simplify.js

@@ -9,8 +9,10 @@ import { __dispatch } from "./internal/dispatch.js";
 import { vertices } from "./vertices.js";
 /**
  * Simplifies given 2D shape boundary using Douglas-Peucker algorithm
- * (implemented by {@link @thi.ng/geom-resample#simplify}) and given `threshold`
- * distance (default: 0, which removes only co-linear vertices).
+ * (implemented by
+ * [`simplify()`](https://docs.thi.ng/umbrella/geom-resample/functions/simplify.html))
+ * and given `threshold` distance (default: 0, which removes only co-linear
+ * vertices).
  *
  * @remarks
  * Currently only implemented for:

package/subdiv-curve.d.ts

@@ -1,9 +1,11 @@
 import type { MultiFn2O } from "@thi.ng/defmulti";
 import type { IShape, SubdivKernel } from "@thi.ng/geom-api";
 /**
- * Recursively applies {@link @thi.ng/geom-api#SubdivKernel} to given
- * shape/boundary. See {@link @thi.ng/geom-subdiv-curve#} package for further
- * details.
+ * Recursively applies
+ * [`SubdivKernel`](https://docs.thi.ng/umbrella/geom-api/interfaces/SubdivKernel.html)
+ * to given shape/boundary. See
+ * [thi.ng/geom-subdiv-curve](https://thi.ng/thi.ng/geom-subdiv-curve) package
+ * for further details.
  *
  * @remarks
  * By default only applies a single iteration.

package/subdiv-curve.js

@@ -5,9 +5,11 @@ import { Polyline } from "./api/polyline.js";
 import { __copyAttribs } from "./internal/copy.js";
 import { __dispatch } from "./internal/dispatch.js";
 /**
- * Recursively applies {@link @thi.ng/geom-api#SubdivKernel} to given
- * shape/boundary. See {@link @thi.ng/geom-subdiv-curve#} package for further
- * details.
+ * Recursively applies
+ * [`SubdivKernel`](https://docs.thi.ng/umbrella/geom-api/interfaces/SubdivKernel.html)
+ * to given shape/boundary. See
+ * [thi.ng/geom-subdiv-curve](https://thi.ng/thi.ng/geom-subdiv-curve) package
+ * for further details.
  *
  * @remarks
  * By default only applies a single iteration.

package/tessellate.d.ts

@@ -2,8 +2,10 @@ import type { IShape, Tessellator } from "@thi.ng/geom-api";
 import type { Vec } from "@thi.ng/vectors";
 /**
  * Recursively tessellates shape using provided
- * {@link @thi.ng/geom-api#Tessellator} functions. See
- * {@link @thi.ng/geom-tessellate#} package for more details.
+ * [`Tessellator`](https://docs.thi.ng/umbrella/geom-api/types/Tessellator.html)
+ * functions. See
+ * [thi.ng/geom-tessellate](https://thi.ng/thi.ng/geom-tessellate) package for
+ * more details.
  *
  * @remarks
  * Implemented for all shapes supported by {@link vertices}.

package/tessellate.js

@@ -4,8 +4,10 @@ import { __dispatch } from "./internal/dispatch.js";
 import { vertices } from "./vertices.js";
 /**
  * Recursively tessellates shape using provided
- * {@link @thi.ng/geom-api#Tessellator} functions. See
- * {@link @thi.ng/geom-tessellate#} package for more details.
+ * [`Tessellator`](https://docs.thi.ng/umbrella/geom-api/types/Tessellator.html)
+ * functions. See
+ * [thi.ng/geom-tessellate](https://thi.ng/thi.ng/geom-tessellate) package for
+ * more details.
  *
  * @remarks
  * Implemented for all shapes supported by {@link vertices}.

package/vertices.d.ts

@@ -4,7 +4,8 @@ import { SamplingOpts } from "@thi.ng/geom-api/sample";
 import type { Vec } from "@thi.ng/vectors";
 /**
  * Extracts/samples vertices from given shape's boundary and returns them as
- * array. Some shapes also support {@link @thi.ng/geom-api#SamplingOpts}.
+ * array. Some shapes also support
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html).
  *
  * @remarks
  * The given sampling options (if any) can also be overridden per shape using

package/vertices.js

@@ -16,7 +16,8 @@ import { Polygon } from "./api/polygon.js";
 import { __dispatch } from "./internal/dispatch.js";
 /**
  * Extracts/samples vertices from given shape's boundary and returns them as
- * array. Some shapes also support {@link @thi.ng/geom-api#SamplingOpts}.
+ * array. Some shapes also support
+ * [`SamplingOpts`](https://docs.thi.ng/umbrella/geom-api/interfaces/SamplingOpts.html).
  *
  * @remarks
  * The given sampling options (if any) can also be overridden per shape using

package/with-attribs.d.ts

@@ -1,8 +1,9 @@
 import type { Attribs, IShape } from "@thi.ng/geom-api";
 /**
  * Returns a shallow copy of given shape with new `attribs` assigned (using
- * {@link @thi.ng/geom-api#IAttributed.withAttribs}). If `replace` is false, the
- * new attribs will be merged with the existing ones (if any).
+ * [`IAttributed`](https://docs.thi.ng/umbrella/geom-api/interfaces/IAttributed.html).withAttribs}).
+ * If `replace` is false, the new attribs will be merged with the existing ones
+ * (if any).
  *
  * @param shape
  * @param attribs

package/with-attribs.js

@@ -1,7 +1,8 @@
 /**
  * Returns a shallow copy of given shape with new `attribs` assigned (using
- * {@link @thi.ng/geom-api#IAttributed.withAttribs}). If `replace` is false, the
- * new attribs will be merged with the existing ones (if any).
+ * [`IAttributed`](https://docs.thi.ng/umbrella/geom-api/interfaces/IAttributed.html).withAttribs}).
+ * If `replace` is false, the new attribs will be merged with the existing ones
+ * (if any).
  *
  * @param shape
  * @param attribs