npm - w-cluster - Versions diffs - 1.0.13 → 1.0.15 - Mend

w-cluster 1.0.13 → 1.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/.eslintrc.js +17 -17
package/README.md +2 -2
package/babel.config.js +1 -0
package/docs/WCluster.mjs.html +5 -2
package/docs/examples/ex-PCA.html +1 -1
package/docs/examples/ex-cluster-webworker.html +1 -1
package/docs/examples/ex-cluster.html +1 -1
package/docs/global.html +93 -76
package/docs/index.html +5 -2
package/docs/scripts/collapse.js +19 -0
package/docs/scripts/commonNav.js +28 -0
package/docs/scripts/search.js +16 -0
package/docs/styles/jsdoc.css +13 -2
package/docs/styles/prettify.css +1 -0
package/package.json +5 -5
package/dist/w-cluster.umd.js +0 -7
package/dist/w-cluster.umd.js.map +0 -1
package/dist/w-cluster.wk.umd.js +0 -1

package/docs/global.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 <nav >
-    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#cluster">cluster</a></li><li><a href="global.html#PCA">PCA</a></li><li><a href="global.html#WCluster">WCluster</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#PCA">PCA</a></li><li><a href="global.html#WCluster">WCluster</a></li><li><a href="global.html#cluster">cluster</a></li></ul>
 </nav>
 <div id="main">
@@ -46,6 +49,8 @@
         <h2>
         </h2>
@@ -58,6 +63,7 @@
 <dl class="details">
@@ -126,6 +132,10 @@
 <dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>數據主成份分析與分群</p></li></ul></dd>
     <dt class="tag-source">Source:</dt>
@@ -179,7 +189,7 @@
-    <h5>Example</h5>
+    <h5 class="h5-examples">Example</h5>
     <pre class="prettyprint"><code>async function testPCA() {
    let mat = [
        [40, 50, 60],
        [50, 70, 60],
        [80, 70, 90],
        [50, 60, 80]
    ]
    console.log('mat', mat)
    // => mat [ [ 40, 50, 60 ], [ 50, 70, 60 ], [ 80, 70, 90 ], [ 50, 60, 80 ] ]
    let resMat = await WCluster.PCA(mat, { nCompNIPALS: 2 })
    console.log(resMat)
    // => [
    //   [ -1.704002697669786, 0.43087564048799354 ],
    //   [ -0.2509699164590232, -1.1519035967558147 ],
    //   [ 1.9913098008410954, 0.23244503334983269 ],
    //   [ -0.03633718671228592, 0.48858292291798827 ]
    // ]
    let mat2 = [
        [1040, 50, 60],
        [1050, 70, 60],
        [1080, 70, 90],
        [1050, 60, 80]
    ]
    console.log('mat2', mat2)
    // => mat [ [ 1040, 50, 60 ], [ 1050, 70, 60 ], [ 1080, 70, 90 ], [ 1050, 60, 80 ] ]
    let resMat2 = await WCluster.PCA(mat2, { nCompNIPALS: 2 })
    console.log(resMat2)
    // => [
    //   [ -1.704002697669786, 0.43087564048799354 ],
    //   [ -0.2509699164590232, -1.1519035967558147 ],
    //   [ 1.9913098008410954, 0.23244503334983269 ],
    //   [ -0.03633718671228592, 0.48858292291798827 ]
    // ]
    let mat3 = [
        [11040, 50, 60],
        [13050, 70, 60],
        [15080, 70, 90],
        [17050, 60, 80]
    ]
    console.log('mat3', mat3)
    // => mat [ [ 11040, 50, 60 ], [ 13050, 70, 60 ], [ 15080, 70, 90 ], [ 17050, 60, 80 ] ]
    let resMat3 = await WCluster.PCA(mat3, { nCompNIPALS: 2 })
    console.log(resMat3)
    // => [
    //   [ -1.8599655569892897, 0.4908764271508211 ],
    //   [ -0.3950941652793108, -1.0977355294143445 ],
    //   [ 1.3430199944041517, -0.17213692267477554 ],
    //   [ 0.912039727864449, 0.778996024938299 ]
    // ]
    .catch((err) => {
        console.log(err)
    })
    let mode = 'k-medoids'
    let mat = [
        [40, 50, 60],
        [50, 70, 60],
        [80, 70, 90],
        [50, 60, 80]
    ]
    console.log('mat', mat)
    // => mat [ [ 40, 50, 60 ], [ 50, 70, 60 ], [ 80, 70, 90 ], [ 50, 60, 80 ] ]
    let resMat = await WCluster.cluster(mat, { mode, kNumber: 2, nCompNIPALS: 2 })
    console.log(JSON.stringify(resMat, null, 2))
    // => {
    //   "keys": null,
    //   "ginds": [
    //     [ 0, 1, 3 ],
    //     [ 2 ]
    //   ],
    //   "gmat": [
    //     [
    //       [ -1.704002697669786, 0.43087564048799354 ],
    //       [ -0.2509699164590232, -1.1519035967558147 ],
    //       [ -0.03633718671228592, 0.48858292291798827 ]
    //     ],
    //     [
    //       [ 1.9913098008410954, 0.23244503334983269 ]
    //     ]
    //   ],
    //   "gltdt": [
    //     [
    //       [ 40, 50, 60 ],
    //       [ 50, 70, 60 ],
    //       [ 50, 60, 80 ]
    //     ],
    //     [
    //       [ 80, 70, 90 ]
    //     ]
    //   ]
    // }
    let mat2 = [
        [1040, 50, 60],
        [1050, 70, 60],
        [1080, 70, 90],
        [1050, 60, 80]
    ]
    console.log('mat2', mat2)
    // => mat [ [ 1040, 50, 60 ], [ 1050, 70, 60 ], [ 1080, 70, 90 ], [ 1050, 60, 80 ] ]
    let resMat2 = await WCluster.cluster(mat2, { mode, kNumber: 2, nCompNIPALS: 2 })
    console.log(JSON.stringify(resMat2, null, 2))
    // => {
    //   "keys": null,
    //   "ginds": [
    //     [ 0, 1, 3 ],
    //     [ 2 ]
    //   ],
    //   "gmat": [
    //     [
    //       [ -1.704002697669786, 0.43087564048799354 ],
    //       [ -0.2509699164590232, -1.1519035967558147 ],
    //       [ -0.03633718671228592, 0.48858292291798827 ]
    //     ],
    //     [
    //       [ 1.9913098008410954, 0.23244503334983269 ]
    //     ]
    //   ],
    //   "gltdt": [
    //     [
    //       [ 1040, 50, 60 ],
    //       [ 1050, 70, 60 ],
    //       [ 1050, 60, 80 ]
    //     ],
    //     [
    //       [ 1080, 70, 90 ]
    //     ]
    //   ]
    // }
    let mat3 = [
        [11040, 50, 60],
        [13050, 70, 60],
        [15080, 70, 90],
        [17050, 60, 80]
    ]
    console.log('mat3', mat3)
    // => mat [ [ 11040, 50, 60 ], [ 13050, 70, 60 ], [ 15080, 70, 90 ], [ 17050, 60, 80 ] ]
    let resMat3 = await WCluster.cluster(mat3, { mode, kNumber: 2, nCompNIPALS: 2 })
    console.log(JSON.stringify(resMat3, null, 2))
    // => {
    //   "keys": null,
    //   "ginds": [
    //     [ 1, 2, 3 ],
    //     [ 0 ]
    //   ],
    //   "gmat": [
    //     [
    //       [ -0.3950941652793108, -1.0977355294143445 ],
    //       [ 1.3430199944041517, -0.17213692267477554 ],
    //       [ 0.912039727864449, 0.778996024938299 ]
    //     ],
    //     [
    //       [ -1.8599655569892897, 0.4908764271508211 ]
    //     ]
    //   ],
    //   "gltdt": [
    //     [
    //       [ 13050, 70, 60 ],
    //       [ 15080, 70, 90 ],
    //       [ 17050, 60, 80 ]
    //     ],
    //     [
    //       [ 11040, 50, 60 ]
    //     ]
    //   ]
    // }
    let ltdt = [
        { name: 'Cameron', a: 40, b: 50, c: 60 },
        { name: 'Buckley', a: 50, b: 70, c: 60 },
        { name: 'Paul', a: 80, b: 70, c: 90 },
        { name: 'Fawcett', a: 50, b: 60, c: 80 },
    ]
    console.log('ltdt', ltdt)
    // => ltdt [
    //     { name: 'Cameron', a: 40, b: 50, c: 60 },
    //     { name: 'Buckley', a: 50, b: 70, c: 60 },
    //     { name: 'Paul', a: 80, b: 70, c: 90 },
    //     { name: 'Fawcett', a: 50, b: 60, c: 80 }
    // ]
    let resLtdt = await WCluster.cluster(ltdt, { mode, kNumber: 2, nCompNIPALS: 2 })
    console.log(JSON.stringify(resLtdt, null, 2))
    // => {
    //   "keys": [ "a", "b", "c" ],
    //   "ginds": [
    //     [ 0, 1, 3 ],
    //     [ 2 ]
    //   ],
    //   "gmat": [
    //     [
    //       [ -1.704002697669786, 0.43087564048799354 ],
    //       [ -0.2509699164590232, -1.1519035967558147 ],
    //       [ -0.03633718671228592, 0.48858292291798827 ]
    //     ],
    //     [
    //       [ 1.9913098008410954, 0.23244503334983269 ]
    //     ]
    //   ],
    //   "gltdt": [
    //     [
    //       { "name": "Cameron", "a": 40, "b": 50, "c": 60 },
    //       { "name": "Buckley", "a": 50, "b": 70, "c": 60 },
    //       { "name": "Fawcett", "a": 50, "b": 60, "c": 80 }
    //     ],
    //     [
    //       { "name": "Paul", "a": 80, "b": 70, "c": 90 }
    //     ]
    //   ]
    // }
    .catch((err) => {
        console.log(err)
    })</code></pre>
@@ -196,7 +206,7 @@
-    <h4 class="name" id="cluster"><span class="type-signature">(async) </span>cluster<span class="signature">(data, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id="PCA"><span class="type-signature type-signature-async">(async) </span>PCA<span class="signature">(data, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
@@ -204,11 +214,15 @@
 <dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>數據主成分分析(Principal Component Analysis, PCA)</p></li></ul></dd>
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WCluster.mjs.html">WCluster.mjs</a>, <a href="WCluster.mjs.html#line31">line 31</a>
+        <a href="WCluster.mjs.html">WCluster.mjs</a>, <a href="WCluster.mjs.html#line15">line 15</a>
     </li></ul></dd>
@@ -247,26 +261,20 @@
-<div class="description usertext">
-    <p>針對數據陣列做分群</p>
-</div>
-    <h5>Example</h5>
+    <h5 class="h5-examples">Example</h5>
     <pre class="prettyprint"><code></code></pre>
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -304,6 +312,7 @@
 <span class="param-type">Array</span>
             </td>
@@ -323,7 +332,7 @@
                 </td>
-            <td class="description last"><p>輸入數據陣列，可輸入純數據陣列(mat)或物件陣列(ltdt)</p></td>
+            <td class="description last"><p>輸入數據陣列</p></td>
         </tr>
@@ -339,6 +348,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -392,13 +402,14 @@
         <tr>
-                <td class="name"><code>kNumber</code></td>
+                <td class="name"><code>scale</code></td>
             <td class="type">
-<span class="param-type">Number</span>
+<span class="param-type">Boolean</span>
@@ -419,12 +430,12 @@
                 <td class="default">
-                    <code>2</code>
+                    <code>true</code>
                 </td>
-            <td class="description last"><p>輸入指定分群數整數，不能超過數據的長度，預設2</p></td>
+            <td class="description last"><p>輸入是否對數據正規化布林值，預設true</p></td>
         </tr>
@@ -440,6 +451,7 @@
 <span class="param-type">Number</span>
             </td>
@@ -467,45 +479,6 @@
         </tr>
-        <tr>
-                <td class="name"><code>mode</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    <code>'k-medoids'</code>
-                </td>
-            <td class="description last"><p>輸入分群方法字串，可為'k-means'、'k-medoids'，k-means受初始隨機群中心影響較大，預設'k-medoids'</p></td>
-        </tr>
     </tbody>
 </table>
@@ -531,11 +504,11 @@
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
-    <p>回傳Promise，resolve回傳分群後結果物件，keys代表分群有使用到的欄位，ginds代表分群後的指標陣列，gltdt代表分群後的物件陣列，gmat代表分群後且經過PCA處理的數據陣列，其內因是降維後的數據，可例如取最左2欄的數據代表x,y來繪製分群後二維分佈圖，reject回傳錯誤訊息</p>
+    <p>回傳Promise，resolve回傳指定維數數值的陣列，reject回傳錯誤訊息</p>
 </div>
@@ -549,6 +522,7 @@
 <span class="param-type">Promise</span>
     </dd>
 </dl>
@@ -561,7 +535,7 @@
-    <h4 class="name" id="PCA"><span class="type-signature">(async) </span>PCA<span class="signature">(data, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id="cluster"><span class="type-signature type-signature-async">(async) </span>cluster<span class="signature">(data, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
@@ -569,11 +543,15 @@
 <dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>針對數據陣列做分群</p></li></ul></dd>
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WCluster.mjs.html">WCluster.mjs</a>, <a href="WCluster.mjs.html#line15">line 15</a>
+        <a href="WCluster.mjs.html">WCluster.mjs</a>, <a href="WCluster.mjs.html#line31">line 31</a>
     </li></ul></dd>
@@ -612,26 +590,20 @@
-<div class="description usertext">
-    <p>數據主成分分析(Principal Component Analysis, PCA)</p>
-</div>
-    <h5>Example</h5>
+    <h5 class="h5-examples">Example</h5>
     <pre class="prettyprint"><code></code></pre>
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -669,6 +641,7 @@
 <span class="param-type">Array</span>
             </td>
@@ -688,7 +661,7 @@
                 </td>
-            <td class="description last"><p>輸入數據陣列</p></td>
+            <td class="description last"><p>輸入數據陣列，可輸入純數據陣列(mat)或物件陣列(ltdt)</p></td>
         </tr>
@@ -704,6 +677,7 @@
 <span class="param-type">Object</span>
             </td>
@@ -757,13 +731,14 @@
         <tr>
-                <td class="name"><code>scale</code></td>
+                <td class="name"><code>kNumber</code></td>
             <td class="type">
-<span class="param-type">Boolean</span>
+<span class="param-type">Number</span>
@@ -784,12 +759,12 @@
                 <td class="default">
-                    <code>true</code>
+                    <code>2</code>
                 </td>
-            <td class="description last"><p>輸入是否對數據正規化布林值，預設true</p></td>
+            <td class="description last"><p>輸入指定分群數整數，不能超過數據的長度，預設2</p></td>
         </tr>
@@ -805,6 +780,7 @@
 <span class="param-type">Number</span>
             </td>
@@ -832,6 +808,46 @@
         </tr>
+        <tr>
+                <td class="name"><code>mode</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>'k-medoids'</code>
+                </td>
+            <td class="description last"><p>輸入分群方法字串，可為'k-means'、'k-medoids'，k-means受初始隨機群中心影響較大，預設'k-medoids'</p></td>
+        </tr>
     </tbody>
 </table>
@@ -857,11 +873,11 @@
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
-    <p>回傳Promise，resolve回傳指定維數數值的陣列，reject回傳錯誤訊息</p>
+    <p>回傳Promise，resolve回傳分群後結果物件，keys代表分群有使用到的欄位，ginds代表分群後的指標陣列，gltdt代表分群後的物件陣列，gmat代表分群後且經過PCA處理的數據陣列，其內因是降維後的數據，可例如取最左2欄的數據代表x,y來繪製分群後二維分佈圖，reject回傳錯誤訊息</p>
 </div>
@@ -875,6 +891,7 @@
 <span class="param-type">Promise</span>
     </dd>
 </dl>
@@ -902,7 +919,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Aug 04 2022 08:38:41 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Mar 29 2023 11:09:40 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/index.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 <nav >
-    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#cluster">cluster</a></li><li><a href="global.html#PCA">PCA</a></li><li><a href="global.html#WCluster">WCluster</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#PCA">PCA</a></li><li><a href="global.html#WCluster">WCluster</a></li><li><a href="global.html#cluster">cluster</a></li></ul>
 </nav>
 <div id="main">
@@ -68,7 +71,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Aug 04 2022 08:38:41 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Mar 29 2023 11:09:40 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>