@turf/clusters-dbscan 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -48,26 +48,21 @@ Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an addition
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-<!-- 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
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/clusters-dbscan
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,116 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _clone = require('@turf/clone');
+var _distance = require('@turf/distance');
+var _helpers = require('@turf/helpers');
+
+// lib/rbush-export.ts
+var _rbush = require('rbush'); var _rbush2 = _interopRequireDefault(_rbush);
+var rbush = _rbush2.default;
+
+// index.ts
+function clustersDbscan(points, maxDistance, options = {}) {
+  if (options.mutate !== true)
+    points = _clone.clone.call(void 0, points);
+  const minPoints = options.minPoints || 3;
+  const latDistanceInDegrees = _helpers.lengthToDegrees.call(void 0, maxDistance, options.units);
+  var tree = new rbush(points.features.length);
+  var visited = points.features.map((_) => false);
+  var assigned = points.features.map((_) => false);
+  var isnoise = points.features.map((_) => false);
+  var clusterIds = points.features.map((_) => -1);
+  tree.load(
+    points.features.map((point, index) => {
+      var [x, y] = point.geometry.coordinates;
+      return {
+        minX: x,
+        minY: y,
+        maxX: x,
+        maxY: y,
+        index
+      };
+    })
+  );
+  const regionQuery = /* @__PURE__ */ __name((index) => {
+    const point = points.features[index];
+    const [x, y] = point.geometry.coordinates;
+    const minY = Math.max(y - latDistanceInDegrees, -90);
+    const maxY = Math.min(y + latDistanceInDegrees, 90);
+    const lonDistanceInDegrees = function() {
+      if (minY < 0 && maxY > 0) {
+        return latDistanceInDegrees;
+      }
+      if (Math.abs(minY) < Math.abs(maxY)) {
+        return latDistanceInDegrees / Math.cos(_helpers.degreesToRadians.call(void 0, maxY));
+      } else {
+        return latDistanceInDegrees / Math.cos(_helpers.degreesToRadians.call(void 0, minY));
+      }
+    }();
+    const minX = Math.max(x - lonDistanceInDegrees, -360);
+    const maxX = Math.min(x + lonDistanceInDegrees, 360);
+    const bbox = { minX, minY, maxX, maxY };
+    return tree.search(bbox).filter(
+      (neighbor) => {
+        const neighborIndex = neighbor.index;
+        const neighborPoint = points.features[neighborIndex];
+        const distanceInKm = _distance.distance.call(void 0, point, neighborPoint, {
+          units: "kilometers"
+        });
+        return distanceInKm <= maxDistance;
+      }
+    );
+  }, "regionQuery");
+  const expandCluster = /* @__PURE__ */ __name((clusteredId, neighbors) => {
+    for (var i = 0; i < neighbors.length; i++) {
+      var neighbor = neighbors[i];
+      const neighborIndex = neighbor.index;
+      if (!visited[neighborIndex]) {
+        visited[neighborIndex] = true;
+        const nextNeighbors = regionQuery(neighborIndex);
+        if (nextNeighbors.length >= minPoints) {
+          neighbors.push(...nextNeighbors);
+        }
+      }
+      if (!assigned[neighborIndex]) {
+        assigned[neighborIndex] = true;
+        clusterIds[neighborIndex] = clusteredId;
+      }
+    }
+  }, "expandCluster");
+  var nextClusteredId = 0;
+  points.features.forEach((_, index) => {
+    if (visited[index])
+      return;
+    const neighbors = regionQuery(index);
+    if (neighbors.length >= minPoints) {
+      const clusteredId = nextClusteredId;
+      nextClusteredId++;
+      visited[index] = true;
+      expandCluster(clusteredId, neighbors);
+    } else {
+      isnoise[index] = true;
+    }
+  });
+  points.features.forEach((_, index) => {
+    var clusterPoint = points.features[index];
+    if (!clusterPoint.properties) {
+      clusterPoint.properties = {};
+    }
+    if (clusterIds[index] >= 0) {
+      clusterPoint.properties.dbscan = isnoise[index] ? "edge" : "core";
+      clusterPoint.properties.cluster = clusterIds[index];
+    } else {
+      clusterPoint.properties.dbscan = "noise";
+    }
+  });
+  return points;
+}
+__name(clustersDbscan, "clustersDbscan");
+var turf_clusters_dbscan_default = clustersDbscan;
+
+
+
+exports.clustersDbscan = clustersDbscan; exports.default = turf_clusters_dbscan_default;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../lib/rbush-export.ts"],"names":[],"mappings":";;;;AACA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,kBAAkB,uBAA8B;;;ACCzD,OAAO,SAAS;AAET,IAAM,QAAQ;;;ADsCrB,SAAS,eACP,QACA,aACA,UAII,CAAC,GACkC;AAQvC,MAAI,QAAQ,WAAW;AAAM,aAAS,MAAM,MAAM;AAGlD,QAAM,YAAY,QAAQ,aAAa;AAGvC,QAAM,uBAAuB,gBAAgB,aAAa,QAAQ,KAAK;AAGvE,MAAI,OAAO,IAAI,MAAM,OAAO,SAAS,MAAM;AAG3C,MAAI,UAAU,OAAO,SAAS,IAAI,CAAC,MAAM,KAAK;AAG9C,MAAI,WAAW,OAAO,SAAS,IAAI,CAAC,MAAM,KAAK;AAG/C,MAAI,UAAU,OAAO,SAAS,IAAI,CAAC,MAAM,KAAK;AAG9C,MAAI,aAAuB,OAAO,SAAS,IAAI,CAAC,MAAM,EAAE;AAGxD,OAAK;AAAA,IACH,OAAO,SAAS,IAAI,CAAC,OAAO,UAAU;AACpC,UAAI,CAAC,GAAG,CAAC,IAAI,MAAM,SAAS;AAC5B,aAAO;AAAA,QACL,MAAM;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,QACN;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAGA,QAAM,cAAc,wBAAC,UAAkC;AACrD,UAAM,QAAQ,OAAO,SAAS,KAAK;AACnC,UAAM,CAAC,GAAG,CAAC,IAAI,MAAM,SAAS;AAE9B,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,GAAK;AACrD,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,EAAI;AAEpD,UAAM,uBAAwB,WAAY;AAExC,UAAI,OAAO,KAAK,OAAO,GAAG;AACxB,eAAO;AAAA,MACT;AACA,UAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,GAAG;AACnC,eAAO,uBAAuB,KAAK,IAAI,iBAAiB,IAAI,CAAC;AAAA,MAC/D,OAAO;AACL,eAAO,uBAAuB,KAAK,IAAI,iBAAiB,IAAI,CAAC;AAAA,MAC/D;AAAA,IACF,EAAG;AAEH,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,IAAM;AACtD,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,GAAK;AAGrD,UAAM,OAAO,EAAE,MAAM,MAAM,MAAM,KAAK;AACtC,WAAQ,KAAK,OAAO,IAAI,EAAkC;AAAA,MACxD,CAAC,aAAa;AACZ,cAAM,gBAAgB,SAAS;AAC/B,cAAM,gBAAgB,OAAO,SAAS,aAAa;AACnD,cAAM,eAAe,SAAS,OAAO,eAAe;AAAA,UAClD,OAAO;AAAA,QACT,CAAC;AACD,eAAO,gBAAgB;AAAA,MACzB;AAAA,IACF;AAAA,EACF,GAlCoB;AAqCpB,QAAM,gBAAgB,wBAAC,aAAqB,cAA8B;AACxE,aAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,UAAI,WAAW,UAAU,CAAC;AAC1B,YAAM,gBAAgB,SAAS;AAC/B,UAAI,CAAC,QAAQ,aAAa,GAAG;AAC3B,gBAAQ,aAAa,IAAI;AACzB,cAAM,gBAAgB,YAAY,aAAa;AAC/C,YAAI,cAAc,UAAU,WAAW;AACrC,oBAAU,KAAK,GAAG,aAAa;AAAA,QACjC;AAAA,MACF;AACA,UAAI,CAAC,SAAS,aAAa,GAAG;AAC5B,iBAAS,aAAa,IAAI;AAC1B,mBAAW,aAAa,IAAI;AAAA,MAC9B;AAAA,IACF;AAAA,EACF,GAhBsB;AAmBtB,MAAI,kBAAkB;AACtB,SAAO,SAAS,QAAQ,CAAC,GAAG,UAAU;AACpC,QAAI,QAAQ,KAAK;AAAG;AACpB,UAAM,YAAY,YAAY,KAAK;AACnC,QAAI,UAAU,UAAU,WAAW;AACjC,YAAM,cAAc;AACpB;AACA,cAAQ,KAAK,IAAI;AACjB,oBAAc,aAAa,SAAS;AAAA,IACtC,OAAO;AACL,cAAQ,KAAK,IAAI;AAAA,IACnB;AAAA,EACF,CAAC;AAGD,SAAO,SAAS,QAAQ,CAAC,GAAG,UAAU;AACpC,QAAI,eAAe,OAAO,SAAS,KAAK;AACxC,QAAI,CAAC,aAAa,YAAY;AAC5B,mBAAa,aAAa,CAAC;AAAA,IAC7B;AAEA,QAAI,WAAW,KAAK,KAAK,GAAG;AAC1B,mBAAa,WAAW,SAAS,QAAQ,KAAK,IAAI,SAAS;AAC3D,mBAAa,WAAW,UAAU,WAAW,KAAK;AAAA,IACpD,OAAO;AACL,mBAAa,WAAW,SAAS;AAAA,IACnC;AAAA,EACF,CAAC;AAED,SAAO;AACT;AA5IS;AA+IT,IAAO,+BAAQ","sourcesContent":["import { GeoJsonProperties, FeatureCollection, Point } from \"geojson\";\nimport { clone } from \"@turf/clone\";\nimport { distance } from \"@turf/distance\";\nimport { degreesToRadians, lengthToDegrees, Units } from \"@turf/helpers\";\nimport { rbush as RBush } from \"./lib/rbush-export.js\";\n\ntype Dbscan = \"core\" | \"edge\" | \"noise\";\ntype DbscanProps = GeoJsonProperties & {\n  dbscan?: Dbscan;\n  cluster?: number;\n};\n\n// Structure of a point in the spatial index\ntype IndexedPoint = {\n  minX: number;\n  minY: number;\n  maxX: number;\n  maxY: number;\n  index: number;\n};\n\n/**\n * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.\n *\n * @name clustersDbscan\n * @param {FeatureCollection<Point>} points to be clustered\n * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only)\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units=\"kilometers\"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers\n * @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated\n * @param {number} [options.minPoints=3] Minimum number of points to generate a single cluster,\n * points which do not meet this requirement will be classified as an 'edge' or 'noise'.\n * @returns {FeatureCollection<Point>} Clustered Points with an additional two properties associated to each Feature:\n * - {number} cluster - the associated clusterId\n * - {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')\n * @example\n * // create random points with random z-values in their properties\n * var points = turf.randomPoint(100, {bbox: [0, 30, 20, 50]});\n * var maxDistance = 100;\n * var clustered = turf.clustersDbscan(points, maxDistance);\n *\n * //addToMap\n * var addToMap = [clustered];\n */\nfunction clustersDbscan(\n  points: FeatureCollection<Point>,\n  maxDistance: number,\n  options: {\n    units?: Units;\n    minPoints?: number;\n    mutate?: boolean;\n  } = {}\n): FeatureCollection<Point, DbscanProps> {\n  // Input validation being handled by Typescript\n  // collectionOf(points, 'Point', 'points must consist of a FeatureCollection of only Points');\n  // if (maxDistance === null || maxDistance === undefined) throw new Error('maxDistance is required');\n  // if (!(Math.sign(maxDistance) > 0)) throw new Error('maxDistance is invalid');\n  // if (!(minPoints === undefined || minPoints === null || Math.sign(minPoints) > 0)) throw new Error('options.minPoints is invalid');\n\n  // Clone points to prevent any mutations\n  if (options.mutate !== true) points = clone(points);\n\n  // Defaults\n  const minPoints = options.minPoints || 3;\n\n  // Calculate the distance in degrees for region queries\n  const latDistanceInDegrees = lengthToDegrees(maxDistance, options.units);\n\n  // Create a spatial index\n  var tree = new RBush(points.features.length);\n\n  // Keeps track of whether a point has been visited or not.\n  var visited = points.features.map((_) => false);\n\n  // Keeps track of whether a point is assigned to a cluster or not.\n  var assigned = points.features.map((_) => false);\n\n  // Keeps track of whether a point is noise|edge or not.\n  var isnoise = points.features.map((_) => false);\n\n  // Keeps track of the clusterId for each point\n  var clusterIds: number[] = points.features.map((_) => -1);\n\n  // Index each point for spatial queries\n  tree.load(\n    points.features.map((point, index) => {\n      var [x, y] = point.geometry.coordinates;\n      return {\n        minX: x,\n        minY: y,\n        maxX: x,\n        maxY: y,\n        index: index,\n      } as IndexedPoint;\n    })\n  );\n\n  // Function to find neighbors of a point within a given distance\n  const regionQuery = (index: number): IndexedPoint[] => {\n    const point = points.features[index];\n    const [x, y] = point.geometry.coordinates;\n\n    const minY = Math.max(y - latDistanceInDegrees, -90.0);\n    const maxY = Math.min(y + latDistanceInDegrees, 90.0);\n\n    const lonDistanceInDegrees = (function () {\n      // Handle the case where the bounding box crosses the poles\n      if (minY < 0 && maxY > 0) {\n        return latDistanceInDegrees;\n      }\n      if (Math.abs(minY) < Math.abs(maxY)) {\n        return latDistanceInDegrees / Math.cos(degreesToRadians(maxY));\n      } else {\n        return latDistanceInDegrees / Math.cos(degreesToRadians(minY));\n      }\n    })();\n\n    const minX = Math.max(x - lonDistanceInDegrees, -360.0);\n    const maxX = Math.min(x + lonDistanceInDegrees, 360.0);\n\n    // Calculate the bounding box for the region query\n    const bbox = { minX, minY, maxX, maxY };\n    return (tree.search(bbox) as ReadonlyArray<IndexedPoint>).filter(\n      (neighbor) => {\n        const neighborIndex = neighbor.index;\n        const neighborPoint = points.features[neighborIndex];\n        const distanceInKm = distance(point, neighborPoint, {\n          units: \"kilometers\",\n        });\n        return distanceInKm <= maxDistance;\n      }\n    );\n  };\n\n  // Function to expand a cluster\n  const expandCluster = (clusteredId: number, neighbors: IndexedPoint[]) => {\n    for (var i = 0; i < neighbors.length; i++) {\n      var neighbor = neighbors[i];\n      const neighborIndex = neighbor.index;\n      if (!visited[neighborIndex]) {\n        visited[neighborIndex] = true;\n        const nextNeighbors = regionQuery(neighborIndex);\n        if (nextNeighbors.length >= minPoints) {\n          neighbors.push(...nextNeighbors);\n        }\n      }\n      if (!assigned[neighborIndex]) {\n        assigned[neighborIndex] = true;\n        clusterIds[neighborIndex] = clusteredId;\n      }\n    }\n  };\n\n  // Main DBSCAN clustering algorithm\n  var nextClusteredId = 0;\n  points.features.forEach((_, index) => {\n    if (visited[index]) return;\n    const neighbors = regionQuery(index);\n    if (neighbors.length >= minPoints) {\n      const clusteredId = nextClusteredId;\n      nextClusteredId++;\n      visited[index] = true;\n      expandCluster(clusteredId, neighbors);\n    } else {\n      isnoise[index] = true;\n    }\n  });\n\n  // Assign DBSCAN properties to each point\n  points.features.forEach((_, index) => {\n    var clusterPoint = points.features[index];\n    if (!clusterPoint.properties) {\n      clusterPoint.properties = {};\n    }\n\n    if (clusterIds[index] >= 0) {\n      clusterPoint.properties.dbscan = isnoise[index] ? \"edge\" : \"core\";\n      clusterPoint.properties.cluster = clusterIds[index];\n    } else {\n      clusterPoint.properties.dbscan = \"noise\";\n    }\n  });\n\n  return points as FeatureCollection<Point, DbscanProps>;\n}\n\nexport { Dbscan, DbscanProps, clustersDbscan };\nexport default clustersDbscan;\n","// Get around problems with moduleResolution node16 and some older libraries.\n// Manifests as \"This expression is not callable ... has no call signatures\"\n// https://stackoverflow.com/a/74709714\n\nimport lib from \"rbush\";\n\nexport const rbush = lib as unknown as typeof lib.default;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,38 @@
+import { GeoJsonProperties, FeatureCollection, Point } from 'geojson';
+import { Units } from '@turf/helpers';
+
+type Dbscan = "core" | "edge" | "noise";
+type DbscanProps = GeoJsonProperties & {
+    dbscan?: Dbscan;
+    cluster?: number;
+};
+/**
+ * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.
+ *
+ * @name clustersDbscan
+ * @param {FeatureCollection<Point>} points to be clustered
+ * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
+ * @param {Object} [options={}] Optional parameters
+ * @param {string} [options.units="kilometers"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers
+ * @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated
+ * @param {number} [options.minPoints=3] Minimum number of points to generate a single cluster,
+ * points which do not meet this requirement will be classified as an 'edge' or 'noise'.
+ * @returns {FeatureCollection<Point>} Clustered Points with an additional two properties associated to each Feature:
+ * - {number} cluster - the associated clusterId
+ * - {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')
+ * @example
+ * // create random points with random z-values in their properties
+ * var points = turf.randomPoint(100, {bbox: [0, 30, 20, 50]});
+ * var maxDistance = 100;
+ * var clustered = turf.clustersDbscan(points, maxDistance);
+ *
+ * //addToMap
+ * var addToMap = [clustered];
+ */
+declare function clustersDbscan(points: FeatureCollection<Point>, maxDistance: number, options?: {
+    units?: Units;
+    minPoints?: number;
+    mutate?: boolean;
+}): FeatureCollection<Point, DbscanProps>;
+
+export { type Dbscan, type DbscanProps, clustersDbscan, clustersDbscan as default };

