flo-mat 3.0.0 → 3.0.2

package/node/corner/get-interface-ccw.js

@@ -1,5 +1,5 @@
 import { eAdd, eEstimate, eMult, eNegativeOf, twoDiff } from 'big-float-ts';
-import { dot } from "flo-vector2d";
+// import { dot } from "flo-vector2d";
 import { compareCurvaturesAtInterface } from "./compare-curvatures-at-interface.js";
 /**
  * Returns a positive value if the second bezier (of order 1, 2 or 3) curves
@@ -12,68 +12,85 @@ import { compareCurvaturesAtInterface } from "./compare-curvatures-at-interface.
  * The above obviously necessitates that their endpoints coincide as described.
  *
  * Preconditions (for robustness):
- * * The beziers has control points with max bit-length of 25 and bit-aligned.
  * * The bezier does not have infinite curvature at either endpoint
  *
- * This is so the vectors between control points can be
- * calculated exactly without resorting to adaptive infinite precision floating
- * point operations. Note: aligned to 'grid' here means if you bitwise-and all
- * values together the resulting bitlength === the max bithlength of any value.
- *
  * @param psI The incoming bezier that ends at the interface
  * @param psO The outgoing bezier that starts at the interface
  */
-// TODO - improve and make at least 46-bitlength precondition
 function getInterfaceCcw(psI, psO) {
     const lenI = psI.length;
     // second last control point of incoming curve
-    const p0 = psI[lenI - 2];
+    let p0 = psI[lenI - 2];
     // last control point of incoming curve / first control point of outgoing
-    const p1 = psO[0];
+    let p1 = psO[0];
     // second control point of outgoing curve
-    const p2 = psO[1];
-    // Max one bit can be added in the calculations below due to bit-alignment
-    const xE = p1[0] - p0[0]; // tangent x-coordinate
-    const yE = p1[1] - p0[1]; // tangent y-coordinate
-    const xS = p2[0] - p1[0]; // tangent x-coordinate
-    const yS = p2[1] - p1[1]; // tangent y-coordinate
-    // If the tangent is to be found at t === 0 or t === 1 then using a basic 
-    // property of bezier curves we can find the tangents easily as below
-    // (non-normalized) tangent of incoming curve at t === 1
-    const tangentAtEnd = [xE, yE];
-    // (non-normalized) tangent of outgoing curve at t === 0
-    const tangentAtStart = [xS, yS];
-    // const crossTangents = orient2d(p0, p1, p2);
-    const crossTangents = orient2dPrecise(p0, p1, p2);
-    if (crossTangents !== 0) {
-        return crossTangents;
+    let p2 = psO[1];
+    // infinite curvature - we're now handling this as well
+    if (pointsEqual(p0, p1)) {
+        p0 = psI[lenI - 3]; // length cannot be 2
+    }
+    if (pointsEqual(p1, p2)) {
+        p2 = psO[2]; // length cannot be 2
     }
-    // The dot calculated below will have a max bitlength of 
-    // (2*(maxBitLength + 1)) + 1 === e.g. (2*(25 + 1)) + 1 === 53
-    // If the preconditions are met it is exact
-    const dotTangents = dot(tangentAtEnd, tangentAtStart);
-    if (dotTangents > 0) {
-        // Curves go in same direction at interface - neither clock or 
-        // anti-clockwise.
-        // Note: The above comment is not strictly true but as this case is not
-        // important for the algorithm we return 0
-        return 0;
+    const crossTangents = crossPrecise(p0, p1, p2); // sign will be correct
+    const xI = twoDiff(p1[0], p0[0]); // tangent x-coordinate
+    const yI = twoDiff(p1[1], p0[1]); // tangent y-coordinate
+    const xO = twoDiff(p2[0], p1[0]); // tangent x-coordinate
+    const yO = twoDiff(p2[1], p1[1]); // tangent y-coordinate
+    const tangentI = [xI, yI];
+    const tangentO = [xO, yO];
+    const dotTangents = dotPrecise(tangentI, tangentO);
+    if (crossTangents !== 0 || dotTangents > 0) {
+        return {
+            ccw: crossTangents,
+            tangentI,
+            tangentO,
+            // crossTangents,
+            dotTangents
+        };
     }
     // Curves go in opposite directions at interface starting off with the exact
     // same tangent - look now at curvature to see which has the largest 
     // curvature so we can base the clock or anti-clockwise result on that
     // Look at curvature
-    return compareCurvaturesAtInterface(psI.slice().reverse(), psO);
+    // TODO2
+    // The line below is probably not working correctly for infinite
+    // curvature but it should be rare to get here - investiagte.
+    // Probably need to resort to length of tangents and then if this is
+    // also the same simply look at the last point's ccw wrt the 1st or
+    // the second?
+    return {
+        ccw: compareCurvaturesAtInterface(psI.slice().reverse(), psO),
+        tangentI,
+        tangentO,
+        // crossTangents,
+        dotTangents
+    };
+}
+function pointsEqual(p1, p2) {
+    return p1[0] === p2[0] && p1[1] === p2[1];
+}
+/**
+ * The input is two exact double-double coefficient vectors
+ *
+ * * returns the correct sign
+ */
+function dotPrecise(tangentI, tangentO) {
+    const abx = eMult(tangentI[0], tangentO[0]);
+    const aby = eMult(tangentI[1], tangentO[1]);
+    const dot = eAdd(abx, aby);
+    return eEstimate(dot);
 }
-/** Returns the cross from A to B to C */
-function orient2dPrecise(A, B, C) {
-    // const detleft  = (A[0] - C[0]) * (B[1] - C[1]);
-    // const detright = (A[1] - C[1]) * (B[0] - C[0]);
-    // const det = detleft - detright;
-    const a = twoDiff(A[0], C[0]);
-    const b = twoDiff(B[1], C[1]);
-    const c = twoDiff(A[1], C[1]);
-    const d = twoDiff(B[0], C[0]);
+/**
+ * Returns the cross from A to B to C
+ *
+ * * returns the correct sign
+ */
+function crossPrecise(p0, p1, p2) {
+    const a = twoDiff(p0[0], p2[0]);
+    const b = twoDiff(p1[1], p2[1]);
+    const c = twoDiff(p0[1], p2[1]);
+    const d = twoDiff(p1[0], p2[0]);
     const e = eMult(a, b);
     const f = eMult(c, d);
     const g = eAdd(e, eNegativeOf(f));

package/node/corner/get-interface-ccw.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-interface-ccw.js","sourceRoot":"","sources":["../../src/corner/get-interface-ccw.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAsB,OAAO,EAAE,MAAM,cAAc,CAAC;AAChG,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AAGpF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,6DAA6D;AAC7D,SAAS,eAAe,CAAC,GAAe,EAAE,GAAe;IACrD,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;IAExB,8CAA8C;IAC9C,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,GAAC,CAAC,CAAC,CAAC;IACvB,yEAAyE;IACzE,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAClB,yCAAyC;IACzC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAElB,0EAA0E;IAC1E,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IACrD,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IAClD,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IAC/C,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IAErD,0EAA0E;IACvE,qEAAqE;IAErE,wDAAwD;IACxD,MAAM,YAAY,GAAG,CAAC,EAAE,EAAC,EAAE,CAAC,CAAC;IAC7B,wDAAwD;IAC3D,MAAM,cAAc,GAAG,CAAC,EAAE,EAAC,EAAE,CAAC,CAAC;IAE5B,8CAA8C;IAC9C,MAAM,aAAa,GAAG,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAErD,IAAI,aAAa,KAAK,CAAC,EAAE;QACxB,OAAO,aAAa,CAAC;KAClB;IAED,yDAAyD;IACzD,8DAA8D;IAC9D,2CAA2C;IAC3C,MAAM,WAAW,GAAG,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACtD,IAAI,WAAW,GAAG,CAAC,EAAE;QACjB,+DAA+D;QAC/D,kBAAkB;QAClB,uEAAuE;QACvE,0CAA0C;QAC1C,OAAO,CAAC,CAAC;KACZ;IAED,4EAA4E;IAC5E,qEAAqE;IACrE,sEAAsE;IAEtE,oBAAoB;IACpB,OAAO,4BAA4B,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;AACpE,CAAC;AAGD,yCAAyC;AACzC,SAAS,eAAe,CAChB,CAAW,EACX,CAAW,EACX,CAAW;IAEf,kDAAkD;IAClD,kDAAkD;IAClD,kCAAkC;IAElC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC;IACrB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC;IAErB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;AACxB,CAAC;AAGD,OAAO,EAAE,eAAe,EAAE,CAAA"}
+{"version":3,"file":"get-interface-ccw.js","sourceRoot":"","sources":["../../src/corner/get-interface-ccw.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAa,SAAS,EAAE,KAAK,EAAE,WAAW,EAAsB,OAAO,EAAE,MAAM,cAAc,CAAC;AAC3G,sCAAsC;AACtC,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AAGpF;;;;;;;;;;;;;;;GAeG;AACH,SAAS,eAAe,CAChB,GAAe,EACf,GAAe;IAQnB,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;IAExB,8CAA8C;IAC9C,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,GAAC,CAAC,CAAC,CAAC;IACrB,yEAAyE;IACzE,IAAI,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,yCAAyC;IACzC,IAAI,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAEhB,uDAAuD;IACvD,IAAI,WAAW,CAAC,EAAE,EAAC,EAAE,CAAC,EAAE,CAAC;QACrB,EAAE,GAAG,GAAG,CAAC,IAAI,GAAC,CAAC,CAAC,CAAC,CAAE,qBAAqB;IAC5C,CAAC;IACD,IAAI,WAAW,CAAC,EAAE,EAAC,EAAE,CAAC,EAAE,CAAC;QACrB,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,qBAAqB;IACvC,CAAC;IAED,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,EAAC,EAAE,EAAC,EAAE,CAAC,CAAC,CAAE,uBAAuB;IAEtE,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IAC5D,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IACzD,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IACtD,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,uBAAuB;IAEzD,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAC,EAAE,CAAC,CAAC;IACzB,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAC,EAAE,CAAC,CAAC;IACzB,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,EAAC,QAAQ,CAAC,CAAC;IAElD,IAAI,aAAa,KAAK,CAAC,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;QAC/C,OAAO;YACG,GAAG,EAAE,aAAa;YAClB,QAAQ;YACR,QAAQ;YACR,iBAAiB;YACjB,WAAW;SACd,CAAA;IACL,CAAC;IAED,4EAA4E;IAC5E,qEAAqE;IACrE,sEAAsE;IAEtE,oBAAoB;IAEpB,QAAQ;IACR,gEAAgE;IAChE,6DAA6D;IAC7D,oEAAoE;IACpE,mEAAmE;IACnE,cAAc;IACd,OAAO;QACH,GAAG,EAAE,4BAA4B,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC;QAC7D,QAAQ;QACR,QAAQ;QACR,iBAAiB;QACjB,WAAW;KACd,CAAA;AACL,CAAC;AAGD,SAAS,WAAW,CACZ,EAAY,EACZ,EAAY;IAEhB,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CACX,QAAoB,EACpB,QAAoB;IAExB,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAC,GAAG,CAAC,CAAC;IAE1B,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAGD;;;;GAIG;AACH,SAAS,YAAY,CACb,EAAY,EACZ,EAAY,EACZ,EAAY;IAEhB,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC;IACrB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC;IAErB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;AACxB,CAAC;AAGD,OAAO,EAAE,eAAe,EAAE,CAAA"}

package/node/cp-node/cp-node-fs.d.ts

@@ -0,0 +1,225 @@
+import { CpNode } from "./cp-node.js";
+import { getHoleClosers } from "./fs/get-hole-closers.js";
+import { getSpeed } from "./fs/get-speed.js";
+import { enhanceCpNode } from "./fs/enhance-cp-node.js";
+import { traverseCp } from './fs/traverse-cp.js';
+import { traverseEdges } from './fs/traverse-edges.js';
+import { traverseVertices } from './fs/traverse-vertices.js';
+import { clone } from './fs/clone.js';
+import { getBoundaryBezierPartsToNext } from './fs/get-boundary-bezier-parts-to-next.js';
+import { getBoundaryBeziersToNext } from './fs/get-boundary-beziers-to-next.js';
+import { removeVertex } from '../vertex/remove-vertex.js';
+import { getProngCount } from './fs/get-prong-count.js';
+import { getChildren } from './fs/get-children.js';
+import { getAllOnLoop } from './fs/get-all-on-loop.js';
+import { getAllOnCircle } from './fs/get-all-on-circle.js';
+import { getMatCurveToNext } from './fs/get-mat-curve-to-next.js';
+import { getFirstExit } from './fs/get-first-exit.js';
+import { getRealProngCount } from './fs/get-real-prong-count.js';
+import { isFullyTerminating } from './fs/is-fully-terminating.js';
+import { isOnSameCircle } from './fs/is-on-same-circle.js';
+import { isOneProng } from './fs/is-one-prong.js';
+import { isSharp } from './fs/is-sharp.js';
+import { isTerminating } from './fs/is-terminating.js';
+import { getVertexForwardChildren } from './fs/get-vertex-forward-children.js';
+import { isTwoProng } from './fs/is-two-prong.js';
+import { getBranch } from './fs/get-branch.js';
+import { getBranchBeziers } from './fs/get-branch-beziers.js';
+import { getSalience } from './fs/get-salience.js';
+import { getMatCurveBetween } from './fs/get-mat-curve-between.js';
+import { getEdgeDirection } from './fs/get-edge-direction.js';
+import { getBoundaryBeziersBetween } from './fs/get-boundary-beziers-between.js';
+import { getMatCurvesBetween } from './fs/get-mat-curves-between.js';
+import { getInitialDegAngleBetweenMatCurves } from "./fs/get-angle-between-mat-curves.js";
+import { getAllVertices } from "./fs/get-all-vertices.js";
+declare const CpNodeFs: {
+    /**
+     * Returns the children of this [[CpNode]] when seen as a MAT edge. Only
+     * children in a 'forward' direction are returned. These include all edges
+     * except the 'backward' edge given by [[prevOnCircle]], even terminating
+     * edges.
+     */
+    getChildren: typeof getChildren;
+    /**
+     * Similar to [[getChildren]] but returns the child nodes of the tree when
+     * [[CpNode]] is seen as a MAT vertex point (as opposed to edge). In this
+     * way the dual graph of the tree can easily be traversed - see e.g.
+     * [[traverseVertices]]. Generally, however, traversing the edges is
+     * preferred as it returns the entire Medial Axis (by utilizing
+     * [[getMatCurveToNext]] on each returned edge).
+     */
+    getVertexForwardChildren: typeof getVertexForwardChildren;
+    /**
+     * Returns all [[CpNode]]s on the MAT that this [[CpNode]] is part of
+     * starting from the current one and going anti-clockwise around the shape.
+     */
+    getAllOnLoop: typeof getAllOnLoop;
+    /**
+     * Return this (except if exclThis is truthy) and the the other CpNodes
+     * around the maximal disk vertex circle in an anti-clockwise order.
+     * @param exclThis If true the returned array does not include this
+     * [[CpNode]].
+     */
+    getAllOnCircle: typeof getAllOnCircle;
+    /**
+     * Returns true if the 2 given [[CpNode]]s are on the same maximal disk
+     * circle.
+     * @param cpNode1 A [[CpNode]].
+     * @param cpNode2 Another [[CpNode]]
+     */
+    isOnSameCircle: typeof isOnSameCircle;
+    /**
+     * Returns true if this [[CpNode]] is terminating, i.e. implies a leaf MAT
+     * vertex.
+     *
+     * This is always the case for sharp corners and maximal disks with
+     * a single contact point. Note, however, that even in these cases there are
+     * two contact points stored (sitting 'on top' of each other) for the
+     * maximal disk. It can be seen as a limiting case of a two-prong where the
+     * distance between two of the contact points tend to zero. One point
+     * (represented by a [[CpNode]] of course) will be terminating with the
+     * other point being its [[next]], whereas the other point will *not* be
+     * terminating and 'points' back into the shape.
+     */
+    isTerminating: typeof isTerminating;
+    /**
+     * Like isTerminating() but only returns true if all cpNodes on the circle
+     * (except this.prevOnCircle) is terminating.
+     */
+    isFullyTerminating: typeof isFullyTerminating;
+    /**
+     * Returns the first [[CpNode]] (from this one by successively applying
+     * .nextOnCircle) that exits the circle.
+     */
+    getFirstExit: typeof getFirstExit;
+    /**
+     * Returns true if this [[CpNode]] represents a sharp corner, i.e. the
+     * limiting case of a two-prong having zero radius.
+     *
+     * Note that two [[CpNode]]s are stored for each sharp corner, one being
+     * terminating and one not. See [[isTerminating]] for more details.
+     */
+    isSharp: typeof isSharp;
+    /**
+     * Returns true if this [[CpNode]]'s maximal disk has only one contact point
+     * on the shape boundary (up to planar coordinates). These includes sharp
+     * corners.
+     *
+     * Note, however, that two [[CpNode]]s are stored for each such point to
+     * preserve symmetry - see [[isTerminating]] for more details.
+     */
+    isOneProng: typeof isOneProng;
+    /**
+     * Returns the number of contact points on the maximal disk circle implied
+     * by this [[CpNode]].
+     *
+     * Note, however, that even one-prongs and sharp corners will return 2 (see
+     * [[isTerminating]] for more details); if this is not desired use
+     * [[getRealProngCount]] instead which will return 1 in these cases.
+     */
+    getProngCount: typeof getProngCount;
+    /**
+     * Returns the number of contact points (up to planar coordinates) on the
+     * maximal disk circle implied by this [[CpNode]].
+     *
+     * See also [[getProngCount]].
+     */
+    getRealProngCount: typeof getRealProngCount;
+    /**
+     * Primarily for internal use.
+     *
+     * Compares the order of two [[CpNode]]s. The order is cyclic and depends
+     * on a [[CpNode]]'s relative position along the shape boundary.
+     */
+    cpNodeComparator: (a: CpNode, b: CpNode) => number;
+    /**
+     * For debugging
+     * @param cpNode
+     */
+    enhanceCpNode: typeof enhanceCpNode;
+    /**
+     * @internal
+     *
+     * Traverses the shape from the given `CpNode` going around the shortest path
+     * so that only a piece of the shape is traversed and returns the visited
+     * `CpNode`s (starting from the given `CpNode`).
+     *
+     * @param cpStart The `CpNode` from where to start the traversal.
+     */
+    traverseCp: typeof traverseCp;
+    /**
+     * Traverses all edges (depth first) of the given MAT tree starting at the given
+     * vertex (represented by a [[CpNode]]).
+     * @param cpNode Any [[CpNode]] representing the start vertex.
+     * @param traverseEdgesCallback A callback function for each CpNode representing the vertex at the
+     * start of an edge.
+     */
+    traverseEdges: typeof traverseEdges;
+    /**
+     * Traverses the MAT tree and calls the given callback function for each vertex
+     * (represented by a [[CpNode]]) on the MAT.
+     *
+     * It is usually preferable to use [[traverseEdges]] as it allows for the
+     * traversal of all the smooth curves representing the MAT.
+     * @param cpNode Any [[CpNode]] representing the start vertex.
+     * @param traverseVerticesCallback A callback function taking a single [[CpNode]] as parameter.
+     */
+    traverseVertices: typeof traverseVertices;
+    /**
+     * Returns a deep clone of this [[CpNode]]. Can be used to copy the MAT
+     * since cloning a single [[CpNode]] necessarily implies cloning all
+     * [[CpNode]]s on the same MAT tree.
+     */
+    clone: typeof clone;
+    /**
+     * Returns the ordered bezier curves from this CpNode to the next CpNode
+     * on the boundary.
+     * @param cpNode
+     */
+    getBoundaryBezierPartsToNext: typeof getBoundaryBezierPartsToNext;
+    /**
+     * Returns the ordered bezier curves from this CpNode to the next CpNode
+     * on the boundary.
+     * @param cpNode
+     */
+    getBoundaryBeziersToNext: typeof getBoundaryBeziersToNext;
+    /**
+     * Removes a cpNode from the MAT.
+     * @param cpTree The tree graph holding the [[CpNodes]] of the MAT.
+     * @param cpNode The [[CpNode]] to remove.
+     */
+    removeVertex: typeof removeVertex;
+    /**
+     * Returns the bezier curve from the maximal disk of the given [[CpNode]] to the
+     * next [[CpNode]]'s maximal disk and thus directly represents a piece of the
+     * medial axis.
+     * @param cpNode
+     */
+    getMatCurveToNext: typeof getMatCurveToNext;
+    isTwoProng: typeof isTwoProng;
+    getBranch: typeof getBranch;
+    getBranchBeziers: typeof getBranchBeziers;
+    getSalience: typeof getSalience;
+    /**
+     * Returns the bezier curve from the maximal disk of one [[CpNode]] to another
+     * [[CpNode]]'s maximal disk.
+     * @param cpNodeFrom
+     * @param cpNodeTo
+     */
+    getMatCurveBetween: typeof getMatCurveBetween;
+    /**
+     * @internal
+     * Returns a line segment of unit length starting in the given Vertex center and
+     * pointing in the direction of the medial axis (viewed as a rooted tree).
+     * @param cpNode
+     */
+    getEdgeDirection: typeof getEdgeDirection;
+    getBoundaryBeziersBetween: typeof getBoundaryBeziersBetween;
+    getMatCurvesBetween: typeof getMatCurvesBetween;
+    getHoleClosers: typeof getHoleClosers;
+    getSpeed: typeof getSpeed;
+    getSmoothedSpeed$: (a: number) => (a: CpNode) => number | undefined;
+    getInitialDegAngleBetweenMatCurves: typeof getInitialDegAngleBetweenMatCurves;
+    getAllVertices: typeof getAllVertices;
+};
+export { CpNodeFs };

package/node/cp-node/cp-node-fs.js

@@ -0,0 +1,228 @@
+import { compareCps } from "../contact-point/contact-point.js";
+import { getHoleClosers } from "./fs/get-hole-closers.js";
+import { getSpeed } from "./fs/get-speed.js";
+import { getSmoothedSpeed$ } from "./fs/get-smoothed-speed.js";
+import { enhanceCpNode } from "./fs/enhance-cp-node.js";
+import { traverseCp } from './fs/traverse-cp.js';
+import { traverseEdges } from './fs/traverse-edges.js';
+import { traverseVertices } from './fs/traverse-vertices.js';
+import { clone } from './fs/clone.js';
+import { getBoundaryBezierPartsToNext } from './fs/get-boundary-bezier-parts-to-next.js';
+import { getBoundaryBeziersToNext } from './fs/get-boundary-beziers-to-next.js';
+import { removeVertex } from '../vertex/remove-vertex.js';
+import { getProngCount } from './fs/get-prong-count.js';
+import { getChildren } from './fs/get-children.js';
+import { getAllOnLoop } from './fs/get-all-on-loop.js';
+import { getAllOnCircle } from './fs/get-all-on-circle.js';
+import { getMatCurveToNext } from './fs/get-mat-curve-to-next.js';
+import { getFirstExit } from './fs/get-first-exit.js';
+import { getRealProngCount } from './fs/get-real-prong-count.js';
+import { isFullyTerminating } from './fs/is-fully-terminating.js';
+import { isOnSameCircle } from './fs/is-on-same-circle.js';
+import { isOneProng } from './fs/is-one-prong.js';
+import { isSharp } from './fs/is-sharp.js';
+import { isTerminating } from './fs/is-terminating.js';
+import { getVertexForwardChildren } from './fs/get-vertex-forward-children.js';
+import { isTwoProng } from './fs/is-two-prong.js';
+import { getBranch } from './fs/get-branch.js';
+import { getBranchBeziers } from './fs/get-branch-beziers.js';
+import { getSalience } from './fs/get-salience.js';
+import { getMatCurveBetween } from './fs/get-mat-curve-between.js';
+import { getEdgeDirection } from './fs/get-edge-direction.js';
+import { getBoundaryBeziersBetween } from './fs/get-boundary-beziers-between.js';
+import { getMatCurvesBetween } from './fs/get-mat-curves-between.js';
+import { getInitialDegAngleBetweenMatCurves } from "./fs/get-angle-between-mat-curves.js";
+import { getAllVertices } from "./fs/get-all-vertices.js";
+const cpNodeComparator = (a, b) => compareCps(a.cp, b.cp);
+const CpNodeFs = {
+    /**
+     * Returns the children of this [[CpNode]] when seen as a MAT edge. Only
+     * children in a 'forward' direction are returned. These include all edges
+     * except the 'backward' edge given by [[prevOnCircle]], even terminating
+     * edges.
+     */
+    getChildren,
+    /**
+     * Similar to [[getChildren]] but returns the child nodes of the tree when
+     * [[CpNode]] is seen as a MAT vertex point (as opposed to edge). In this
+     * way the dual graph of the tree can easily be traversed - see e.g.
+     * [[traverseVertices]]. Generally, however, traversing the edges is
+     * preferred as it returns the entire Medial Axis (by utilizing
+     * [[getMatCurveToNext]] on each returned edge).
+     */
+    getVertexForwardChildren,
+    /**
+     * Returns all [[CpNode]]s on the MAT that this [[CpNode]] is part of
+     * starting from the current one and going anti-clockwise around the shape.
+     */
+    getAllOnLoop,
+    /**
+     * Return this (except if exclThis is truthy) and the the other CpNodes
+     * around the maximal disk vertex circle in an anti-clockwise order.
+     * @param exclThis If true the returned array does not include this
+     * [[CpNode]].
+     */
+    getAllOnCircle,
+    /**
+     * Returns true if the 2 given [[CpNode]]s are on the same maximal disk
+     * circle.
+     * @param cpNode1 A [[CpNode]].
+     * @param cpNode2 Another [[CpNode]]
+     */
+    isOnSameCircle,
+    /**
+     * Returns true if this [[CpNode]] is terminating, i.e. implies a leaf MAT
+     * vertex.
+     *
+     * This is always the case for sharp corners and maximal disks with
+     * a single contact point. Note, however, that even in these cases there are
+     * two contact points stored (sitting 'on top' of each other) for the
+     * maximal disk. It can be seen as a limiting case of a two-prong where the
+     * distance between two of the contact points tend to zero. One point
+     * (represented by a [[CpNode]] of course) will be terminating with the
+     * other point being its [[next]], whereas the other point will *not* be
+     * terminating and 'points' back into the shape.
+     */
+    isTerminating,
+    /**
+     * Like isTerminating() but only returns true if all cpNodes on the circle
+     * (except this.prevOnCircle) is terminating.
+     */
+    isFullyTerminating,
+    /**
+     * Returns the first [[CpNode]] (from this one by successively applying
+     * .nextOnCircle) that exits the circle.
+     */
+    getFirstExit,
+    /**
+     * Returns true if this [[CpNode]] represents a sharp corner, i.e. the
+     * limiting case of a two-prong having zero radius.
+     *
+     * Note that two [[CpNode]]s are stored for each sharp corner, one being
+     * terminating and one not. See [[isTerminating]] for more details.
+     */
+    isSharp,
+    /**
+     * Returns true if this [[CpNode]]'s maximal disk has only one contact point
+     * on the shape boundary (up to planar coordinates). These includes sharp
+     * corners.
+     *
+     * Note, however, that two [[CpNode]]s are stored for each such point to
+     * preserve symmetry - see [[isTerminating]] for more details.
+     */
+    isOneProng,
+    /**
+     * Returns the number of contact points on the maximal disk circle implied
+     * by this [[CpNode]].
+     *
+     * Note, however, that even one-prongs and sharp corners will return 2 (see
+     * [[isTerminating]] for more details); if this is not desired use
+     * [[getRealProngCount]] instead which will return 1 in these cases.
+     */
+    getProngCount,
+    /**
+     * Returns the number of contact points (up to planar coordinates) on the
+     * maximal disk circle implied by this [[CpNode]].
+     *
+     * See also [[getProngCount]].
+     */
+    getRealProngCount,
+    /**
+     * Primarily for internal use.
+     *
+     * Compares the order of two [[CpNode]]s. The order is cyclic and depends
+     * on a [[CpNode]]'s relative position along the shape boundary.
+     */
+    cpNodeComparator,
+    /**
+     * For debugging
+     * @param cpNode
+     */
+    enhanceCpNode,
+    /**
+     * @internal
+     *
+     * Traverses the shape from the given `CpNode` going around the shortest path
+     * so that only a piece of the shape is traversed and returns the visited
+     * `CpNode`s (starting from the given `CpNode`).
+     *
+     * @param cpStart The `CpNode` from where to start the traversal.
+     */
+    traverseCp,
+    /**
+     * Traverses all edges (depth first) of the given MAT tree starting at the given
+     * vertex (represented by a [[CpNode]]).
+     * @param cpNode Any [[CpNode]] representing the start vertex.
+     * @param traverseEdgesCallback A callback function for each CpNode representing the vertex at the
+     * start of an edge.
+     */
+    traverseEdges,
+    /**
+     * Traverses the MAT tree and calls the given callback function for each vertex
+     * (represented by a [[CpNode]]) on the MAT.
+     *
+     * It is usually preferable to use [[traverseEdges]] as it allows for the
+     * traversal of all the smooth curves representing the MAT.
+     * @param cpNode Any [[CpNode]] representing the start vertex.
+     * @param traverseVerticesCallback A callback function taking a single [[CpNode]] as parameter.
+     */
+    traverseVertices,
+    /**
+     * Returns a deep clone of this [[CpNode]]. Can be used to copy the MAT
+     * since cloning a single [[CpNode]] necessarily implies cloning all
+     * [[CpNode]]s on the same MAT tree.
+     */
+    clone,
+    /**
+     * Returns the ordered bezier curves from this CpNode to the next CpNode
+     * on the boundary.
+     * @param cpNode
+     */
+    getBoundaryBezierPartsToNext,
+    /**
+     * Returns the ordered bezier curves from this CpNode to the next CpNode
+     * on the boundary.
+     * @param cpNode
+     */
+    getBoundaryBeziersToNext,
+    /**
+     * Removes a cpNode from the MAT.
+     * @param cpTree The tree graph holding the [[CpNodes]] of the MAT.
+     * @param cpNode The [[CpNode]] to remove.
+     */
+    removeVertex,
+    /**
+     * Returns the bezier curve from the maximal disk of the given [[CpNode]] to the
+     * next [[CpNode]]'s maximal disk and thus directly represents a piece of the
+     * medial axis.
+     * @param cpNode
+     */
+    getMatCurveToNext,
+    isTwoProng,
+    getBranch,
+    getBranchBeziers,
+    getSalience,
+    /**
+     * Returns the bezier curve from the maximal disk of one [[CpNode]] to another
+     * [[CpNode]]'s maximal disk.
+     * @param cpNodeFrom
+     * @param cpNodeTo
+     */
+    getMatCurveBetween,
+    /**
+     * @internal
+     * Returns a line segment of unit length starting in the given Vertex center and
+     * pointing in the direction of the medial axis (viewed as a rooted tree).
+     * @param cpNode
+     */
+    getEdgeDirection,
+    getBoundaryBeziersBetween,
+    getMatCurvesBetween,
+    getHoleClosers,
+    getSpeed,
+    getSmoothedSpeed$,
+    getInitialDegAngleBetweenMatCurves,
+    getAllVertices
+};
+export { CpNodeFs };
+//# sourceMappingURL=cp-node-fs.js.map

package/node/cp-node/cp-node-fs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cp-node-fs.js","sourceRoot":"","sources":["../../src/cp-node/cp-node-fs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAE/D,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG1D,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAG1E,MAAM,QAAQ,GAAG;IAChB;;;;;OAKG;IACH,WAAW;IACX;;;;;;;OAOG;IACH,wBAAwB;IACxB;;;OAGG;IACH,YAAY;IACZ;;;;;OAKG;IACH,cAAc;IACd;;;;;OAKG;IACH,cAAc;IACd;;;;;;;;;;;;OAYG;IACH,aAAa;IACb;;;OAGG;IACH,kBAAkB;IAClB;;;OAGG;IACH,YAAY;IACZ;;;;;;OAMG;IACH,OAAO;IACP;;;;;;;OAOG;IACH,UAAU;IACV;;;;;;;OAOG;IACH,aAAa;IACb;;;;;OAKG;IACH,iBAAiB;IACjB;;;;;OAKG;IACH,gBAAgB;IACb;;;OAGG;IACH,aAAa;IACb;;;;;;;;OAQG;IACH,UAAU;IACV;;;;;;OAMG;IACH,aAAa;IACb;;;;;;;;OAQG;IACH,gBAAgB;IAChB;;;;OAIG;IACH,KAAK;IACL;;;;OAIG;IACH,4BAA4B;IAC5B;;;;OAIG;IACH,wBAAwB;IACxB;;;;OAIG;IACH,YAAY;IACf;;;;;OAKG;IACH,iBAAiB;IACjB,UAAU;IACV,SAAS;IACT,gBAAgB;IAChB,WAAW;IACX;;;;;OAKG;IACH,kBAAkB;IAClB;;;;;OAKG;IACH,gBAAgB;IAChB,yBAAyB;IACzB,mBAAmB;IACnB,cAAc;IACd,QAAQ;IACR,iBAAiB;IACjB,kCAAkC;IAClC,cAAc;CACd,CAAA;AAGD,OAAO,EAAE,QAAQ,EAAE,CAAA"}