@turf/line-intersect 6.5.0 → 7.0.0-alpha.0

package/README.md

@@ -6,12 +6,12 @@
 
 Takes any LineString or Polygon GeoJSON and returns the intersecting point(s).
 
-**Parameters**
+### Parameters
 
--   `line1` **([Geometry][1] \| [FeatureCollection][2] \| [Feature][3]<([LineString][4] \| [MultiLineString][5] \| [Polygon][6] \| [MultiPolygon][7])>)** any LineString or Polygon
--   `line2` **([Geometry][1] \| [FeatureCollection][2] \| [Feature][3]<([LineString][4] \| [MultiLineString][5] \| [Polygon][6] \| [MultiPolygon][7])>)** any LineString or Polygon
+*   `line1` **[GeoJSON][1]** any LineString or Polygon
+*   `line2` **[GeoJSON][1]** any LineString or Polygon
 
-**Examples**
+### Examples
 
 ```javascript
 var line1 = turf.lineString([[126, -11], [129, -21]]);
@@ -22,23 +22,13 @@ var intersects = turf.lineIntersect(line1, line2);
 var addToMap = [line1, line2, intersects]
 ```
 
-Returns **[FeatureCollection][2]<[Point][8]>** point(s) that intersect both
+Returns **[FeatureCollection][2]<[Point][3]>** point(s) that intersect both
 
-[1]: https://tools.ietf.org/html/rfc7946#section-3.1
+[1]: https://tools.ietf.org/html/rfc7946#section-3
 
 [2]: https://tools.ietf.org/html/rfc7946#section-3.3
 
