@tscircuit/math-utils 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tscircuit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# @tscircuit/math-utils
+
+This repository contains a collection of TypeScript utility functions for geometric calculations, primarily focused on line intersection and distance calculations.
+
+## Features
+
+- Line intersection detection
+- Segment intersection detection
+- Point-to-segment distance calculation
+- Orientation of points
+- Distance between points
+
+## Installation
+
+```bash
+bun add @tscircuit/math-utils
+```
+
+## Usage
+
+Import the functions you need in your TypeScript project:
+
+```typescript
+import {
+  doesLineIntersectLine,
+  doSegmentsIntersect,
+  pointToSegmentDistance,
+} from "./src/index"
+
+// Example usage
+const point1 = { x: 0, y: 0 }
+const point2 = { x: 5, y: 5 }
+const point3 = { x: 0, y: 5 }
+const point4 = { x: 5, y: 0 }
+
+const intersects = doesLineIntersectLine([point1, point2], [point3, point4])
+console.log("Lines intersect:", intersects)
+```
+
+## API Reference
+
+### `doesLineIntersectLine(line1: [Point, Point], line2: [Point, Point], options?: { lineThickness?: number }): boolean`
+
+Determines if two lines intersect, optionally considering line thickness.
+
+### `doSegmentsIntersect(p1: Point, q1: Point, p2: Point, q2: Point): boolean`
+
+Checks if two line segments intersect.
+
+### `orientation(p: Point, q: Point, r: Point): number`
+
+Calculates the orientation of three points.
+
+### `onSegment(p: Point, q: Point, r: Point): boolean`
+
+Checks if point q lies on the segment p-r.
+
+### `pointToSegmentDistance(p: Point, v: Point, w: Point): number`
+
+Calculates the minimum distance between a point and a line segment.
+
+### `distance(p1: Point, p2: Point): number`
+
+Calculates the Euclidean distance between two points.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+type Point = {
+    x: number;
+    y: number;
+};
+/**
+ * Returns true if the two lines intersect.
+ */
+declare function doesLineIntersectLine([a1, a2]: [Point, Point], [b1, b2]: [Point, Point], { lineThickness, }?: {
+    lineThickness?: number;
+}): boolean;
+/**
+ * Returns true if the two segments intersect.
+ */
+declare function doSegmentsIntersect(p1: Point, q1: Point, p2: Point, q2: Point): boolean;
+/**
+ * Returns 0 if the points are colinear, 1 if they are clockwise, and 2 if they are counterclockwise.
+ */
+declare function orientation(p: Point, q: Point, r: Point): number;
+/**
+ * Returns true if q is on the segment p->r.
+ */
+declare function onSegment(p: Point, q: Point, r: Point): boolean;
+/**
+ * Returns the minimum distance between a point and a segment.
+ */
+declare function pointToSegmentDistance(p: Point, v: Point, w: Point): number;
+/**
+ * Returns the distance between two points.
+ */
+declare function distance(p1: Point, p2: Point): number;
+
+export { type Point, distance, doSegmentsIntersect, doesLineIntersectLine, onSegment, orientation, pointToSegmentDistance };

package/dist/index.js

