hclust.d.ts

export type AgglomerationMethod =
  | 'single'
  | 'complete'
  | 'average'
  | 'upgma'
  | 'wpgma'
  | 'median'
  | 'wpgmc'
  | 'centroid'
  | 'upgmc'
  | 'ward'
  | 'ward2';

export interface AgnesOptions<T> {
  distanceFunction?: (a: T, b: T) => number;
  method?: AgglomerationMethod;
  isDistanceMatrix?: boolean;
}

// export interface DianaOptions<T> {
//   distanceFunction?: (a: T, b: T) => number;
// }

export class Cluster {
  children: Cluster[];
  height: number;
  size: number;
  index: number;
  isLeaf: boolean;
  cut: (threshold: number) => Cluster[];
  group: (groups: number) => Cluster;
  traverse: (cb: (cluster: Cluster) => void) => void;
  indices: () => number[];
}

export function agnes<T = number[]>(
  data: T[],
  options?: AgnesOptions<T>,
): Cluster;

// export function diana<T = number[]>(
//   data: T[],
//   options?: DianaOptions<T>,
// ): Cluster;