@turf/kinks 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -4,53 +4,46 @@
 
 ## kinks
 
-Takes a [linestring][1], [multi-linestring][2], [multi-polygon][3], or [polygon][4] and returns [points][5] at all self-intersections.
+Takes a [linestring][1], [multi-linestring][2],
+[multi-polygon][3] or [polygon][4] and
+returns [points][5] at all self-intersections.
 
-**Parameters**
+### Parameters
 
--   `featureIn` **[Feature][6]<([LineString][7] \| [MultiLineString][8] \| [MultiPolygon][9] \| [Polygon][10])>** input feature
+- `featureIn` **[Feature][6]<([LineString][7] | [MultiLineString][8] | [MultiPolygon][9] | [Polygon][10])>** input feature
 
-**Examples**
+### Examples
 
 ```javascript
-var poly = turf.polygon([[
-  [-12.034835, 8.901183],
-  [-12.060413, 8.899826],
-  [-12.03638, 8.873199],
-  [-12.059383, 8.871418],
-  [-12.034835, 8.901183]
-]]);
+var poly = turf.polygon([
+  [
+    [-12.034835, 8.901183],
+    [-12.060413, 8.899826],
+    [-12.03638, 8.873199],
+    [-12.059383, 8.871418],
+    [-12.034835, 8.901183],
+  ],
+]);
 
 var kinks = turf.kinks(poly);
 
 //addToMap
-var addToMap = [poly, kinks]
+var addToMap = [poly, kinks];
 ```
 
-Returns **[FeatureCollection][11]&lt;[Point][12]>** self-intersections
+Returns **[FeatureCollection][11]<[Point][12]>** self-intersections
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
-
 [2]: https://tools.ietf.org/html/rfc7946#section-3.1.5
-
 [3]: https://tools.ietf.org/html/rfc7946#section-3.1.7
-
 [4]: https://tools.ietf.org/html/rfc7946#section-3.1.6
-
 [5]: https://tools.ietf.org/html/rfc7946#section-3.1.2
-
 [6]: https://tools.ietf.org/html/rfc7946#section-3.2
-
 [7]: https://tools.ietf.org/html/rfc7946#section-3.1.4
-
 [8]: https://tools.ietf.org/html/rfc7946#section-3.1.5
-
 [9]: https://tools.ietf.org/html/rfc7946#section-3.1.7
-
 [10]: https://tools.ietf.org/html/rfc7946#section-3.1.6
-
 [11]: https://tools.ietf.org/html/rfc7946#section-3.3
-
 [12]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
 <!-- This file is automatically generated. Please don't edit it directly:

package/dist/es/index.js