@@ -0,0 +1,75 @@
+// src/index.ts
+function doesLineIntersectLine([a1, a2], [b1, b2], {
+  lineThickness = 0
+} = {}) {
+  if (lineThickness === 0) {
+    return doSegmentsIntersect(a1, a2, b1, b2);
+  }
+  const minDist = segmentsDistance(a1, a2, b1, b2);
+  return minDist <= lineThickness;
+}
+function doSegmentsIntersect(p1, q1, p2, q2) {
+  const o1 = orientation(p1, q1, p2);
+  const o2 = orientation(p1, q1, q2);
+  const o3 = orientation(p2, q2, p1);
+  const o4 = orientation(p2, q2, q1);
+  if (o1 !== o2 && o3 !== o4) {
+    return true;
+  }
+  if (o1 === 0 && onSegment(p1, p2, q1)) return true;
+  if (o2 === 0 && onSegment(p1, q2, q1)) return true;
+  if (o3 === 0 && onSegment(p2, p1, q2)) return true;
+  if (o4 === 0 && onSegment(p2, q1, q2)) return true;
+  return false;
+}
+function orientation(p, q, r) {
+  const val = (q.y - p.y) * (r.x - q.x) - (q.x - p.x) * (r.y - q.y);
+  if (val === 0) return 0;
+  return val > 0 ? 1 : 2;
+}
+function onSegment(p, q, r) {
+  return q.x <= Math.max(p.x, r.x) && q.x >= Math.min(p.x, r.x) && q.y <= Math.max(p.y, r.y) && q.y >= Math.min(p.y, r.y);
+}
+function segmentsDistance(a1, a2, b1, b2) {
+  if (a1.x === a2.x && a1.y === a2.y) {
+    return pointToSegmentDistance(a1, b1, b2);
+  }
+  if (b1.x === b2.x && b1.y === b2.y) {
+    return pointToSegmentDistance(b1, a1, a2);
+  }
+  if (doSegmentsIntersect(a1, a2, b1, b2)) {
+    return 0;
+  }
+  const distances = [
+    pointToSegmentDistance(a1, b1, b2),
+    pointToSegmentDistance(a2, b1, b2),
+    pointToSegmentDistance(b1, a1, a2),
+    pointToSegmentDistance(b2, a1, a2)
+  ];
+  return Math.min(...distances);
+}
+function pointToSegmentDistance(p, v, w) {
+  const l2 = (w.x - v.x) ** 2 + (w.y - v.y) ** 2;
+  if (l2 === 0) return distance(p, v);
+  let t = ((p.x - v.x) * (w.x - v.x) + (p.y - v.y) * (w.y - v.y)) / l2;
+  t = Math.max(0, Math.min(1, t));
+  const projection = {
+    x: v.x + t * (w.x - v.x),
+    y: v.y + t * (w.y - v.y)
+  };
+  return distance(p, projection);
+}
+function distance(p1, p2) {
+  const dx = p1.x - p2.x;
+  const dy = p1.y - p2.y;
+  return Math.sqrt(dx * dx + dy * dy);
+}
+export {
+  distance,
+  doSegmentsIntersect,
+  doesLineIntersectLine,
+  onSegment,
+  orientation,
+  pointToSegmentDistance
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type Point = {\n\tx: number;\n\ty: number;\n};\n\n/**\n * Returns true if the two lines intersect.\n */\nexport function doesLineIntersectLine(\n\t[a1, a2]: [Point, Point],\n\t[b1, b2]: [Point, Point],\n\t{\n\t\tlineThickness = 0,\n\t}: {\n\t\tlineThickness?: number;\n\t} = {},\n): boolean {\n\tif (lineThickness === 0) {\n\t\treturn doSegmentsIntersect(a1, a2, b1, b2);\n\t}\n\tconst minDist = segmentsDistance(a1, a2, b1, b2);\n\treturn minDist <= lineThickness;\n}\n\n/**\n * Returns true if the two segments intersect.\n */\nexport function doSegmentsIntersect(\n\tp1: Point,\n\tq1: Point,\n\tp2: Point,\n\tq2: Point,\n): boolean {\n\tconst o1 = orientation(p1, q1, p2);\n\tconst o2 = orientation(p1, q1, q2);\n\tconst o3 = orientation(p2, q2, p1);\n\tconst o4 = orientation(p2, q2, q1);\n\n\t// General case\n\tif (o1 !== o2 && o3 !== o4) {\n\t\treturn true;\n\t}\n\n\t// Special Cases\n\tif (o1 === 0 && onSegment(p1, p2, q1)) return true;\n\tif (o2 === 0 && onSegment(p1, q2, q1)) return true;\n\tif (o3 === 0 && onSegment(p2, p1, q2)) return true;\n\tif (o4 === 0 && onSegment(p2, q1, q2)) return true;\n\n\treturn false;\n}\n\n/**\n * Returns 0 if the points are colinear, 1 if they are clockwise, and 2 if they are counterclockwise.\n */\nexport function orientation(p: Point, q: Point, r: Point): number {\n\tconst val = (q.y - p.y) * (r.x - q.x) - (q.x - p.x) * (r.y - q.y);\n\tif (val === 0) return 0; // colinear\n\treturn val > 0 ? 1 : 2; // clock or counterclock wise\n}\n\n/**\n * Returns true if q is on the segment p->r.\n */\nexport function onSegment(p: Point, q: Point, r: Point): boolean {\n\treturn (\n\t\tq.x <= Math.max(p.x, r.x) &&\n\t\tq.x >= Math.min(p.x, r.x) &&\n\t\tq.y <= Math.max(p.y, r.y) &&\n\t\tq.y >= Math.min(p.y, r.y)\n\t);\n}\n\n/**\n * Returns the minimum distance between two segments.\n */\nfunction segmentsDistance(a1: Point, a2: Point, b1: Point, b2: Point): number {\n\t// Handle degenerate cases: segments of zero length\n\tif (a1.x === a2.x && a1.y === a2.y) {\n\t\treturn pointToSegmentDistance(a1, b1, b2);\n\t}\n\tif (b1.x === b2.x && b1.y === b2.y) {\n\t\treturn pointToSegmentDistance(b1, a1, a2);\n\t}\n\n\t// Check if segments intersect\n\tif (doSegmentsIntersect(a1, a2, b1, b2)) {\n\t\treturn 0;\n\t}\n\n\t// Compute the minimum distance between the segments\n\tconst distances = [\n\t\tpointToSegmentDistance(a1, b1, b2),\n\t\tpointToSegmentDistance(a2, b1, b2),\n\t\tpointToSegmentDistance(b1, a1, a2),\n\t\tpointToSegmentDistance(b2, a1, a2),\n\t];\n\n\treturn Math.min(...distances);\n}\n\n/**\n * Returns the minimum distance between a point and a segment.\n */\nexport function pointToSegmentDistance(p: Point, v: Point, w: Point): number {\n\tconst l2 = (w.x - v.x) ** 2 + (w.y - v.y) ** 2;\n\tif (l2 === 0) return distance(p, v);\n\n\tlet t = ((p.x - v.x) * (w.x - v.x) + (p.y - v.y) * (w.y - v.y)) / l2;\n\tt = Math.max(0, Math.min(1, t));\n\n\tconst projection = {\n\t\tx: v.x + t * (w.x - v.x),\n\t\ty: v.y + t * (w.y - v.y),\n\t};\n\n\treturn distance(p, projection);\n}\n\n/**\n * Returns the distance between two points.\n */\nexport function distance(p1: Point, p2: Point): number {\n\tconst dx = p1.x - p2.x;\n\tconst dy = p1.y - p2.y;\n\treturn Math.sqrt(dx * dx + dy * dy);\n}\n"],"mappings":";AAQO,SAAS,sBACf,CAAC,IAAI,EAAE,GACP,CAAC,IAAI,EAAE,GACP;AAAA,EACC,gBAAgB;AACjB,IAEI,CAAC,GACK;AACV,MAAI,kBAAkB,GAAG;AACxB,WAAO,oBAAoB,IAAI,IAAI,IAAI,EAAE;AAAA,EAC1C;AACA,QAAM,UAAU,iBAAiB,IAAI,IAAI,IAAI,EAAE;AAC/C,SAAO,WAAW;AACnB;AAKO,SAAS,oBACf,IACA,IACA,IACA,IACU;AACV,QAAM,KAAK,YAAY,IAAI,IAAI,EAAE;AACjC,QAAM,KAAK,YAAY,IAAI,IAAI,EAAE;AACjC,QAAM,KAAK,YAAY,IAAI,IAAI,EAAE;AACjC,QAAM,KAAK,YAAY,IAAI,IAAI,EAAE;AAGjC,MAAI,OAAO,MAAM,OAAO,IAAI;AAC3B,WAAO;AAAA,EACR;AAGA,MAAI,OAAO,KAAK,UAAU,IAAI,IAAI,EAAE,EAAG,QAAO;AAC9C,MAAI,OAAO,KAAK,UAAU,IAAI,IAAI,EAAE,EAAG,QAAO;AAC9C,MAAI,OAAO,KAAK,UAAU,IAAI,IAAI,EAAE,EAAG,QAAO;AAC9C,MAAI,OAAO,KAAK,UAAU,IAAI,IAAI,EAAE,EAAG,QAAO;AAE9C,SAAO;AACR;AAKO,SAAS,YAAY,GAAU,GAAU,GAAkB;AACjE,QAAM,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;AAC/D,MAAI,QAAQ,EAAG,QAAO;AACtB,SAAO,MAAM,IAAI,IAAI;AACtB;AAKO,SAAS,UAAU,GAAU,GAAU,GAAmB;AAChE,SACC,EAAE,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAAC,KACxB,EAAE,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAAC,KACxB,EAAE,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAAC,KACxB,EAAE,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAAC;AAE1B;AAKA,SAAS,iBAAiB,IAAW,IAAW,IAAW,IAAmB;AAE7E,MAAI,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG;AACnC,WAAO,uBAAuB,IAAI,IAAI,EAAE;AAAA,EACzC;AACA,MAAI,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,GAAG;AACnC,WAAO,uBAAuB,IAAI,IAAI,EAAE;AAAA,EACzC;AAGA,MAAI,oBAAoB,IAAI,IAAI,IAAI,EAAE,GAAG;AACxC,WAAO;AAAA,EACR;AAGA,QAAM,YAAY;AAAA,IACjB,uBAAuB,IAAI,IAAI,EAAE;AAAA,IACjC,uBAAuB,IAAI,IAAI,EAAE;AAAA,IACjC,uBAAuB,IAAI,IAAI,EAAE;AAAA,IACjC,uBAAuB,IAAI,IAAI,EAAE;AAAA,EAClC;AAEA,SAAO,KAAK,IAAI,GAAG,SAAS;AAC7B;AAKO,SAAS,uBAAuB,GAAU,GAAU,GAAkB;AAC5E,QAAM,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,EAAE,IAAI,EAAE,MAAM;AAC7C,MAAI,OAAO,EAAG,QAAO,SAAS,GAAG,CAAC;AAElC,MAAI,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;AAClE,MAAI,KAAK,IAAI,GAAG,KAAK,IAAI,GAAG,CAAC,CAAC;AAE9B,QAAM,aAAa;AAAA,IAClB,GAAG,EAAE,IAAI,KAAK,EAAE,IAAI,EAAE;AAAA,IACtB,GAAG,EAAE,IAAI,KAAK,EAAE,IAAI,EAAE;AAAA,EACvB;AAEA,SAAO,SAAS,GAAG,UAAU;AAC9B;AAKO,SAAS,SAAS,IAAW,IAAmB;AACtD,QAAM,KAAK,GAAG,IAAI,GAAG;AACrB,QAAM,KAAK,GAAG,IAAI,GAAG;AACrB,SAAO,KAAK,KAAK,KAAK,KAAK,KAAK,EAAE;AACnC;","names":[]}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@tscircuit/math-utils",
+  "main": "dist/index.js",
+  "version": "0.0.1",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup-node src/index.ts --format esm --dts --sourcemap"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "tsup": "^8.2.4"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}