@gmod/hclust

中文文档
6.0.0发布于 2026/09/16MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2.6万

等级组合

中文使用文档
文档目录11 节
  1. 安装
  2. 算法
  3. 使用量
  4. 结果
  5. 投入
  6. 预计算距离
  7. 其他出口
  8. 进展
  9. 取消
  10. 参考资料
  11. 说明

@gmod/hclette (英语)

快速分级分组( UPGMA) 编译到 WebAsembly JavaScript/TypeScript 绑定.

安装

npm install @gmod/hclust

算法

具有平均联系的群集。 计算欧几里得的距离, 然后在每个步骤合并最接近的集群,直到一个集群被保留, 生成一个德德克拉姆。 相当于R级 hclust(method="average")。 。 。 .

大约O(N2)在时间和记忆中:3 000个样本集群在~0.3s和10 000个 ~5.5s (英语). 与许多捆绑相距的输入速度要慢得多,因为捆绑迫使 重新扫描最近新邻居: 3 202行, 仅包含9个不同值 一共用了27道 3,202道单行取了0.36道 原子弹堆积为2GB并持有 nxN 相距矩阵( 400MB at N= 10,000) 旁的 NxV 输入, 所以矩阵 无法共享的二者在信件中被拒绝在前面同时大小。 见 文件/优化 事情进展得这么快.

使用量

import { clusterObject, toNewick, fromNewick } from '@gmod/hclust'

const result = await clusterObject({
  data: {
    'Sample A': [1.0, 2.0, 3.0],
    'Sample B': [1.5, 2.5, 3.5],
    'Sample C': [10.0, 11.0, 12.0],
  },
})

const newick = toNewick(result.tree)
const tree = fromNewick(newick)

clusterData 如果有单独的数组,也可以使用:

import { clusterData } from '@gmod/hclust'

const result = await clusterData({
  data: [
    [1.0, 2.0, 3.0],
    [1.5, 2.5, 3.5],
    [10.0, 11.0, 12.0],
  ],
  sampleLabels: ['Sample A', 'Sample B', 'Sample C'],
})

行可以是平面数组或打出数组——任何东西 ArrayLike<number>。 。 。 .

结果

  • tree: ClusterNode ——德德克勒克根. 叶子有 height 0和无 children。 。 。 .
  • order: number[] ——以从左到右叶排列的样本指数.
  • clustersGivenK: number[][][] —— 说 clustersGivenK[k] 分区为 k+1 组合,每组一组抽样指数。 它的每个级别 因此,它花费了O(N2)内存(~330MB at N=3000),并建立在第一个之上 而不是在前面进入。 需要的时候就别管了 tree 财务报告和审定财务报表 order。 。 。 .

投入

  • 至少2个样本,或 clusterData 掷出.
  • 每行长度与第一行相同,或 clusterData 丢出命名 排队.
  • 没有 NaN 或者说 Infinity,或 clusterData 掷出.
  • 2GB 内的 NxV×4 + N2×4 字节,或 clusterData 丢出之前 分配任何东西。 飞来飞去,一分一分 无法与其他人说出有多少人.
  • 无 sampleLabels,叶子回来作为 Sample 0, (中文(简体) ), Sample 1,, , , , , , , ,

预计算距离

过 distances 改为 data 将别处创建的矩阵组合成一组——在一个 GPU, 或者在另一个度量标准下 :

const result = await clusterData({
  distances, // Float32Array, N×N row-major
  sampleLabels,
})

仅读取上三角形(栏 >行),因此制作人可以离开 对角和下半个未设置。 运行跳过相距阶段而去 直接到合并循环,所以 onProgress 只报告 init 财务报告和审定财务报表 clustering非正方形的矩阵,或 NaN 或者说 Infinity, (中文(简体) ), 掷出. 它被组合在一起,而不是在计算出来的矩阵之外 堆积的预算是 N2×4 字节.

其他出口

  • toNewick(node) 编号 : fromNewick(string) — Newick 序列化, 写入合并 高度为 : 分支长度( e)(A:1.5,B:1.5)) (中文(简体) ). fromNewick 读回来 输入绝对高度, 并仍然接受所写的标签格式 v4 (单位:千美元)(A,B)1.5000) (中文(简体) ). 见 文件/新ick.md。 。 。 .
  • quoteName(name) - Newick引用规则 toNewick 用途,导出为 给自己写Newick的呼唤者以同样的方式逃出名字 fromNewick 期待着.
  • treeToJSON(node) —一棵树的平面对象副本,空投 children。 。 。 .
  • printTree(node) —— ASCII Dendrogram,用于调试.

进展

过 onProgress 以观察运行。 每100米报告最多一次,所以 小跑步只可能发出 init 阶段 :

clusterData({
  data,
  onProgress: ({ phase, message, current, total }) => {
    // phase: 'init' | 'distance' | 'clustering'
    // 'init' carries no denominator (total === 0) — render it indeterminate
    const label = total
      ? `${message}: ${Math.round((current / total) * 100)}%`
      : message
    console.log(label)
  },
})

message 是未格式化相标签,并且 current编号 :total 是生数,所以 来电者可以开一个固定的 进度条,关闭它们.

取消

通过一个 AbortSignal数字 :

const controller = new AbortController()
const run = clusterData({ data, signal: controller.signal })
controller.abort() // run rejects with the signal's reason

跑步以大约50米的片子进行 并产生一个任务,所以 流产在大约50米以内的土地,包括张贴在网络工人身上的一幅 信息,运行释放了它持有的一切。 一个已经中止的信号 在任何工作开始前就拒绝 两跑在飞行中,一瞬间切入 切开。 见 文件/注销 为工人和如何 每个环境都会产生.

参考资料

说明

在Claude Code AI的帮助下,你也许能够从 某种机器人文档

版本与发布记录

@gmod/hclust 共发布 33 个版本,首次发布于 2025/11/22;过去 12 个月发布了 33 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.0.0latest2026/09/162 个月前
5.3.02026/09/082 个月前
5.2.02026/09/072 个月前
5.1.02026/08/252 个月前
5.0.02026/08/172 个月前
4.1.12026/08/163 个月前

关于 @gmod/hclust 的常见问题

@gmod/hclust 是什么?

等级组合

如何安装 @gmod/hclust?

在项目目录运行 npm install @gmod/hclust,或使用 pnpm add / yarn add / bun add。

@gmod/hclust 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gmod/hclust 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gmod/hclust 可以商用吗?

@gmod/hclust 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gmod/hclust 的下载量有多少?

根据 npm 官方下载统计,@gmod/hclust 在 2026/10/17 – 2026/11/15 这 30 天内被下载 25,759 次,日均约 859 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gmod/hclust 还在维护吗?

最新版本 6.0.0 发布于 2026/09/16(2 个月前);至今共发布 33 个版本,其中过去 12 个月发布了 33 个;首次发布于 2025/11/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。