package/dist/{js → esm}/index.d.ts

@@ -1,7 +1,8 @@
-import { GeoJsonProperties, FeatureCollection, Point } from "geojson";
-import { Units } from "@turf/helpers";
-export declare type Dbscan = "core" | "edge" | "noise";
-export declare type DbscanProps = GeoJsonProperties & {
+import { GeoJsonProperties, FeatureCollection, Point } from 'geojson';
+import { Units } from '@turf/helpers';
+
+type Dbscan = "core" | "edge" | "noise";
+type DbscanProps = GeoJsonProperties & {
     dbscan?: Dbscan;
     cluster?: number;
 };
@@ -33,4 +34,5 @@ declare function clustersDbscan(points: FeatureCollection<Point>, maxDistance: n
     minPoints?: number;
     mutate?: boolean;
 }): FeatureCollection<Point, DbscanProps>;
-export default clustersDbscan;
+
+export { type Dbscan, type DbscanProps, clustersDbscan, clustersDbscan as default };

package/dist/esm/index.js

@@ -0,0 +1,116 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { clone } from "@turf/clone";
+import { distance } from "@turf/distance";
+import { degreesToRadians, lengthToDegrees } from "@turf/helpers";
+
+// lib/rbush-export.ts
+import lib from "rbush";
+var rbush = lib;
+
+// index.ts
+function clustersDbscan(points, maxDistance, options = {}) {
+  if (options.mutate !== true)
+    points = clone(points);
+  const minPoints = options.minPoints || 3;
+  const latDistanceInDegrees = lengthToDegrees(maxDistance, options.units);
+  var tree = new rbush(points.features.length);
+  var visited = points.features.map((_) => false);
+  var assigned = points.features.map((_) => false);
+  var isnoise = points.features.map((_) => false);
+  var clusterIds = points.features.map((_) => -1);
+  tree.load(
+    points.features.map((point, index) => {
+      var [x, y] = point.geometry.coordinates;
+      return {
+        minX: x,
+        minY: y,
+        maxX: x,
+        maxY: y,
+        index
+      };
+    })
+  );
+  const regionQuery = /* @__PURE__ */ __name((index) => {
+    const point = points.features[index];
+    const [x, y] = point.geometry.coordinates;
+    const minY = Math.max(y - latDistanceInDegrees, -90);
+    const maxY = Math.min(y + latDistanceInDegrees, 90);
+    const lonDistanceInDegrees = function() {
+      if (minY < 0 && maxY > 0) {
+        return latDistanceInDegrees;
+      }
+      if (Math.abs(minY) < Math.abs(maxY)) {
+        return latDistanceInDegrees / Math.cos(degreesToRadians(maxY));
+      } else {
+        return latDistanceInDegrees / Math.cos(degreesToRadians(minY));
+      }
+    }();
+    const minX = Math.max(x - lonDistanceInDegrees, -360);
+    const maxX = Math.min(x + lonDistanceInDegrees, 360);
+    const bbox = { minX, minY, maxX, maxY };
+    return tree.search(bbox).filter(
+      (neighbor) => {
+        const neighborIndex = neighbor.index;
+        const neighborPoint = points.features[neighborIndex];
+        const distanceInKm = distance(point, neighborPoint, {
+          units: "kilometers"
+        });
+        return distanceInKm <= maxDistance;
+      }
+    );
+  }, "regionQuery");
+  const expandCluster = /* @__PURE__ */ __name((clusteredId, neighbors) => {
+    for (var i = 0; i < neighbors.length; i++) {
+      var neighbor = neighbors[i];
+      const neighborIndex = neighbor.index;
+      if (!visited[neighborIndex]) {
+        visited[neighborIndex] = true;
+        const nextNeighbors = regionQuery(neighborIndex);
+        if (nextNeighbors.length >= minPoints) {
+          neighbors.push(...nextNeighbors);
+        }
+      }
+      if (!assigned[neighborIndex]) {
+        assigned[neighborIndex] = true;
+        clusterIds[neighborIndex] = clusteredId;
+      }
+    }
+  }, "expandCluster");
+  var nextClusteredId = 0;
+  points.features.forEach((_, index) => {
+    if (visited[index])
+      return;
+    const neighbors = regionQuery(index);
+    if (neighbors.length >= minPoints) {
+      const clusteredId = nextClusteredId;
+      nextClusteredId++;
+      visited[index] = true;
+      expandCluster(clusteredId, neighbors);
+    } else {
+      isnoise[index] = true;
+    }
+  });
+  points.features.forEach((_, index) => {
+    var clusterPoint = points.features[index];
+    if (!clusterPoint.properties) {
+      clusterPoint.properties = {};
+    }
+    if (clusterIds[index] >= 0) {
+      clusterPoint.properties.dbscan = isnoise[index] ? "edge" : "core";
+      clusterPoint.properties.cluster = clusterIds[index];
+    } else {
+      clusterPoint.properties.dbscan = "noise";
+    }
+  });
+  return points;
+}
+__name(clustersDbscan, "clustersDbscan");
+var turf_clusters_dbscan_default = clustersDbscan;
+export {
+  clustersDbscan,
+  turf_clusters_dbscan_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../lib/rbush-export.ts"],"sourcesContent":["import { GeoJsonProperties, FeatureCollection, Point } from \"geojson\";\nimport { clone } from \"@turf/clone\";\nimport { distance } from \"@turf/distance\";\nimport { degreesToRadians, lengthToDegrees, Units } from \"@turf/helpers\";\nimport { rbush as RBush } from \"./lib/rbush-export.js\";\n\ntype Dbscan = \"core\" | \"edge\" | \"noise\";\ntype DbscanProps = GeoJsonProperties & {\n  dbscan?: Dbscan;\n  cluster?: number;\n};\n\n// Structure of a point in the spatial index\ntype IndexedPoint = {\n  minX: number;\n  minY: number;\n  maxX: number;\n  maxY: number;\n  index: number;\n};\n\n/**\n * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.\n *\n * @name clustersDbscan\n * @param {FeatureCollection<Point>} points to be clustered\n * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only)\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units=\"kilometers\"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers\n * @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated\n * @param {number} [options.minPoints=3] Minimum number of points to generate a single cluster,\n * points which do not meet this requirement will be classified as an 'edge' or 'noise'.\n * @returns {FeatureCollection<Point>} Clustered Points with an additional two properties associated to each Feature:\n * - {number} cluster - the associated clusterId\n * - {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')\n * @example\n * // create random points with random z-values in their properties\n * var points = turf.randomPoint(100, {bbox: [0, 30, 20, 50]});\n * var maxDistance = 100;\n * var clustered = turf.clustersDbscan(points, maxDistance);\n *\n * //addToMap\n * var addToMap = [clustered];\n */\nfunction clustersDbscan(\n  points: FeatureCollection<Point>,\n  maxDistance: number,\n  options: {\n    units?: Units;\n    minPoints?: number;\n    mutate?: boolean;\n  } = {}\n): FeatureCollection<Point, DbscanProps> {\n  // Input validation being handled by Typescript\n  // collectionOf(points, 'Point', 'points must consist of a FeatureCollection of only Points');\n  // if (maxDistance === null || maxDistance === undefined) throw new Error('maxDistance is required');\n  // if (!(Math.sign(maxDistance) > 0)) throw new Error('maxDistance is invalid');\n  // if (!(minPoints === undefined || minPoints === null || Math.sign(minPoints) > 0)) throw new Error('options.minPoints is invalid');\n\n  // Clone points to prevent any mutations\n  if (options.mutate !== true) points = clone(points);\n\n  // Defaults\n  const minPoints = options.minPoints || 3;\n\n  // Calculate the distance in degrees for region queries\n  const latDistanceInDegrees = lengthToDegrees(maxDistance, options.units);\n\n  // Create a spatial index\n  var tree = new RBush(points.features.length);\n\n  // Keeps track of whether a point has been visited or not.\n  var visited = points.features.map((_) => false);\n\n  // Keeps track of whether a point is assigned to a cluster or not.\n  var assigned = points.features.map((_) => false);\n\n  // Keeps track of whether a point is noise|edge or not.\n  var isnoise = points.features.map((_) => false);\n\n  // Keeps track of the clusterId for each point\n  var clusterIds: number[] = points.features.map((_) => -1);\n\n  // Index each point for spatial queries\n  tree.load(\n    points.features.map((point, index) => {\n      var [x, y] = point.geometry.coordinates;\n      return {\n        minX: x,\n        minY: y,\n        maxX: x,\n        maxY: y,\n        index: index,\n      } as IndexedPoint;\n    })\n  );\n\n  // Function to find neighbors of a point within a given distance\n  const regionQuery = (index: number): IndexedPoint[] => {\n    const point = points.features[index];\n    const [x, y] = point.geometry.coordinates;\n\n    const minY = Math.max(y - latDistanceInDegrees, -90.0);\n    const maxY = Math.min(y + latDistanceInDegrees, 90.0);\n\n    const lonDistanceInDegrees = (function () {\n      // Handle the case where the bounding box crosses the poles\n      if (minY < 0 && maxY > 0) {\n        return latDistanceInDegrees;\n      }\n      if (Math.abs(minY) < Math.abs(maxY)) {\n        return latDistanceInDegrees / Math.cos(degreesToRadians(maxY));\n      } else {\n        return latDistanceInDegrees / Math.cos(degreesToRadians(minY));\n      }\n    })();\n\n    const minX = Math.max(x - lonDistanceInDegrees, -360.0);\n    const maxX = Math.min(x + lonDistanceInDegrees, 360.0);\n\n    // Calculate the bounding box for the region query\n    const bbox = { minX, minY, maxX, maxY };\n    return (tree.search(bbox) as ReadonlyArray<IndexedPoint>).filter(\n      (neighbor) => {\n        const neighborIndex = neighbor.index;\n        const neighborPoint = points.features[neighborIndex];\n        const distanceInKm = distance(point, neighborPoint, {\n          units: \"kilometers\",\n        });\n        return distanceInKm <= maxDistance;\n      }\n    );\n  };\n\n  // Function to expand a cluster\n  const expandCluster = (clusteredId: number, neighbors: IndexedPoint[]) => {\n    for (var i = 0; i < neighbors.length; i++) {\n      var neighbor = neighbors[i];\n      const neighborIndex = neighbor.index;\n      if (!visited[neighborIndex]) {\n        visited[neighborIndex] = true;\n        const nextNeighbors = regionQuery(neighborIndex);\n        if (nextNeighbors.length >= minPoints) {\n          neighbors.push(...nextNeighbors);\n        }\n      }\n      if (!assigned[neighborIndex]) {\n        assigned[neighborIndex] = true;\n        clusterIds[neighborIndex] = clusteredId;\n      }\n    }\n  };\n\n  // Main DBSCAN clustering algorithm\n  var nextClusteredId = 0;\n  points.features.forEach((_, index) => {\n    if (visited[index]) return;\n    const neighbors = regionQuery(index);\n    if (neighbors.length >= minPoints) {\n      const clusteredId = nextClusteredId;\n      nextClusteredId++;\n      visited[index] = true;\n      expandCluster(clusteredId, neighbors);\n    } else {\n      isnoise[index] = true;\n    }\n  });\n\n  // Assign DBSCAN properties to each point\n  points.features.forEach((_, index) => {\n    var clusterPoint = points.features[index];\n    if (!clusterPoint.properties) {\n      clusterPoint.properties = {};\n    }\n\n    if (clusterIds[index] >= 0) {\n      clusterPoint.properties.dbscan = isnoise[index] ? \"edge\" : \"core\";\n      clusterPoint.properties.cluster = clusterIds[index];\n    } else {\n      clusterPoint.properties.dbscan = \"noise\";\n    }\n  });\n\n  return points as FeatureCollection<Point, DbscanProps>;\n}\n\nexport { Dbscan, DbscanProps, clustersDbscan };\nexport default clustersDbscan;\n","// Get around problems with moduleResolution node16 and some older libraries.\n// Manifests as \"This expression is not callable ... has no call signatures\"\n// https://stackoverflow.com/a/74709714\n\nimport lib from \"rbush\";\n\nexport const rbush = lib as unknown as typeof lib.default;\n"],"mappings":";;;;AACA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,kBAAkB,uBAA8B;;;ACCzD,OAAO,SAAS;AAET,IAAM,QAAQ;;;ADsCrB,SAAS,eACP,QACA,aACA,UAII,CAAC,GACkC;AAQvC,MAAI,QAAQ,WAAW;AAAM,aAAS,MAAM,MAAM;AAGlD,QAAM,YAAY,QAAQ,aAAa;AAGvC,QAAM,uBAAuB,gBAAgB,aAAa,QAAQ,KAAK;AAGvE,MAAI,OAAO,IAAI,MAAM,OAAO,SAAS,MAAM;AAG3C,MAAI,UAAU,OAAO,SAAS,IAAI,CAAC,MAAM,KAAK;AAG9C,MAAI,WAAW,OAAO,SAAS,IAAI,CAAC,MAAM,KAAK;AAG/C,MAAI,UAAU,OAAO,SAAS,IAAI,CAAC,MAAM,KAAK;AAG9C,MAAI,aAAuB,OAAO,SAAS,IAAI,CAAC,MAAM,EAAE;AAGxD,OAAK;AAAA,IACH,OAAO,SAAS,IAAI,CAAC,OAAO,UAAU;AACpC,UAAI,CAAC,GAAG,CAAC,IAAI,MAAM,SAAS;AAC5B,aAAO;AAAA,QACL,MAAM;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,QACN,MAAM;AAAA,QACN;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAGA,QAAM,cAAc,wBAAC,UAAkC;AACrD,UAAM,QAAQ,OAAO,SAAS,KAAK;AACnC,UAAM,CAAC,GAAG,CAAC,IAAI,MAAM,SAAS;AAE9B,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,GAAK;AACrD,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,EAAI;AAEpD,UAAM,uBAAwB,WAAY;AAExC,UAAI,OAAO,KAAK,OAAO,GAAG;AACxB,eAAO;AAAA,MACT;AACA,UAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,GAAG;AACnC,eAAO,uBAAuB,KAAK,IAAI,iBAAiB,IAAI,CAAC;AAAA,MAC/D,OAAO;AACL,eAAO,uBAAuB,KAAK,IAAI,iBAAiB,IAAI,CAAC;AAAA,MAC/D;AAAA,IACF,EAAG;AAEH,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,IAAM;AACtD,UAAM,OAAO,KAAK,IAAI,IAAI,sBAAsB,GAAK;AAGrD,UAAM,OAAO,EAAE,MAAM,MAAM,MAAM,KAAK;AACtC,WAAQ,KAAK,OAAO,IAAI,EAAkC;AAAA,MACxD,CAAC,aAAa;AACZ,cAAM,gBAAgB,SAAS;AAC/B,cAAM,gBAAgB,OAAO,SAAS,aAAa;AACnD,cAAM,eAAe,SAAS,OAAO,eAAe;AAAA,UAClD,OAAO;AAAA,QACT,CAAC;AACD,eAAO,gBAAgB;AAAA,MACzB;AAAA,IACF;AAAA,EACF,GAlCoB;AAqCpB,QAAM,gBAAgB,wBAAC,aAAqB,cAA8B;AACxE,aAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,KAAK;AACzC,UAAI,WAAW,UAAU,CAAC;AAC1B,YAAM,gBAAgB,SAAS;AAC/B,UAAI,CAAC,QAAQ,aAAa,GAAG;AAC3B,gBAAQ,aAAa,IAAI;AACzB,cAAM,gBAAgB,YAAY,aAAa;AAC/C,YAAI,cAAc,UAAU,WAAW;AACrC,oBAAU,KAAK,GAAG,aAAa;AAAA,QACjC;AAAA,MACF;AACA,UAAI,CAAC,SAAS,aAAa,GAAG;AAC5B,iBAAS,aAAa,IAAI;AAC1B,mBAAW,aAAa,IAAI;AAAA,MAC9B;AAAA,IACF;AAAA,EACF,GAhBsB;AAmBtB,MAAI,kBAAkB;AACtB,SAAO,SAAS,QAAQ,CAAC,GAAG,UAAU;AACpC,QAAI,QAAQ,KAAK;AAAG;AACpB,UAAM,YAAY,YAAY,KAAK;AACnC,QAAI,UAAU,UAAU,WAAW;AACjC,YAAM,cAAc;AACpB;AACA,cAAQ,KAAK,IAAI;AACjB,oBAAc,aAAa,SAAS;AAAA,IACtC,OAAO;AACL,cAAQ,KAAK,IAAI;AAAA,IACnB;AAAA,EACF,CAAC;AAGD,SAAO,SAAS,QAAQ,CAAC,GAAG,UAAU;AACpC,QAAI,eAAe,OAAO,SAAS,KAAK;AACxC,QAAI,CAAC,aAAa,YAAY;AAC5B,mBAAa,aAAa,CAAC;AAAA,IAC7B;AAEA,QAAI,WAAW,KAAK,KAAK,GAAG;AAC1B,mBAAa,WAAW,SAAS,QAAQ,KAAK,IAAI,SAAS;AAC3D,mBAAa,WAAW,UAAU,WAAW,KAAK;AAAA,IACpD,OAAO;AACL,mBAAa,WAAW,SAAS;AAAA,IACnC;AAAA,EACF,CAAC;AAED,SAAO;AACT;AA5IS;AA+IT,IAAO,+BAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/clusters-dbscan",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf clusters-dbscan module",
   "author": "Turf Authors",
   "contributors": [
@@ -30,54 +30,59 @@
     "density",
     "dbscan"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "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": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js",
-    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts",
+    "test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/centroid": "^7.0.0-alpha.2",
-    "@turf/clusters": "^7.0.0-alpha.2",
-    "@types/density-clustering": "^1.3.0",
-    "@types/tape": "*",
-    "benchmark": "*",
-    "chromatism": "*",
+    "@turf/centroid": "^7.0.0",
+    "@turf/clusters": "^7.0.0",
+    "@types/benchmark": "^2.1.5",
+    "@types/rbush": "^3.0.2",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "chromatism": "^3.0.0",
     "concaveman": "^1.2.1",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/clone": "^7.0.0-alpha.2",
-    "@turf/distance": "^7.0.0-alpha.2",
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/meta": "^7.0.0-alpha.2",
-    "density-clustering": "1.3.0",
-    "tslib": "^2.3.0"
+    "@turf/clone": "^7.0.0",
+    "@turf/distance": "^7.0.0",
+    "@turf/helpers": "^7.0.0",
+    "@turf/meta": "^7.0.0",
+    "rbush": "^3.0.1",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "3d3a7917025fbabe191dbddbc89754b86f9c7739"
 }

