LabelPropagationClusteringResult

Show Usages

Represents clusters in the graph as computed by LabelPropagationClustering.

Inheritance Hierarchy

Remarks

This class cannot be instantiated

Members

No filters for this type

Properties

clusters

: ResultItemCollection<Cluster>

readonly

Gets a collection of all clusters in the graph.

readonlyfinal

finalLabels

: ResultItemMapping<INode, number>

readonly

Gets a mapping from each node to its label.

The value corresponds to the calculated (final) label. For nodes which are not associated with a cluster the index is -1. Also, if a subgraph is specified, all nodes that are not part of the subgraph have the label -1.

The labels which are considered in this algorithm are internally assigned integer values. They have nothing to do with the marking objects which are commonly referred to as "label" in yFiles for HTML.

readonlyfinal

modularity

: number

readonly

Gets a value that estimates the quality of the partition of the nodes into the clusters.

The modularity value estimates the quality of the partition of the nodes into the given communities and is a value between [-1/2,1]. High modularity values denote that nodes with dense connections are placed in the same community, while nodes with sparse connections are assigned to different communities.

readonlyfinal

nodeClusterIds

: ResultItemMapping<INode, number>

readonly

Gets a mapping from each node to its cluster ID.

The value corresponds to the index of the associated cluster in clusters. For nodes which are not associated with a cluster, the index is -1. Also, if a subgraph is specified, all nodes that are not part of the subgraph have the ID -1.

readonlyfinal

nodeClusters

: ResultItemMapping<INode, Cluster>

readonly

Gets a mapping from each node to its cluster.

readonlyfinal