Classes
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) → (nullable) {Int32Array|Int32WasmArray}
- Source:
Parameters:
Name | Type | Attributes | Default | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
{}
|
Optional parameters. Properties
|
Returns:
Array containing the cluster membership for each cell.
Alternatively null
, if fillable = false
and the array was not already filled.
- Type
- Int32Array | Int32WasmArray
modularity() → (nullable) {number}
- Source:
Returns:
The quality of the Leiden clustering.
Alternatively null
, if this has not been set by setModularity
.
Note that Leiden's quality score is technically a different measure from modularity.
Nonetheless, we use modularity
for consistency with the other SNN clustering result classes.
- Type
- number
setModularity(modularity)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
modularity |
number | Modularity value. |
Returns:
Modularity value is set in this object.
This is typically used after calling emptyClusterSnnGraphResults
.