package/dist/es/index.js

@@ -1,69 +0,0 @@
-import clone from "@turf/clone";
-import distance from "@turf/distance";
-import { coordAll } from "@turf/meta";
-import { convertLength } from "@turf/helpers";
-import clustering from "density-clustering";
-/**
- * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.
- *
- * @name clustersDbscan
- * @param {FeatureCollection<Point>} points to be clustered
- * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units="kilometers"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers
- * @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated
- * @param {number} [options.minPoints=3] Minimum number of points to generate a single cluster,
- * points which do not meet this requirement will be classified as an 'edge' or 'noise'.
- * @returns {FeatureCollection<Point>} Clustered Points with an additional two properties associated to each Feature:
- * - {number} cluster - the associated clusterId
- * - {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')
- * @example
- * // create random points with random z-values in their properties
- * var points = turf.randomPoint(100, {bbox: [0, 30, 20, 50]});
- * var maxDistance = 100;
- * var clustered = turf.clustersDbscan(points, maxDistance);
- *
- * //addToMap
- * var addToMap = [clustered];
- */
-function clustersDbscan(points, maxDistance, options = {}) {
-    // Input validation being handled by Typescript
-    // collectionOf(points, 'Point', 'points must consist of a FeatureCollection of only Points');
-    // if (maxDistance === null || maxDistance === undefined) throw new Error('maxDistance is required');
-    // if (!(Math.sign(maxDistance) > 0)) throw new Error('maxDistance is invalid');
-    // if (!(minPoints === undefined || minPoints === null || Math.sign(minPoints) > 0)) throw new Error('options.minPoints is invalid');
-    // Clone points to prevent any mutations
-    if (options.mutate !== true)
-        points = clone(points);
-    // Defaults
-    options.minPoints = options.minPoints || 3;
-    // create clustered ids
-    var dbscan = new clustering.DBSCAN();
-    var clusteredIds = dbscan.run(coordAll(points), convertLength(maxDistance, options.units), options.minPoints, distance);
-    // Tag points to Clusters ID
-    var clusterId = -1;
-    clusteredIds.forEach(function (clusterIds) {
-        clusterId++;
-        // assign cluster ids to input points
-        clusterIds.forEach(function (idx) {
-            var clusterPoint = points.features[idx];
-            if (!clusterPoint.properties)
-                clusterPoint.properties = {};
-            clusterPoint.properties.cluster = clusterId;
-            clusterPoint.properties.dbscan = "core";
-        });
-    });
-    // handle noise points, if any
-    // edges points are tagged by DBSCAN as both 'noise' and 'cluster' as they can "reach" less than 'minPoints' number of points
-    dbscan.noise.forEach(function (noiseId) {
-        var noisePoint = points.features[noiseId];
-        if (!noisePoint.properties)
-            noisePoint.properties = {};
-        if (noisePoint.properties.cluster)
-            noisePoint.properties.dbscan = "edge";
-        else
-            noisePoint.properties.dbscan = "noise";
-    });
-    return points;
-}
-export default clustersDbscan;

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const clone_1 = tslib_1.__importDefault(require("@turf/clone"));
-const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
-const meta_1 = require("@turf/meta");
-const helpers_1 = require("@turf/helpers");
-const density_clustering_1 = tslib_1.__importDefault(require("density-clustering"));
-/**
- * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.
- *
- * @name clustersDbscan
- * @param {FeatureCollection<Point>} points to be clustered
- * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units="kilometers"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers
- * @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated
- * @param {number} [options.minPoints=3] Minimum number of points to generate a single cluster,
- * points which do not meet this requirement will be classified as an 'edge' or 'noise'.
- * @returns {FeatureCollection<Point>} Clustered Points with an additional two properties associated to each Feature:
- * - {number} cluster - the associated clusterId
- * - {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')
- * @example
- * // create random points with random z-values in their properties
- * var points = turf.randomPoint(100, {bbox: [0, 30, 20, 50]});
- * var maxDistance = 100;
- * var clustered = turf.clustersDbscan(points, maxDistance);
- *
- * //addToMap
- * var addToMap = [clustered];
- */
-function clustersDbscan(points, maxDistance, options = {}) {
-    // Input validation being handled by Typescript
-    // collectionOf(points, 'Point', 'points must consist of a FeatureCollection of only Points');
-    // if (maxDistance === null || maxDistance === undefined) throw new Error('maxDistance is required');
-    // if (!(Math.sign(maxDistance) > 0)) throw new Error('maxDistance is invalid');
-    // if (!(minPoints === undefined || minPoints === null || Math.sign(minPoints) > 0)) throw new Error('options.minPoints is invalid');
-    // Clone points to prevent any mutations
-    if (options.mutate !== true)
-        points = clone_1.default(points);
-    // Defaults
-    options.minPoints = options.minPoints || 3;
-    // create clustered ids
-    var dbscan = new density_clustering_1.default.DBSCAN();
-    var clusteredIds = dbscan.run(meta_1.coordAll(points), helpers_1.convertLength(maxDistance, options.units), options.minPoints, distance_1.default);
-    // Tag points to Clusters ID
-    var clusterId = -1;
-    clusteredIds.forEach(function (clusterIds) {
-        clusterId++;
-        // assign cluster ids to input points
-        clusterIds.forEach(function (idx) {
-            var clusterPoint = points.features[idx];
-            if (!clusterPoint.properties)
-                clusterPoint.properties = {};
-            clusterPoint.properties.cluster = clusterId;
-            clusterPoint.properties.dbscan = "core";
-        });
-    });
-    // handle noise points, if any
-    // edges points are tagged by DBSCAN as both 'noise' and 'cluster' as they can "reach" less than 'minPoints' number of points
-    dbscan.noise.forEach(function (noiseId) {
-        var noisePoint = points.features[noiseId];
-        if (!noisePoint.properties)
-            noisePoint.properties = {};
-        if (noisePoint.properties.cluster)
-            noisePoint.properties.dbscan = "edge";
-        else
-            noisePoint.properties.dbscan = "noise";
-    });
-    return points;
-}
-exports.default = clustersDbscan;