@turf/boolean-point-in-polygon 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -4,17 +4,19 @@
 
 ## booleanPointInPolygon
 
-Takes a [Point][1] and a [Polygon][2] or [MultiPolygon][3] and determines if the point resides inside the polygon. The polygon can
-be convex or concave. The function accounts for holes.
+Takes a [Point][1] and a [Polygon][2] or [MultiPolygon][3] and determines if the point
+resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.
 
-**Parameters**
+### Parameters
 
--   `point` **[Coord][4]** input point
--   `polygon` **[Feature][5]<([Polygon][6] \| [MultiPolygon][7])>** input polygon or multipolygon
--   `options` **[Object][8]** Optional parameters (optional, default `{}`)
-    -   `options.ignoreBoundary` **[boolean][9]** True if polygon boundary should be ignored when determining if the point is inside the polygon otherwise false. (optional, default `false`)
+*   `point` **[Coord][4]** input point
+*   `polygon` **[Feature][5]<([Polygon][6] | [MultiPolygon][7])>** input polygon or multipolygon
+*   `options` **[Object][8]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.ignoreBoundary` **[boolean][9]** True if polygon boundary should be ignored when determining if
+        the point is inside the polygon otherwise false. (optional, default `false`)
+
+### Examples
 
 ```javascript
 var pt = turf.point([-77, 44]);

package/dist/es/index.js

@@ -1,3 +1,4 @@
+import pip from "point-in-polygon-hao";
 import { getCoord, getGeom } from "@turf/invariant";
 // http://en.wikipedia.org/wiki/Even%E2%80%93odd_rule
 // modified from: https://github.com/substack/point-in-polygon/blob/master/index.js
@@ -26,8 +27,7 @@ import { getCoord, getGeom } from "@turf/invariant";
  * turf.booleanPointInPolygon(pt, poly);
  * //= true
  */