-[3]: https://tools.ietf.org/html/rfc7946#section-3.2
-
-[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4
-
-[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5
-
-[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6
-
-[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7
-
-[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+[3]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
 <!-- This file is automatically generated. Please don't edit it directly:
 if you find an error, edit the source file (likely index.js), and re-run

package/dist/es/index.js

@@ -1,14 +1,14 @@
-import { feature, featureCollection, point, } from "@turf/helpers";
-import { getCoords } from "@turf/invariant";
-import lineSegment from "@turf/line-segment";
-import { featureEach } from "@turf/meta";
-import rbush from "geojson-rbush";
+import { feature, featureCollection, point } from "@turf/helpers";
+import findIntersections from "sweepline-intersections";
 /**
  * Takes any LineString or Polygon GeoJSON and returns the intersecting point(s).
  *
  * @name lineIntersect
  * @param {GeoJSON} line1 any LineString or Polygon
  * @param {GeoJSON} line2 any LineString or Polygon
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.removeDuplicates=true] remove duplicate intersections
+ * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features
  * @returns {FeatureCollection<Point>} point(s) that intersect both
  * @example
  * var line1 = turf.lineString([[126, -11], [129, -21]]);
@@ -18,90 +18,44 @@ import rbush from "geojson-rbush";
  * //addToMap
  * var addToMap = [line1, line2, intersects]
  */
-function lineIntersect(line1, line2) {
-    var unique = {};
-    var results = [];
-    // First, normalize geometries to features
-    // Then, handle simple 2-vertex segments
-    if (line1.type === "LineString") {
-        line1 = feature(line1);
+function lineIntersect(line1, line2, options = {}) {
+    const { removeDuplicates = true, ignoreSelfIntersections = false } = options;
+    let features = [];
+    if (line1.type === "FeatureCollection")
+        features = features.concat(line1.features);
+    else if (line1.type === "Feature")
+        features.push(line1);
+    else if (line1.type === "LineString" ||
+        line1.type === "Polygon" ||
+        line1.type === "MultiLineString" ||
+        line1.type === "MultiPolygon") {
+        features.push(feature(line1));
     }
-    if (line2.type === "LineString") {
-        line2 = feature(line2);
+    if (line2.type === "FeatureCollection")
+        features = features.concat(line2.features);
+    else if (line2.type === "Feature")
+        features.push(line2);
+    else if (line2.type === "LineString" ||
+        line2.type === "Polygon" ||
+        line2.type === "MultiLineString" ||
+        line2.type === "MultiPolygon") {
+        features.push(feature(line2));
     }
-    if (line1.type === "Feature" &&
-        line2.type === "Feature" &&
-        line1.geometry !== null &&
-        line2.geometry !== null &&
-        line1.geometry.type === "LineString" &&
-        line2.geometry.type === "LineString" &&
-        line1.geometry.coordinates.length === 2 &&
-        line2.geometry.coordinates.length === 2) {
-        var intersect = intersects(line1, line2);
-        if (intersect) {
-            results.push(intersect);
-        }
-        return featureCollection(results);
-    }
-    // Handles complex GeoJSON Geometries
-    var tree = rbush();
-    tree.load(lineSegment(line2));
-    featureEach(lineSegment(line1), function (segment) {
-        featureEach(tree.search(segment), function (match) {
-            var intersect = intersects(segment, match);
-            if (intersect) {
-                // prevent duplicate points https://github.com/Turfjs/turf/issues/688
-                var key = getCoords(intersect).join(",");
-                if (!unique[key]) {
-                    unique[key] = true;
-                    results.push(intersect);
-                }
+    const intersections = findIntersections(featureCollection(features), ignoreSelfIntersections);
+    let results = [];
+    if (removeDuplicates) {
+        const unique = {};
+        intersections.forEach((intersection) => {
+            const key = intersection.join(",");
+            if (!unique[key]) {
+                unique[key] = true;
+                results.push(intersection);
             }
         });
-    });
-    return featureCollection(results);
-}
-/**
- * Find a point that intersects LineStrings with two coordinates each
- *
- * @private
- * @param {Feature<LineString>} line1 GeoJSON LineString (Must only contain 2 coordinates)
- * @param {Feature<LineString>} line2 GeoJSON LineString (Must only contain 2 coordinates)
- * @returns {Feature<Point>} intersecting GeoJSON Point
- */
-function intersects(line1, line2) {
-    var coords1 = getCoords(line1);
-    var coords2 = getCoords(line2);
-    if (coords1.length !== 2) {
-        throw new Error("<intersects> line1 must only contain 2 coordinates");
-    }
-    if (coords2.length !== 2) {
-        throw new Error("<intersects> line2 must only contain 2 coordinates");
-    }
-    var x1 = coords1[0][0];
-    var y1 = coords1[0][1];
-    var x2 = coords1[1][0];
-    var y2 = coords1[1][1];
-    var x3 = coords2[0][0];
-    var y3 = coords2[0][1];
-    var x4 = coords2[1][0];
-    var y4 = coords2[1][1];
-    var denom = (y4 - y3) * (x2 - x1) - (x4 - x3) * (y2 - y1);
-    var numeA = (x4 - x3) * (y1 - y3) - (y4 - y3) * (x1 - x3);
-    var numeB = (x2 - x1) * (y1 - y3) - (y2 - y1) * (x1 - x3);
-    if (denom === 0) {
-        if (numeA === 0 && numeB === 0) {
-            return null;
-        }
-        return null;
     }
-    var uA = numeA / denom;
-    var uB = numeB / denom;
-    if (uA >= 0 && uA <= 1 && uB >= 0 && uB <= 1) {
-        var x = x1 + uA * (x2 - x1);
-        var y = y1 + uA * (y2 - y1);
-        return point([x, y]);
+    else {
+        results = intersections;
     }
-    return null;
+    return featureCollection(results.map((r) => point(r)));
 }
 export default lineIntersect;

package/dist/js/index.d.ts

@@ -1,10 +1,13 @@
-import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Point, Polygon } from "@turf/helpers";
+import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Point, Polygon } from "geojson";
 /**
  * Takes any LineString or Polygon GeoJSON and returns the intersecting point(s).
  *
  * @name lineIntersect
  * @param {GeoJSON} line1 any LineString or Polygon
  * @param {GeoJSON} line2 any LineString or Polygon
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.removeDuplicates=true] remove duplicate intersections
+ * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features
  * @returns {FeatureCollection<Point>} point(s) that intersect both
  * @example
  * var line1 = turf.lineString([[126, -11], [129, -21]]);
@@ -14,5 +17,8 @@ import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon,
  * //addToMap
  * var addToMap = [line1, line2, intersects]
  */
-declare function lineIntersect<G1 extends LineString | MultiLineString | Polygon | MultiPolygon, G2 extends LineString | MultiLineString | Polygon | MultiPolygon>(line1: FeatureCollection<G1> | Feature<G1> | G1, line2: FeatureCollection<G2> | Feature<G2> | G2): FeatureCollection<Point>;
+declare function lineIntersect<G1 extends LineString | MultiLineString | Polygon | MultiPolygon, G2 extends LineString | MultiLineString | Polygon | MultiPolygon>(line1: FeatureCollection<G1> | Feature<G1> | G1, line2: FeatureCollection<G2> | Feature<G2> | G2, options?: {
+    removeDuplicates?: boolean;
+    ignoreSelfIntersections?: boolean;
+}): FeatureCollection<Point>;
 export default lineIntersect;

package/dist/js/index.js

@@ -1,19 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
-var line_segment_1 = __importDefault(require("@turf/line-segment"));
-var meta_1 = require("@turf/meta");
-var geojson_rbush_1 = __importDefault(require("geojson-rbush"));
+const tslib_1 = require("tslib");
+const helpers_1 = require("@turf/helpers");
+const sweepline_intersections_1 = tslib_1.__importDefault(require("sweepline-intersections"));
 /**
  * Takes any LineString or Polygon GeoJSON and returns the intersecting point(s).
  *
  * @name lineIntersect
  * @param {GeoJSON} line1 any LineString or Polygon
  * @param {GeoJSON} line2 any LineString or Polygon
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.removeDuplicates=true] remove duplicate intersections
+ * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features
  * @returns {FeatureCollection<Point>} point(s) that intersect both
  * @example
  * var line1 = turf.lineString([[126, -11], [129, -21]]);
@@ -23,90 +21,44 @@ var geojson_rbush_1 = __importDefault(require("geojson-rbush"));
  * //addToMap
  * var addToMap = [line1, line2, intersects]
  */
-function lineIntersect(line1, line2) {
-    var unique = {};
-    var results = [];
-    // First, normalize geometries to features
-    // Then, handle simple 2-vertex segments
-    if (line1.type === "LineString") {
-        line1 = helpers_1.feature(line1);
+function lineIntersect(line1, line2, options = {}) {
+    const { removeDuplicates = true, ignoreSelfIntersections = false } = options;
+    let features = [];
+    if (line1.type === "FeatureCollection")
+        features = features.concat(line1.features);
+    else if (line1.type === "Feature")
+        features.push(line1);
+    else if (line1.type === "LineString" ||
+        line1.type === "Polygon" ||
+        line1.type === "MultiLineString" ||
+        line1.type === "MultiPolygon") {
+        features.push(helpers_1.feature(line1));
     }
-    if (line2.type === "LineString") {
-        line2 = helpers_1.feature(line2);
+    if (line2.type === "FeatureCollection")
+        features = features.concat(line2.features);
+    else if (line2.type === "Feature")
+        features.push(line2);
+    else if (line2.type === "LineString" ||
+        line2.type === "Polygon" ||
+        line2.type === "MultiLineString" ||
+        line2.type === "MultiPolygon") {
+        features.push(helpers_1.feature(line2));
     }
-    if (line1.type === "Feature" &&
-        line2.type === "Feature" &&
-        line1.geometry !== null &&
-        line2.geometry !== null &&
-        line1.geometry.type === "LineString" &&
-        line2.geometry.type === "LineString" &&
-        line1.geometry.coordinates.length === 2 &&
-        line2.geometry.coordinates.length === 2) {
-        var intersect = intersects(line1, line2);
-        if (intersect) {
-            results.push(intersect);
-        }
-        return helpers_1.featureCollection(results);
-    }
-    // Handles complex GeoJSON Geometries
-    var tree = geojson_rbush_1.default();
-    tree.load(line_segment_1.default(line2));
-    meta_1.featureEach(line_segment_1.default(line1), function (segment) {
-        meta_1.featureEach(tree.search(segment), function (match) {
-            var intersect = intersects(segment, match);
-            if (intersect) {
-                // prevent duplicate points https://github.com/Turfjs/turf/issues/688
-                var key = invariant_1.getCoords(intersect).join(",");
-                if (!unique[key]) {
-                    unique[key] = true;
-                    results.push(intersect);
-                }
+    const intersections = sweepline_intersections_1.default(helpers_1.featureCollection(features), ignoreSelfIntersections);
+    let results = [];
+    if (removeDuplicates) {
+        const unique = {};
+        intersections.forEach((intersection) => {
+            const key = intersection.join(",");
+            if (!unique[key]) {
+                unique[key] = true;
+                results.push(intersection);
             }
         });
-    });
-    return helpers_1.featureCollection(results);
-}
-/**
- * Find a point that intersects LineStrings with two coordinates each
- *
- * @private
- * @param {Feature<LineString>} line1 GeoJSON LineString (Must only contain 2 coordinates)
- * @param {Feature<LineString>} line2 GeoJSON LineString (Must only contain 2 coordinates)
- * @returns {Feature<Point>} intersecting GeoJSON Point
- */
-function intersects(line1, line2) {
-    var coords1 = invariant_1.getCoords(line1);
-    var coords2 = invariant_1.getCoords(line2);
-    if (coords1.length !== 2) {
-        throw new Error("<intersects> line1 must only contain 2 coordinates");
-    }
-    if (coords2.length !== 2) {
-        throw new Error("<intersects> line2 must only contain 2 coordinates");
-    }
-    var x1 = coords1[0][0];
-    var y1 = coords1[0][1];
-    var x2 = coords1[1][0];
-    var y2 = coords1[1][1];
-    var x3 = coords2[0][0];
-    var y3 = coords2[0][1];
-    var x4 = coords2[1][0];
-    var y4 = coords2[1][1];
-    var denom = (y4 - y3) * (x2 - x1) - (x4 - x3) * (y2 - y1);
-    var numeA = (x4 - x3) * (y1 - y3) - (y4 - y3) * (x1 - x3);
-    var numeB = (x2 - x1) * (y1 - y3) - (y2 - y1) * (x1 - x3);
-    if (denom === 0) {
-        if (numeA === 0 && numeB === 0) {
-            return null;
-        }
-        return null;
     }
-    var uA = numeA / denom;
-    var uB = numeB / denom;
-    if (uA >= 0 && uA <= 1 && uB >= 0 && uB <= 1) {
-        var x = x1 + uA * (x2 - x1);
-        var y = y1 + uA * (y2 - y1);
-        return helpers_1.point([x, y]);
+    else {
+        results = intersections;
     }
-    return null;
+    return helpers_1.featureCollection(results.map((r) => helpers_1.point(r)));
 }
 exports.default = lineIntersect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/line-intersect",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf line-intersect module",
   "author": "Turf Authors",
   "contributors": [
@@ -51,7 +51,7 @@
     "test:tape": "ts-node -r esm test.js"
   },
   "devDependencies": {
-    "@turf/truncate": "^6.5.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "@types/tape": "*",
     "benchmark": "*",
     "load-json-file": "*",
@@ -63,11 +63,9 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "@turf/line-segment": "^6.5.0",
-    "@turf/meta": "^6.5.0",
-    "geojson-rbush": "3.x"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "sweepline-intersections": "^1.4.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }