HeliosNetwork

class

Back to Helios Network JS/WASM API

Kind

class

Source

src/js/HeliosNetwork.js:3199

Description

High-level JavaScript wrapper around the Helios WASM network implementation. Manages lifetime, attribute registration, and buffer views.

Signature

export class HeliosNetwork extends BaseEventTarget {

Utilities

Additional public helpers that do not belong to a narrower API area.

measureLocalClusteringCoefficient(options = {}) → {{nodeIndices:Uint32Array, values:Float32Array, valuesByNode:Float32Array, direction:number, variant:number}}

Source: src/js/HeliosNetwork.js:9918

Measures local clustering coefficients.

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional
|variant	(number|string)	optional	'unweighted'	unweighted/onnela/newman
|edgeWeightAttribute	string|null	optional	null	Required for weighted variants.
|direction	(number|string)	optional	'both'	out/in/both
|nodes	Array<number>|TypedArray|null	optional	null	Optional node subset.
|outNodeAttribute	string|null	optional	null	Optional node attribute name to store local clustering values.

Returns

Type {nodeIndices:Uint32Array, values:Float32Array, valuesByNode:Float32Array, direction:number, variant:number}

Example

helios.measureLocalClusteringCoefficient({
  enabled: true,
});

measureCoreness(options = {}) → {{nodeIndices:Uint32Array, values:Uint32Array, valuesByNode:Uint32Array, direction:number, executionMode:number, maxCore:number}}

Source: src/js/HeliosNetwork.js:9972

Measures node coreness (k-core index).

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional
|direction	(number|string)	optional	'both'	out/in/both
|executionMode	(number|string)	optional	'single-thread'	auto/single-thread/parallel
|nodes	Array<number>|TypedArray|null	optional	null	Optional node subset.
|outNodeCorenessAttribute	string|null	optional	null	Optional node attribute name to store coreness.

Returns

Type {nodeIndices:Uint32Array, values:Uint32Array, valuesByNode:Uint32Array, direction:number, executionMode:number, maxCore:number}

Example

helios.measureCoreness({
  enabled: true,
});

createCorenessSession(options = {}) → {CorenessSession}

Source: src/js/HeliosNetwork.js:10042

Creates a steppable coreness session for incremental execution. Run session.step({budget}) in a loop until phase becomes 3 (done), then call session.finalize() to retrieve coreness values.

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional
|direction	(number|string)	optional	'both'	out/in/both
|executionMode	(number|string)	optional	'single-thread'	auto/single-thread/parallel
|nodes	Array<number>|TypedArray|null	optional	null	Optional node subset for finalize() return payload.
|outNodeCorenessAttribute	string|null	optional	null	Optional node attribute to write coreness in finalize().

Returns

Session handle.

Type CorenessSession

Example

helios.createCorenessSession({
  enabled: true,
});

createLeidenSession(options = {}) → {LeidenSession}

Source: src/js/HeliosNetwork.js:10762

Creates a steppable Leiden session for incremental execution. Run session.step({budget}) in a loop until phase becomes 5 (done), then call session.finalize() to write the output attribute.

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional
|resolution	number	optional	1	Modularity resolution parameter (gamma).
|edgeWeightAttribute	string|null	optional	null	Edge weight attribute name (dimension 1).
|seed	number	optional	0	RNG seed (0 uses a default seed).
|maxLevels	number	optional	32	Maximum aggregation levels.
|maxPasses	number	optional	8	Max local-moving passes per phase.
|passes	number	optional		Alias for maxPasses (passes takes precedence when both are set).
|outNodeCommunityAttribute	string	optional	'community'	Default output name for finalize().
|categoricalCommunities	boolean	optional	true	Store communities as categorical codes instead of integers.

Returns

Session handle.

Type LeidenSession

Example

helios.createLeidenSession({
  enabled: true,
});