Default resolution parameter.
Resolution parameter.
Random number generator.
Returns the resolution parameter.
Resolution parameter
Sets the resolution parameter.
Resolution parameter
Calculates the quality of a clustering using the CPM quality function.
The CPM quality function is given by
1 / (2 * m) * sum(d(c[i], c[j]) * (a[i][j] - resolution * n[i] *
n[j])),
where a[i][j] is the weight of the edge between nodes i and j,
n[i] is the weight of node i, m is the total edge weight, and
resolution is the resolutionparameter. The function d(c[i], c[j])
equals 1 if nodes i and j belong to the same cluster and 0 otherwise.
The sum is taken over all pairs of nodes i and j.
Modularity can be expressed in terms of CPM by setting n[i] equal to
the total weight of the edges between node i and its neighbors and by
rescaling the resolution parameter by 2 * m.
Network
Clustering
Quality of the clustering
Removes a cluster from a clustering by merging the cluster with another cluster. If a cluster has no connections with other clusters, it cannot be removed.
Network
Clustering
Cluster to be removed
Cluster with which the cluster to be removed has been merged, or -1 if the cluster could not be removed
Removes small clusters from a clustering. Clusters are merged until each cluster contains at least a certain minimum number of nodes.
Network
Clustering
Minimum number of nodes per cluster
Boolean indicating whether any clusters have been removed
Removes small clusters from a clustering. Clusters are merged until each cluster has at least a certain minimum total node weight.
The total node weight of a cluster equals the sum of the weights of the nodes belonging to the cluster.
Network
Clustering
Minimum total node weight of a cluster
Boolean indicating whether any clusters have been removed
Initializes an incremental CPM clustering algorithm with a specified resolution parameter.
Resolution parameter
Finds a clustering of the nodes in a network.
The clustering is obtained by calling improveClustering and by providing a singleton clustering as input to this method.
Network
Clustering
Initializes a standard local merging algorithm.
Random number generator
Initializes a standard local merging algorithm for a specified resolution parameter.
Resolution parameter
Random number generator
Clones the algorithm.
Cloned algorithm
Improves a clustering of the nodes in a network using the standard local moving algorithm.
The standard local moving algorithm iterates over the nodes in a network. A node is moved to the cluster that results in the largest increase in the quality function. If the current cluster assignment of the node is already optimal, the node is not moved. The algorithm continues iterating over the nodes in a network until no more nodes can be moved.
Network
Clustering
Boolean indicating whether the clustering has been improved
Constructs a standard local moving algorithm.
Generated using TypeDoc
Standard local moving algorithm.
The standard local moving algorithm iterates over the nodes in a network. A node is moved to the cluster that results in the largest increase in the quality function. If the current cluster assignment of the node is already optimal, the node is not moved. The algorithm continues iterating over the nodes in a network until no more nodes can be moved.
A fast variant of the standard local moving algorithm is provided by the FastLocalMovingAlgorithm.