-export default function booleanPointInPolygon(point, polygon, options) {
-    if (options === void 0) { options = {}; }
+export default function booleanPointInPolygon(point, polygon, options = {}) {
     // validation
     if (!point) {
         throw new Error("point is required");
@@ -35,72 +35,27 @@ export default function booleanPointInPolygon(point, polygon, options) {
     if (!polygon) {
         throw new Error("polygon is required");
     }
-    var pt = getCoord(point);
-    var geom = getGeom(polygon);
-    var type = geom.type;
-    var bbox = polygon.bbox;
-    var polys = geom.coordinates;
+    const pt = getCoord(point);
+    const geom = getGeom(polygon);
+    const type = geom.type;
+    const bbox = polygon.bbox;
+    let polys = geom.coordinates;
     // Quick elimination if point is not inside bbox
     if (bbox && inBBox(pt, bbox) === false) {
         return false;
     }
-    // normalize to multipolygon
     if (type === "Polygon") {
         polys = [polys];
     }
-    var insidePoly = false;
-    for (var i = 0; i < polys.length && !insidePoly; i++) {
-        // check if it is in the outer ring first
-        if (inRing(pt, polys[i][0], options.ignoreBoundary)) {
-            var inHole = false;
-            var k = 1;
-            // check for the point in any of the holes
-            while (k < polys[i].length && !inHole) {
-                if (inRing(pt, polys[i][k], !options.ignoreBoundary)) {
-                    inHole = true;
-                }
-                k++;
-            }
-            if (!inHole) {
-                insidePoly = true;
-            }
-        }
+    let result = false;
+    for (var i = 0; i < polys.length; ++i) {
+        const polyResult = pip(pt, polys[i]);
+        if (polyResult === 0)
+            return options.ignoreBoundary ? false : true;
+        else if (polyResult)
+            result = true;
     }
-    return insidePoly;
-}
-/**
- * inRing
- *
- * @private
- * @param {Array<number>} pt [x,y]
- * @param {Array<Array<number>>} ring [[x,y], [x,y],..]
- * @param {boolean} ignoreBoundary ignoreBoundary
- * @returns {boolean} inRing
- */
-function inRing(pt, ring, ignoreBoundary) {
-    var isInside = false;
-    if (ring[0][0] === ring[ring.length - 1][0] &&
-        ring[0][1] === ring[ring.length - 1][1]) {
-        ring = ring.slice(0, ring.length - 1);
-    }
-    for (var i = 0, j = ring.length - 1; i < ring.length; j = i++) {
-        var xi = ring[i][0];
-        var yi = ring[i][1];
-        var xj = ring[j][0];
-        var yj = ring[j][1];
-        var onBoundary = pt[1] * (xi - xj) + yi * (xj - pt[0]) + yj * (pt[0] - xi) === 0 &&
-            (xi - pt[0]) * (xj - pt[0]) <= 0 &&
-            (yi - pt[1]) * (yj - pt[1]) <= 0;
-        if (onBoundary) {
-            return !ignoreBoundary;
-        }
-        var intersect = yi > pt[1] !== yj > pt[1] &&
-            pt[0] < ((xj - xi) * (pt[1] - yi)) / (yj - yi) + xi;
-        if (intersect) {
-            isInside = !isInside;
-        }
-    }
-    return isInside;
+    return result;
 }
 /**
  * inBBox

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Coord, Feature, MultiPolygon, Polygon, Properties } from "@turf/helpers";
+import { Feature, MultiPolygon, Polygon, GeoJsonProperties } from "geojson";
+import { Coord } from "@turf/helpers";
 /**
  * Takes a {@link Point} and a {@link Polygon} or {@link MultiPolygon} and determines if the point
  * resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.
@@ -23,6 +24,6 @@ import { Coord, Feature, MultiPolygon, Polygon, Properties } from "@turf/helpers
  * turf.booleanPointInPolygon(pt, poly);
  * //= true
  */
-export default function booleanPointInPolygon<G extends Polygon | MultiPolygon, P = Properties>(point: Coord, polygon: Feature<G, P> | G, options?: {
+export default function booleanPointInPolygon<G extends Polygon | MultiPolygon, P = GeoJsonProperties>(point: Coord, polygon: Feature<G, P> | G, options?: {
     ignoreBoundary?: boolean;
 }): boolean;

package/dist/js/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var invariant_1 = require("@turf/invariant");
+const tslib_1 = require("tslib");
+const point_in_polygon_hao_1 = tslib_1.__importDefault(require("point-in-polygon-hao"));
+const invariant_1 = require("@turf/invariant");
 // http://en.wikipedia.org/wiki/Even%E2%80%93odd_rule
 // modified from: https://github.com/substack/point-in-polygon/blob/master/index.js
 // which was modified from http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html
@@ -28,8 +30,7 @@ var invariant_1 = require("@turf/invariant");
  * turf.booleanPointInPolygon(pt, poly);
  * //= true
  */
-function booleanPointInPolygon(point, polygon, options) {
-    if (options === void 0) { options = {}; }
+function booleanPointInPolygon(point, polygon, options = {}) {
     // validation
     if (!point) {
         throw new Error("point is required");
@@ -37,74 +38,29 @@ function booleanPointInPolygon(point, polygon, options) {
     if (!polygon) {
         throw new Error("polygon is required");
     }
-    var pt = invariant_1.getCoord(point);
-    var geom = invariant_1.getGeom(polygon);
-    var type = geom.type;
-    var bbox = polygon.bbox;
-    var polys = geom.coordinates;
+    const pt = invariant_1.getCoord(point);
+    const geom = invariant_1.getGeom(polygon);
+    const type = geom.type;
+    const bbox = polygon.bbox;
+    let polys = geom.coordinates;
     // Quick elimination if point is not inside bbox
     if (bbox && inBBox(pt, bbox) === false) {
         return false;
     }
-    // normalize to multipolygon
     if (type === "Polygon") {
         polys = [polys];
     }
-    var insidePoly = false;
-    for (var i = 0; i < polys.length && !insidePoly; i++) {
-        // check if it is in the outer ring first
-        if (inRing(pt, polys[i][0], options.ignoreBoundary)) {
-            var inHole = false;
-            var k = 1;
-            // check for the point in any of the holes
-            while (k < polys[i].length && !inHole) {
-                if (inRing(pt, polys[i][k], !options.ignoreBoundary)) {
-                    inHole = true;
-                }
-                k++;
-            }
-            if (!inHole) {
-                insidePoly = true;
-            }
-        }
+    let result = false;
+    for (var i = 0; i < polys.length; ++i) {
+        const polyResult = point_in_polygon_hao_1.default(pt, polys[i]);
+        if (polyResult === 0)
+            return options.ignoreBoundary ? false : true;
+        else if (polyResult)
+            result = true;
     }
-    return insidePoly;
+    return result;
 }
 exports.default = booleanPointInPolygon;
-/**
- * inRing
- *
- * @private
- * @param {Array<number>} pt [x,y]
- * @param {Array<Array<number>>} ring [[x,y], [x,y],..]
- * @param {boolean} ignoreBoundary ignoreBoundary
- * @returns {boolean} inRing
- */
-function inRing(pt, ring, ignoreBoundary) {
-    var isInside = false;
-    if (ring[0][0] === ring[ring.length - 1][0] &&
-        ring[0][1] === ring[ring.length - 1][1]) {
-        ring = ring.slice(0, ring.length - 1);
-    }
-    for (var i = 0, j = ring.length - 1; i < ring.length; j = i++) {
-        var xi = ring[i][0];
-        var yi = ring[i][1];
-        var xj = ring[j][0];
-        var yj = ring[j][1];
-        var onBoundary = pt[1] * (xi - xj) + yi * (xj - pt[0]) + yj * (pt[0] - xi) === 0 &&
-            (xi - pt[0]) * (xj - pt[0]) <= 0 &&
-            (yi - pt[1]) * (yj - pt[1]) <= 0;
-        if (onBoundary) {
-            return !ignoreBoundary;
-        }
-        var intersect = yi > pt[1] !== yj > pt[1] &&
-            pt[0] < ((xj - xi) * (pt[1] - yi)) / (yj - yi) + xi;
-        if (intersect) {
-            isInside = !isInside;
-        }
-    }
-    return isInside;
-}
 /**
  * inBBox
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/boolean-point-in-polygon",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf boolean-point-in-polygon module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -29,6 +29,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -39,26 +40,28 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js"
+    "test:tape": "tsx test.js"
   },
   "devDependencies": {
     "@types/tape": "*",
     "benchmark": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "point-in-polygon-hao": "^1.1.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }