ClusterWalktrapResults

ClusterWalktrapResults

Wrapper around the walktrap clustering results on the Wasm heap, produced by clusterGraph.

Classes

ClusterWalktrapResults

Methods

free()

Source:
Returns:

Frees the memory allocated on the Wasm heap for this object. This invalidates this object and all references to it.

membership(optionsopt) → {Int32Array|Int32WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean | string <optional>
 true

Whether to copy the results from the Wasm heap, see possibleCopy.
Returns:

Array containing the cluster membership for each cell.

Type
Int32Array | Int32WasmArray

modularity(optionsopt) → {number}

Source:
Parameters:
Name Type Attributes Default Description
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
at number <optional>
<nullable>
 null

Index at which to extract the modularity. This can be any value from 0 to numberOfMergeSteps plus 1. Set to null to obtain the largest modularity across all merge steps.
Returns:

The modularity at the specified merge step, or the maximum modularity across all merge steps.

Type
number

numberOfMergeSteps() → {number}

Source:
Returns:

Number of merge steps used by the Walktrap algorithm.

Type
number