@thi.ng/geom-splines 2.2.105 → 2.3.0

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,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.
 
+## [2.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom-splines@2.3.0) (2024-06-21)
+
+#### 🚀 Features
+
+- add cubicHobby() curve fitting ([1cefc37](https://github.com/thi-ng/umbrella/commit/1cefc37))
+
+#### ⏱ Performance improvements
+
+- update cubicHobby2() ([33bb393](https://github.com/thi-ng/umbrella/commit/33bb393))
+
+#### ♻️ Refactoring
+
+- remove geom-api dep, update imports ([eab7bb9](https://github.com/thi-ng/umbrella/commit/eab7bb9))
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ### [2.2.61](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom-splines@2.2.61) (2023-11-09)
 
 #### ♻️ 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.
 >
@@ -71,13 +71,12 @@ For Node.js REPL:
 const gs = await import("@thi.ng/geom-splines");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.38 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.79 KB
 
 ## Dependencies
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
 - [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
-- [@thi.ng/geom-api](https://github.com/thi-ng/umbrella/tree/develop/packages/geom-api)
 - [@thi.ng/geom-arc](https://github.com/thi-ng/umbrella/tree/develop/packages/geom-arc)
 - [@thi.ng/geom-resample](https://github.com/thi-ng/umbrella/tree/develop/packages/geom-resample)
 - [@thi.ng/math](https://github.com/thi-ng/umbrella/tree/develop/packages/math)

package/cubic-bounds.js

@@ -1,5 +1,5 @@
 import { mixCubic } from "@thi.ng/math/mix";
-const axisBounds = (min, max, i, pa, pb, pc, pd) => {
+const __axisBounds = (min, max, i, pa, pb, pc, pd) => {
   min[i] = Math.min(pa, pd);
   max[i] = Math.max(pa, pd);
   const k0 = -pa + pb;
@@ -23,7 +23,7 @@ const cubicBounds = (a, b, c, d) => {
   const min = [];
   const max = [];
   for (let i = a.length; i-- > 0; ) {
-    axisBounds(min, max, i, a[i], b[i], c[i], d[i]);
+    __axisBounds(min, max, i, a[i], b[i], c[i], d[i]);
   }
   return [min, max];
 };

package/cubic-from-breakpoints.js

@@ -6,7 +6,7 @@ import { maddN2 } from "@thi.ng/vectors/maddn";
 import { mulN, mulN2 } from "@thi.ng/vectors/muln";
 import { perpendicularCW } from "@thi.ng/vectors/perpendicular";
 import { set2 } from "@thi.ng/vectors/set";
-const buildSegments = (tangents, t, uniform) => {
+const __buildSegments = (tangents, t, uniform) => {
   const res = [];
   for (let i = 0, num = tangents.length - 1; i < num; i++) {
     const [a, na] = tangents[i];
@@ -30,7 +30,7 @@ const closedCubicFromBreakPoints = (points, t = 1 / 3, uniform = false) => {
     tangents.push([set2([], b), n]);
   }
   tangents.push(tangents[0]);
-  return buildSegments(tangents, t, uniform);
+  return __buildSegments(tangents, t, uniform);
 };
 const openCubicFromBreakPoints = (points, t = 1 / 3, uniform = false) => {
   const tangents = [
@@ -49,7 +49,7 @@ const openCubicFromBreakPoints = (points, t = 1 / 3, uniform = false) => {
     tangents.push([set2([], b), n]);
   }
   tangents.push([points[num], direction2([], points[num - 1], points[num])]);
-  return buildSegments(tangents, t, uniform);
+  return __buildSegments(tangents, t, uniform);
 };
 export {
   closedCubicFromBreakPoints,

package/cubic-from-controlpoints.js

@@ -3,7 +3,7 @@ import { addmN } from "@thi.ng/vectors/addmn";
 import { direction } from "@thi.ng/vectors/direction";
 import { mixN } from "@thi.ng/vectors/mixn";
 import { set } from "@thi.ng/vectors/set";
-const buildUniform = (segments, t) => {
+const __buildUniform = (segments, t) => {
   const res = [];
   for (let i = 0, n = segments.length - 2; i < n; i += 2) {
     const a = segments[i];
@@ -18,7 +18,7 @@ const buildUniform = (segments, t) => {
   }
   return res;
 };
-const buildNonUniform = (segments, t) => {
+const __buildNonUniform = (segments, t) => {
   const res = [];
   for (let i = 0, n = segments.length - 2; i < n; i += 2) {
     const a = segments[i];
@@ -35,7 +35,7 @@ const closedCubicFromControlPoints = (points, t = 1, uniform = false) => {
     segments.push(addmN([], points[i], q, 0.5), set([], q));
   }
   segments.push(segments[0]);
-  return uniform ? buildUniform(segments, t) : buildNonUniform(segments, t);
+  return uniform ? __buildUniform(segments, t) : __buildNonUniform(segments, t);
 };
 const openCubicFromControlPoints = (points, t = 1, uniform = false) => {
   const segments = [set([], points[0]), set([], points[0])];
@@ -45,7 +45,7 @@ const openCubicFromControlPoints = (points, t = 1, uniform = false) => {
     segments.push(addmN([], points[i], q, 0.5), set([], q));
   }
   segments.push(set([], points[num]));
-  return uniform ? buildUniform(segments, t) : buildNonUniform(segments, t);
+  return uniform ? __buildUniform(segments, t) : __buildNonUniform(segments, t);
 };
 export {
   closedCubicFromControlPoints,

package/cubic-hobby.d.ts

@@ -0,0 +1,19 @@
+import { type ReadonlyVec, type Vec } from "@thi.ng/vectors";
+/**
+ * Fits a cubic bezier spline to the given array of `points` and tension param
+ * `omega` (in [0,1] range), using John D. Hobby's algorithm/paper: "Smooth,
+ * Easy to Compute Interpolating Splines".
+ *
+ * @remarks
+ * References:
+ * - https://link.springer.com/content/pdf/10.1007/BF02187690.pdf
+ * - https://web.archive.org/web/20220816011347/https://ctan.math.washington.edu/tex-archive/graphics/pgf/contrib/hobby/hobby.pdf
+ * - http://weitz.de/hobby/
+ * - https://www.jakelow.com/blog/hobby-curves (based on Weitz)
+ *
+ * @param points
+ * @param closed
+ * @param omega
+ */
+export declare const cubicHobby2: (points: ReadonlyVec[], closed?: boolean, omega?: number) => Vec[][];
+//# sourceMappingURL=cubic-hobby.d.ts.map

package/cubic-hobby.js

@@ -0,0 +1,78 @@
+import { THIRD, TWO_THIRD } from "@thi.ng/math/api";
+import { solveTridiagonal } from "@thi.ng/math/solve";
+import {
+  angleBetween2,
+  mag2
+} from "@thi.ng/vectors";
+import { add2 } from "@thi.ng/vectors/add";
+import { normalize2 } from "@thi.ng/vectors/normalize";
+import { rotate } from "@thi.ng/vectors/rotate";
+import { sub2 } from "@thi.ng/vectors/sub";
+import { set2 } from "@thi.ng/vectors/set";
+const cubicHobby2 = (points, closed = false, omega = 1) => {
+  const nump = points.length;
+  if (closed) {
+    points = points.slice(nump - 3).concat(points, points.slice(0, 3));
+  }
+  const n = points.length - 1;
+  const chords = new Array(n);
+  const d = new Array(n);
+  const alpha = new Array(n + 1);
+  const gamma = new Array(n + 1);
+  const A = new Array(n + 1);
+  const B = new Array(n + 1);
+  const C = new Array(n + 1);
+  for (let i = 0; i < n; i++) {
+    const delta = chords[i] = sub2([], points[i + 1], points[i]);
+    d[i] = mag2(delta);
+    i > 0 && (gamma[i] = angleBetween2(chords[i - 1], delta));
+  }
+  B[0] = B[n] = 2 + omega;
+  C[0] = A[n] = 2 * omega + 1;
+  alpha[0] = -C[0] * gamma[1];
+  alpha[n] = gamma[n] = 0;
+  for (let i = 1; i < n; i++) {
+    const dprev = d[i - 1];
+    const dcurr = d[i];
+    const invD = 1 / (dprev * dcurr);
+    A[i] = 1 / dprev;
+    B[i] = (2 * dprev + 2 * dcurr) * invD;
+    C[i] = 1 / dcurr;
+    alpha[i] = -(2 * gamma[i] * dcurr + gamma[i + 1] * dprev) * invD;
+  }
+  solveTridiagonal(A, B, C, alpha);
+  const res = [];
+  const [from, to] = closed ? [3, 3 + nump] : [0, n];
+  for (let i = from; i < to; i++) {
+    const a = alpha[i];
+    const b = i < n - 1 ? -gamma[i + 1] - alpha[i + 1] : -alpha[n];
+    const c = chords[i];
+    const cosA = Math.cos(a);
+    const cosB = Math.cos(b);
+    const scale = TWO_THIRD * d[i];
+    res.push([
+      set2([], points[i]),
+      add2(
+        null,
+        normalize2(null, rotate([], c, a), __rho(cosA, cosB, scale)),
+        points[i]
+      ),
+      add2(
+        null,
+        // reuse chord vector for result to avoid extraneous allocation
+        normalize2(
+          null,
+          rotate(null, c, -b),
+          -__rho(cosB, cosA, scale)
+        ),
+        points[i + 1]
+      ),
+      set2([], points[i + 1])
+    ]);
+  }
+  return res;
+};
+const __rho = (cosA, cosB, scale) => scale / (1 + THIRD * cosA + TWO_THIRD * cosB);
+export {
+  cubicHobby2
+};

package/cubic-sample.d.ts

@@ -1,3 +1,3 @@
-export declare const sampleCubic: (pts: import("@thi.ng/vectors").ReadonlyVec[], opts?: number | Partial<import("@thi.ng/geom-api/sample").SamplingOpts> | undefined) => import("@thi.ng/vectors").Vec[];
-export declare const sampleCubicArray: (segments: import("@thi.ng/vectors").ReadonlyVec[][], closed: boolean | undefined, opts: number | Partial<import("@thi.ng/geom-api/sample").SamplingOpts>) => any[];
+export declare const sampleCubic: (pts: import("@thi.ng/vectors").ReadonlyVec[], opts?: number | Partial<import("@thi.ng/geom-resample/api").SamplingOpts>) => import("@thi.ng/vectors").Vec[];
+export declare const sampleCubicArray: (segments: import("@thi.ng/vectors").ReadonlyVec[][], closed: boolean | undefined, opts: number | Partial<import("@thi.ng/geom-resample/api").SamplingOpts>) => any[];
 //# sourceMappingURL=cubic-sample.d.ts.map

package/index.d.ts

@@ -3,6 +3,7 @@ export * from "./cubic-bounds.js";
 export * from "./cubic-closest-point.js";
 export * from "./cubic-from-breakpoints.js";
 export * from "./cubic-from-controlpoints.js";
+export * from "./cubic-hobby.js";
 export * from "./cubic-line.js";
 export * from "./cubic-quadratic.js";
 export * from "./cubic-sample.js";

package/index.js

@@ -3,6 +3,7 @@ export * from "./cubic-bounds.js";
 export * from "./cubic-closest-point.js";
 export * from "./cubic-from-breakpoints.js";
 export * from "./cubic-from-controlpoints.js";
+export * from "./cubic-hobby.js";
 export * from "./cubic-line.js";
 export * from "./cubic-quadratic.js";
 export * from "./cubic-sample.js";

package/internal/sample.d.ts

@@ -1,5 +1,5 @@
 import type { Fn2, Fn3 } from "@thi.ng/api";
-import { type SamplingOpts } from "@thi.ng/geom-api/sample";
+import { type SamplingOpts } from "@thi.ng/geom-resample/api";
 import type { ReadonlyVec, Vec } from "@thi.ng/vectors";
 export declare const __sample: (sample: Fn3<Vec[], ReadonlyVec[], number, void>) => (pts: ReadonlyVec[], opts?: number | Partial<SamplingOpts>) => Vec[];
 export declare const __sampleArray: (fn: Fn2<ReadonlyVec[], Partial<SamplingOpts>, Vec[]>) => (segments: ReadonlyVec[][], closed: boolean | undefined, opts: number | Partial<SamplingOpts>) => any[];

package/internal/sample.js

@@ -1,6 +1,6 @@
 import { isNumber } from "@thi.ng/checks/is-number";
 import { isPlainObject } from "@thi.ng/checks/is-plain-object";
-import { DEFAULT_SAMPLES } from "@thi.ng/geom-api/sample";
+import { DEFAULT_SAMPLES } from "@thi.ng/geom-resample/api";
 import { Sampler } from "@thi.ng/geom-resample/sampler";
 import { set } from "@thi.ng/vectors/set";
 const __sample = (sample) => function $(pts, opts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom-splines",
-  "version": "2.2.105",
+  "version": "2.3.0",
   "description": "nD cubic & quadratic curve analysis, conversion, interpolation, splitting",
   "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/geom-splines#readme",
+  "homepage": "https://thi.ng/geom-splines",
   "funding": [
     {
       "type": "github",
@@ -36,19 +36,18 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.1",
-    "@thi.ng/checks": "^3.6.3",
-    "@thi.ng/geom-api": "^4.0.9",
-    "@thi.ng/geom-arc": "^2.1.131",
-    "@thi.ng/geom-resample": "^2.3.52",
-    "@thi.ng/math": "^5.10.12",
-    "@thi.ng/vectors": "^7.10.30"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/geom-arc": "^2.1.133",
+    "@thi.ng/geom-resample": "^3.0.0",
+    "@thi.ng/math": "^5.11.0",
+    "@thi.ng/vectors": "^7.11.0"
   },
   "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",
@@ -101,6 +100,9 @@
     "./cubic-from-controlpoints": {
       "default": "./cubic-from-controlpoints.js"
     },
+    "./cubic-hobby": {
+      "default": "./cubic-hobby.js"
+    },
     "./cubic-line": {
       "default": "./cubic-line.js"
     },
@@ -144,5 +146,5 @@
       "geom-subdiv-curve"
     ]
   },
-  "gitHead": "aed3421c21044c005fbcb7cc37965ccf85a870d2\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/quadratic-bounds.js

@@ -1,25 +1,24 @@
 import { clamp01, inRange } from "@thi.ng/math/interval";
 import { max } from "@thi.ng/vectors/max";
 import { min } from "@thi.ng/vectors/min";
-const solveQuadratic = (a, b, c) => {
+const __solveQuadratic = (a, b, c) => {
   const t = clamp01((a - b) / (a - 2 * b + c));
   const s = 1 - t;
   return s * s * a + 2 * s * t * b + t * t * c;
 };
-const inBounds = (p, min2, max2) => {
+const __inBounds = (p, min2, max2) => {
   for (let i = p.length; i-- > 0; ) {
-    if (!inRange(p[i], min2[i], max2[i]))
-      return false;
+    if (!inRange(p[i], min2[i], max2[i])) return false;
   }
   return true;
 };
 const quadraticBounds = (a, b, c) => {
   const mi = min([], a, c);
   const ma = max([], a, c);
-  if (!inBounds(b, mi, ma)) {
+  if (!__inBounds(b, mi, ma)) {
     const q = [];
     for (let i = a.length; i-- > 0; ) {
-      q[i] = solveQuadratic(a[i], b[i], c[i]);
+      q[i] = __solveQuadratic(a[i], b[i], c[i]);
     }
     min(null, mi, q);
     max(null, ma, q);

package/quadratic-sample.d.ts

@@ -1,3 +1,3 @@
-export declare const sampleQuadratic: (pts: import("@thi.ng/vectors").ReadonlyVec[], opts?: number | Partial<import("@thi.ng/geom-api/sample").SamplingOpts> | undefined) => import("@thi.ng/vectors").Vec[];
-export declare const sampleQuadraticArray: (segments: import("@thi.ng/vectors").ReadonlyVec[][], closed: boolean | undefined, opts: number | Partial<import("@thi.ng/geom-api/sample").SamplingOpts>) => any[];
+export declare const sampleQuadratic: (pts: import("@thi.ng/vectors").ReadonlyVec[], opts?: number | Partial<import("@thi.ng/geom-resample/api").SamplingOpts>) => import("@thi.ng/vectors").Vec[];
+export declare const sampleQuadraticArray: (segments: import("@thi.ng/vectors").ReadonlyVec[][], closed: boolean | undefined, opts: number | Partial<import("@thi.ng/geom-resample/api").SamplingOpts>) => any[];
 //# sourceMappingURL=quadratic-sample.d.ts.map