@@ -1,3 +1,4 @@
+import findIntersections from "sweepline-intersections";
 import { point } from "@turf/helpers";
 /**
  * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
@@ -22,115 +23,20 @@ import { point } from "@turf/helpers";
  * var addToMap = [poly, kinks]
  */
 export default function kinks(featureIn) {
-    var coordinates;
-    var feature;
-    var results = {
+    const results = {
         type: "FeatureCollection",
         features: [],
     };
-    if (featureIn.type === "Feature") {
-        feature = featureIn.geometry;
-    }
-    else {
-        feature = featureIn;
-    }
-    if (feature.type === "LineString") {
-        coordinates = [feature.coordinates];
-    }
-    else if (feature.type === "MultiLineString") {
-        coordinates = feature.coordinates;
-    }
-    else if (feature.type === "MultiPolygon") {
-        coordinates = [].concat.apply([], feature.coordinates);
-    }
-    else if (feature.type === "Polygon") {
-        coordinates = feature.coordinates;
-    }
-    else {
+    if (featureIn.type === "Feature" &&
+        (featureIn.geometry.type === "Point" ||
+            featureIn.geometry.type === "MultiPoint")) {
         throw new Error("Input must be a LineString, MultiLineString, " +
             "Polygon, or MultiPolygon Feature or Geometry");
     }
-    coordinates.forEach(function (line1) {
-        coordinates.forEach(function (line2) {
-            for (var i = 0; i < line1.length - 1; i++) {
-                // start iteration at i, intersections for k < i have already
-                // been checked in previous outer loop iterations
-                for (var k = i; k < line2.length - 1; k++) {
-                    if (line1 === line2) {
-                        // segments are adjacent and always share a vertex, not a kink
-                        if (Math.abs(i - k) === 1) {
-                            continue;
-                        }
-                        // first and last segment in a closed lineString or ring always share a vertex, not a kink
-                        if (
-                        // segments are first and last segment of lineString
-                        i === 0 &&
-                            k === line1.length - 2 &&
-                            // lineString is closed
-                            line1[i][0] === line1[line1.length - 1][0] &&
-                            line1[i][1] === line1[line1.length - 1][1]) {
-                            continue;
-                        }
-                    }
-                    var intersection = lineIntersects(line1[i][0], line1[i][1], line1[i + 1][0], line1[i + 1][1], line2[k][0], line2[k][1], line2[k + 1][0], line2[k + 1][1]);
-                    if (intersection) {
-                        results.features.push(point([intersection[0], intersection[1]]));
-                    }
-                }
-            }
-        });
-    });
-    return results;
-}
-// modified from http://jsfiddle.net/justin_c_rounds/Gd2S2/light/
-function lineIntersects(line1StartX, line1StartY, line1EndX, line1EndY, line2StartX, line2StartY, line2EndX, line2EndY) {
-    // if the lines intersect, the result contains the x and y of the
-    // intersection (treating the lines as infinite) and booleans for whether
-    // line segment 1 or line segment 2 contain the point
-    var denominator;
-    var a;
-    var b;
-    var numerator1;
-    var numerator2;
-    var result = {
-        x: null,
-        y: null,
-        onLine1: false,
-        onLine2: false,
-    };
-    denominator =
-        (line2EndY - line2StartY) * (line1EndX - line1StartX) -
-            (line2EndX - line2StartX) * (line1EndY - line1StartY);
-    if (denominator === 0) {
-        if (result.x !== null && result.y !== null) {
-            return result;
-        }
-        else {
-            return false;
-        }
-    }
-    a = line1StartY - line2StartY;
-    b = line1StartX - line2StartX;
-    numerator1 = (line2EndX - line2StartX) * a - (line2EndY - line2StartY) * b;
-    numerator2 = (line1EndX - line1StartX) * a - (line1EndY - line1StartY) * b;
-    a = numerator1 / denominator;
-    b = numerator2 / denominator;
-    // if we cast these lines infinitely in both directions, they intersect here:
-    result.x = line1StartX + a * (line1EndX - line1StartX);
-    result.y = line1StartY + a * (line1EndY - line1StartY);
-    // if line1 is a segment and line2 is infinite, they intersect if:
-    if (a >= 0 && a <= 1) {
-        result.onLine1 = true;
-    }
-    // if line2 is a segment and line1 is infinite, they intersect if:
-    if (b >= 0 && b <= 1) {
-        result.onLine2 = true;
-    }
-    // if line1 and line2 are segments, they intersect if both of the above are true
-    if (result.onLine1 && result.onLine2) {
-        return [result.x, result.y];
-    }
-    else {
-        return false;
+    const intersections = findIntersections(featureIn, false);
+    for (let i = 0; i < intersections.length; ++i) {
+        const intersection = intersections[i];
+        results.features.push(point([intersection[0], intersection[1]]));
     }
+    return results;
 }

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Point, Polygon } from "@turf/helpers";
+import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Point, Polygon } from "geojson";
 /**
  * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
  * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
@@ -21,4 +21,4 @@ import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon,
  * //addToMap
  * var addToMap = [poly, kinks]
  */
-export default function kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(featureIn: Feature<T> | T): FeatureCollection<Point>;
+export default function kinks<T extends LineString | MultiLineString | Polygon | MultiPolygon>(featureIn: Feature<T>): FeatureCollection<Point>;

package/dist/js/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var helpers_1 = require("@turf/helpers");
+const tslib_1 = require("tslib");
+const sweepline_intersections_1 = tslib_1.__importDefault(require("sweepline-intersections"));
+const helpers_1 = require("@turf/helpers");
 /**
  * Takes a {@link LineString|linestring}, {@link MultiLineString|multi-linestring},
  * {@link MultiPolygon|multi-polygon} or {@link Polygon|polygon} and
@@ -24,116 +26,21 @@ var helpers_1 = require("@turf/helpers");
  * var addToMap = [poly, kinks]
  */
 function kinks(featureIn) {
-    var coordinates;
-    var feature;
-    var results = {
+    const results = {
         type: "FeatureCollection",
         features: [],
     };
-    if (featureIn.type === "Feature") {
-        feature = featureIn.geometry;
-    }
-    else {
-        feature = featureIn;
-    }
-    if (feature.type === "LineString") {
-        coordinates = [feature.coordinates];
-    }
-    else if (feature.type === "MultiLineString") {
-        coordinates = feature.coordinates;
-    }
-    else if (feature.type === "MultiPolygon") {
-        coordinates = [].concat.apply([], feature.coordinates);
-    }
-    else if (feature.type === "Polygon") {
-        coordinates = feature.coordinates;
-    }
-    else {
+    if (featureIn.type === "Feature" &&
+        (featureIn.geometry.type === "Point" ||
+            featureIn.geometry.type === "MultiPoint")) {
         throw new Error("Input must be a LineString, MultiLineString, " +
             "Polygon, or MultiPolygon Feature or Geometry");
     }
-    coordinates.forEach(function (line1) {
-        coordinates.forEach(function (line2) {
-            for (var i = 0; i < line1.length - 1; i++) {
-                // start iteration at i, intersections for k < i have already
-                // been checked in previous outer loop iterations
-                for (var k = i; k < line2.length - 1; k++) {
-                    if (line1 === line2) {
-                        // segments are adjacent and always share a vertex, not a kink
-                        if (Math.abs(i - k) === 1) {
-                            continue;
-                        }
-                        // first and last segment in a closed lineString or ring always share a vertex, not a kink
-                        if (
-                        // segments are first and last segment of lineString
-                        i === 0 &&
-                            k === line1.length - 2 &&
-                            // lineString is closed
-                            line1[i][0] === line1[line1.length - 1][0] &&
-                            line1[i][1] === line1[line1.length - 1][1]) {
-                            continue;
-                        }
-                    }
-                    var intersection = lineIntersects(line1[i][0], line1[i][1], line1[i + 1][0], line1[i + 1][1], line2[k][0], line2[k][1], line2[k + 1][0], line2[k + 1][1]);
-                    if (intersection) {
-                        results.features.push(helpers_1.point([intersection[0], intersection[1]]));
-                    }
-                }
-            }
-        });
-    });
+    const intersections = sweepline_intersections_1.default(featureIn, false);
+    for (let i = 0; i < intersections.length; ++i) {
+        const intersection = intersections[i];
+        results.features.push(helpers_1.point([intersection[0], intersection[1]]));
+    }
     return results;
 }
 exports.default = kinks;
-// modified from http://jsfiddle.net/justin_c_rounds/Gd2S2/light/
-function lineIntersects(line1StartX, line1StartY, line1EndX, line1EndY, line2StartX, line2StartY, line2EndX, line2EndY) {
-    // if the lines intersect, the result contains the x and y of the
-    // intersection (treating the lines as infinite) and booleans for whether
-    // line segment 1 or line segment 2 contain the point
-    var denominator;
-    var a;
-    var b;
-    var numerator1;
-    var numerator2;
-    var result = {
-        x: null,
-        y: null,
-        onLine1: false,
-        onLine2: false,
-    };
-    denominator =
-        (line2EndY - line2StartY) * (line1EndX - line1StartX) -
-            (line2EndX - line2StartX) * (line1EndY - line1StartY);
-    if (denominator === 0) {
-        if (result.x !== null && result.y !== null) {
-            return result;
-        }
-        else {
-            return false;
-        }
-    }
-    a = line1StartY - line2StartY;
-    b = line1StartX - line2StartX;
-    numerator1 = (line2EndX - line2StartX) * a - (line2EndY - line2StartY) * b;
-    numerator2 = (line1EndX - line1StartX) * a - (line1EndY - line1StartY) * b;
-    a = numerator1 / denominator;
-    b = numerator2 / denominator;
-    // if we cast these lines infinitely in both directions, they intersect here:
-    result.x = line1StartX + a * (line1EndX - line1StartX);
-    result.y = line1StartY + a * (line1EndY - line1StartY);
-    // if line1 is a segment and line2 is infinite, they intersect if:
-    if (a >= 0 && a <= 1) {
-        result.onLine1 = true;
-    }
-    // if line2 is a segment and line1 is infinite, they intersect if:
-    if (b >= 0 && b <= 1) {
-        result.onLine2 = true;
-    }
-    // if line1 and line2 are segments, they intersect if both of the above are true
-    if (result.onLine1 && result.onLine2) {
-        return [result.x, result.y];
-    }
-    else {
-        return false;
-    }
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/kinks",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf kinks module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -42,10 +43,10 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/meta": "^6.4.0",
+    "@turf/meta": "^7.0.0-alpha.0",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
@@ -55,7 +56,9 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.4.0"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "sweepline-intersections": "^1.5.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }