w-cluster 1.0.42 → 1.0.43

package/docs/k-medoids_par_fasterpam.mjs.html

@@ -62,7 +62,7 @@ import { shuffle } from './initialization.mjs';
  * @param med - the list of medoids (mutated in place)
  * @param maxiter - the maximum number of iterations allowed
  * @param rng - random number generator for shuffling the input data
- * @returns { loss, assi, nIter, nSwaps }
+ * @returns {Object} { loss, assi, nIter, nSwaps }
  *
  * Panics (throws) when the dissimilarity matrix is not square, or k is 0 or larger than N.
  */
@@ -121,7 +121,7 @@ export function par_fasterpam(mat, med, maxiter, rng = Math.random) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sun Oct 11 2026 13:26:02 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.5</a> on Fri Oct 16 2026 11:52:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/k-medoids_par_silhouette.mjs.html

@@ -113,7 +113,7 @@ export function par_silhouette(mat, assi) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sun Oct 11 2026 13:26:02 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.5</a> on Fri Oct 16 2026 11:52:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/k-medoids_silhouette.mjs.html

@@ -57,7 +57,7 @@ import { arrayAdapter } from './arrayadapter.mjs';
  * @param mat - a pairwise distance matrix
  * @param assi - the cluster assignment
  * @param samples - whether to keep the individual samples, or not
- * @returns { sil, samples } where sil is the average silhouette and samples are
+ * @returns {Object} { sil, samples } where sil is the average silhouette and samples are
  *          the individual silhouette values (empty [] if samples = false)
  */
 export function silhouette(mat, assi, samples = false) {
@@ -121,7 +121,7 @@ export function silhouette(mat, assi, samples = false) {
  * @param mat - a pairwise distance matrix
  * @param meds - the medoid list
  * @param samples - whether to keep the individual samples, or not
- * @returns { sil, samples } where sil is the average medoid silhouette and
+ * @returns {Object} { sil, samples } where sil is the average medoid silhouette and
  *          samples are the individual values (empty [] if samples = false)
  */
 export function medoid_silhouette(mat, meds, samples = false) {
@@ -180,7 +180,7 @@ export function checked_div(x, y) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sun Oct 11 2026 13:26:02 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.5</a> on Fri Oct 16 2026 11:52:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/k-medoids_util.mjs.html

@@ -122,7 +122,7 @@ export function choose_medoid_within_partition(mat, assi, med, m) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sun Oct 11 2026 13:26:02 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.5</a> on Fri Oct 16 2026 11:52:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "w-cluster",
-  "version": "1.0.42",
+  "version": "1.0.43",
   "main": "dist/w-cluster.umd.js",
   "dependencies": {
     "k-medoids": "^1.0.8",

package/src/WCluster.mjs

@@ -11,6 +11,15 @@ import WClusterCore from './WClusterCore.mjs'
  * @param {Number} [opt.nCompNIPALS=2] 輸入指定降維的維度整數，不能超過數據的維度(各列有效元素數量)，預設2
  * @return {Promise} 回傳Promise，resolve回傳指定維數數值的陣列，reject回傳錯誤訊息
  * @example
+ *
+ * let mat = [
+ *     [40, 50, 60],
+ *     [50, 70, 60],
+ *     [80, 70, 90],
+ *     [50, 60, 80]
+ * ]
+ * let resMat = await WCluster.PCA(mat, { nCompNIPALS: 2 })
+ * console.log(resMat)
  */
 async function PCA(data, opt = {}) {
     return WPCAMat(data, opt)
@@ -31,6 +40,15 @@ async function PCA(data, opt = {}) {
  * @param {Number} [opt.seed] 輸入k-means隨機初始化種子整數，僅於mode為'k-means'時生效，給定則分群結果可重現，未提供時為隨機初始化
  * @return {Promise} 回傳Promise，resolve回傳分群後結果物件，keys代表分群有使用到的欄位，ginds代表分群後的指標陣列，gltdt代表分群後的物件陣列，gmat代表分群後的數據陣列(usePCA為true時為PCA降維後數據，可例如取最左2欄代表x,y繪製二維分佈圖；usePCA為false時為原始數據)，reject回傳錯誤訊息
  * @example
+ *
+ * let mat = [
+ *     [40, 50, 60],
+ *     [50, 70, 60],
+ *     [80, 70, 90],
+ *     [50, 60, 80]
+ * ]
+ * let res = await WCluster.cluster(mat, { mode: 'k-medoids', kNumber: 2, nCompNIPALS: 2 })
+ * console.log(res.ginds)
  */
 async function cluster(data, opt = {}) {
     try {

package/src/k-medoids/fasterpam.mjs

@@ -13,7 +13,7 @@ import { shuffle } from './initialization.mjs';
  * @param mat - a pairwise distance matrix
  * @param med - the list of medoids (mutated in place)
  * @param maxiter - the maximum number of iterations allowed
- * @returns { loss, assi, nIter, nSwaps }
+ * @returns {Object} { loss, assi, nIter, nSwaps }
  *
  * Panics (throws) when the dissimilarity matrix is not square, or k is 0 or larger than N.
  */
@@ -67,7 +67,7 @@ export function fasterpam(mat, med, maxiter) {
  * @param med - the list of medoids (mutated in place)
  * @param maxiter - the maximum number of iterations allowed
  * @param rng - random number generator for shuffling the input data
- * @returns { loss, assi, nIter, nSwaps }
+ * @returns {Object} { loss, assi, nIter, nSwaps }
  */
 export function rand_fasterpam(mat, med, maxiter, rng = Math.random) {
   mat = arrayAdapter(mat);

package/src/k-medoids/pam.mjs

@@ -11,7 +11,7 @@ import { initial_assignment, do_swap } from './fasterpam.mjs';
  * @param mat - a pairwise distance matrix
  * @param med - the list of medoids (mutated in place)
  * @param maxiter - the maximum number of iterations allowed
- * @returns { loss, assi, nIter, nSwaps }
+ * @returns {Object} { loss, assi, nIter, nSwaps }
  */
 export function pam_swap(mat, med, maxiter) {
   mat = arrayAdapter(mat);
@@ -27,7 +27,7 @@ export function pam_swap(mat, med, maxiter) {
  *
  * @param mat - a pairwise distance matrix
  * @param k - the number of medoids to pick
- * @returns { loss, assi, meds }
+ * @returns {Object} { loss, assi, meds }
  */
 export function pam_build(mat, k) {
   mat = arrayAdapter(mat);
@@ -51,7 +51,7 @@ export function pam_build(mat, k) {
  * @param mat - a pairwise distance matrix
  * @param k - the number of medoids to pick
  * @param maxiter - the maximum number of iterations allowed
- * @returns { loss, assi, meds, nIter, nSwaps }
+ * @returns {Object} { loss, assi, meds, nIter, nSwaps }
  */
 export function pam(mat, k, maxiter) {
   mat = arrayAdapter(mat);

package/src/k-medoids/pamsil.mjs

@@ -47,7 +47,7 @@ export function pamsil_swap(mat, med, maxiter) {
 
 /**
  * Main optimization function of PAMSIL, not exposed (use pamsil_swap or pamsil).
- * @returns {[number, number, number]} [loss, n_iter, n_swaps]
+ * @returns {Array<number>} [loss, n_iter, n_swaps]
  */
 function pamsil_optimize(mat, med, assi, maxiter) {
   const n = mat.len(), k = med.length;

package/src/k-medoids/par_fasterpam.mjs

@@ -15,7 +15,7 @@ import { shuffle } from './initialization.mjs';
  * @param med - the list of medoids (mutated in place)
  * @param maxiter - the maximum number of iterations allowed
  * @param rng - random number generator for shuffling the input data
- * @returns { loss, assi, nIter, nSwaps }
+ * @returns {Object} { loss, assi, nIter, nSwaps }
  *
  * Panics (throws) when the dissimilarity matrix is not square, or k is 0 or larger than N.
  */

package/src/k-medoids/silhouette.mjs

@@ -10,7 +10,7 @@ import { arrayAdapter } from './arrayadapter.mjs';
  * @param mat - a pairwise distance matrix
  * @param assi - the cluster assignment
  * @param samples - whether to keep the individual samples, or not
- * @returns { sil, samples } where sil is the average silhouette and samples are
+ * @returns {Object} { sil, samples } where sil is the average silhouette and samples are
  *          the individual silhouette values (empty [] if samples = false)
  */
 export function silhouette(mat, assi, samples = false) {
@@ -74,7 +74,7 @@ export function silhouette(mat, assi, samples = false) {
  * @param mat - a pairwise distance matrix
  * @param meds - the medoid list
  * @param samples - whether to keep the individual samples, or not
- * @returns { sil, samples } where sil is the average medoid silhouette and
+ * @returns {Object} { sil, samples } where sil is the average medoid silhouette and
  *          samples are the individual values (empty [] if samples = false)
  */
 export function medoid_silhouette(mat, meds, samples = false) {