@turf/clusters-kmeans 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -7,14 +7,15 @@
 Takes a set of [points][1] and partition them into clusters using the k-mean .
 It uses the [k-means algorithm][2]
 
-**Parameters**
+### Parameters
 
--   `points` **[FeatureCollection][3]<[Point][4]>** to be clustered
--   `options` **[Object][5]** Optional parameters (optional, default `{}`)
-    -   `options.numberOfClusters` **[number][6]** numberOfClusters that will be generated (optional, default `Math.sqrt(numberOfPoints/2)`)
-    -   `options.mutate` **[boolean][7]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`)
+*   `points` **[FeatureCollection][3]<[Point][4]>** to be clustered
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.numberOfClusters` **[number][6]** numberOfClusters that will be generated (optional, default `Math.sqrt(numberOfPoints/2)`)
+    *   `options.mutate` **[boolean][7]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`)
+
+### Examples
 
 ```javascript
 // create random points with random z-values in their properties
@@ -26,8 +27,8 @@ var clustered = turf.clustersKmeans(points, options);
 var addToMap = [clustered];
 ```
 
-Returns **[FeatureCollection][3]&lt;[Point][4]>** Clustered Points with an additional two properties associated to each Feature:-   {number} cluster - the associated clusterId
--   {[number, number]} centroid - Centroid of the cluster [Longitude, Latitude]
+Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an additional two properties associated to each Feature:*   {number} cluster - the associated clusterId
+*   {\[number, number]} centroid - Centroid of the cluster \[Longitude, Latitude]
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 

package/dist/es/index.js

@@ -22,8 +22,7 @@ import skmeans from "skmeans";
  * //addToMap
  * var addToMap = [clustered];
  */
-function clustersKmeans(points, options) {
-    if (options === void 0) { options = {}; }
+function clustersKmeans(points, options = {}) {
     // Default Params
     var count = points.features.length;
     options.numberOfClusters =
@@ -40,8 +39,7 @@ function clustersKmeans(points, options) {
     // create seed to avoid skmeans to drift
     var initialCentroids = data.slice(0, options.numberOfClusters);
     // create skmeans clusters
-    var skmeansResult = skmeans(data, options.numberOfClusters, initialCentroids // typings are slightly wrong here
-    );
+    var skmeansResult = skmeans(data, options.numberOfClusters, initialCentroids);
     // store centroids {clusterId: [number, number]}
     var centroids = {};
     skmeansResult.centroids.forEach(function (coord, idx) {

package/dist/js/index.d.ts

@@ -1,5 +1,5 @@
-import { FeatureCollection, Point, Properties } from "@turf/helpers";
-export declare type KmeansProps = Properties & {
+import { FeatureCollection, Point, GeoJsonProperties } from "geojson";
+export declare type KmeansProps = GeoJsonProperties & {
     cluster?: number;
     centroid?: [number, number];
 };

package/dist/js/index.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var clone_1 = __importDefault(require("@turf/clone"));
-var meta_1 = require("@turf/meta");
-var skmeans_1 = __importDefault(require("skmeans"));
+const tslib_1 = require("tslib");
+const clone_1 = tslib_1.__importDefault(require("@turf/clone"));
+const meta_1 = require("@turf/meta");
+const skmeans_1 = tslib_1.__importDefault(require("skmeans"));
 /**
  * Takes a set of {@link Point|points} and partition them into clusters using the k-mean .
  * It uses the [k-means algorithm](https://en.wikipedia.org/wiki/K-means_clustering)
@@ -27,8 +25,7 @@ var skmeans_1 = __importDefault(require("skmeans"));
  * //addToMap
  * var addToMap = [clustered];
  */
-function clustersKmeans(points, options) {
-    if (options === void 0) { options = {}; }
+function clustersKmeans(points, options = {}) {
     // Default Params
     var count = points.features.length;
     options.numberOfClusters =
@@ -45,8 +42,7 @@ function clustersKmeans(points, options) {
     // create seed to avoid skmeans to drift
     var initialCentroids = data.slice(0, options.numberOfClusters);
     // create skmeans clusters
-    var skmeansResult = skmeans_1.default(data, options.numberOfClusters, initialCentroids // typings are slightly wrong here
-    );
+    var skmeansResult = skmeans_1.default(data, options.numberOfClusters, initialCentroids);
     // store centroids {clusterId: [number, number]}
     var centroids = {};
     skmeansResult.centroids.forEach(function (coord, idx) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/clusters-kmeans",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf clusters-kmeans module",
   "author": "Turf Authors",
   "contributors": [
@@ -17,6 +17,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -50,16 +51,17 @@
     "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/centroid": "^6.4.0",
-    "@turf/clusters": "^6.4.0",
-    "@turf/random": "^6.4.0",
+    "@turf/centroid": "^7.0.0-alpha.0",
+    "@turf/clusters": "^7.0.0-alpha.0",
+    "@turf/random": "^7.0.0-alpha.0",
+    "@types/skmeans": "^0.11.2",
     "@types/tape": "*",
     "benchmark": "*",
     "chromatism": "*",
-    "concaveman": "*",
+    "concaveman": "^1.2.1",
     "load-json-file": "*",
     "matrix-to-grid": "*",
     "npm-run-all": "*",
@@ -70,11 +72,12 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/clone": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0",
-    "@turf/meta": "^6.4.0",
-    "skmeans": "0.9.7"
+    "@turf/clone": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "skmeans": "0.9.7",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }