@graphty/algorithms / index / TeraHacOptions

Interface: TeraHacOptions

Defined in: indexed/terahac.ts:7

Options of the index-based TeraHAC, matching the legacy teraHAC.

Properties

distanceThreshold?

readonly optional distanceThreshold?: number

Defined in: indexed/terahac.ts:16

Stop at the first merge whose linkage distance is above this. Default: no threshold.

---

linkage?

readonly optional linkage?: "single" | "complete" | "average" | "ward"

Defined in: indexed/terahac.ts:12

How the distance between two clusters is read from their members' pairwise distances: the minimum, the maximum, the mean, or ("ward") the mean of the squares; default "average".

---

maxNodes?

readonly optional maxNodes?: number

Defined in: indexed/terahac.ts:26

Refuse a graph of more nodes than this before allocating the n x n distance matrix (8 n^2 bytes), with a RangeError of code E_TOO_LARGE and params { nodeCount, maxNodes, bytes }. Default: no bound.

---

numClusters?

readonly optional numClusters?: number

Defined in: indexed/terahac.ts:14

Stop merging at this many clusters; a positive integer. Default: merge until one is left.

---

useGraphDistance?

readonly optional useGraphDistance?: boolean

Defined in: indexed/terahac.ts:21

Pairwise distance: hop count along out-arcs (true, the default), or 1 for an arc from the lower to the higher node index and 2 for none (false).