Measurement Sessions

Back to Helios Network Native C API

Steppable native measurement sessions for long-running algorithms.

function CXConnectedComponentsSessionCreate Creates a steppable connected-components session. function CXConnectedComponentsSessionDestroy Releases all resources held by a connected-components session. function CXConnectedComponentsSessionFinalize Finalizes a completed session, copying per-node component ids into `outNodeComponent` (length >= nodeCapacity). function CXConnectedComponentsSessionGetProgress Returns current progress metrics. Any output pointer may be NULL. function CXConnectedComponentsSessionStep Advances the session by at most `budget` node-visits (best effort). function CXCorenessSessionCreate Creates a steppable coreness session. function CXCorenessSessionDestroy Releases all resources held by a coreness session. function CXCorenessSessionFinalize Finalizes a completed session, copying per-node coreness values into `outNodeCoreness` (length >= nodeCapacity). function CXCorenessSessionGetProgress Returns current progress metrics. Any output pointer may be NULL. function CXCorenessSessionStep Advances the session by at most `budget` peeled nodes (best effort). function CXLeidenSessionCreate Creates a steppable Leiden session. The network topology and relevant edge weight attribute must not change while the session is active. Returns NULL on failure. function CXLeidenSessionDestroy Releases all resources held by a Leiden session. function CXLeidenSessionFinalize Finalizes a completed session, writing the resulting community ids into a node attribute of type `CXUnsignedIntegerAttributeType` (dimension 1). Returns CXFalse if the session has not completed or on failure. function CXLeidenSessionGetProgress Returns current progress metrics. Any output pointer may be NULL. `outProgressCurrent` and `outProgressTotal` are best-effort and may change as the algorithm advances (i.e. the total may be revised). function CXLeidenSessionStep Advances the session by at most `budget` node-visits (best effort). Returns the current phase after stepping.