nl.cwts.networkanalysis

Class IterativeCPMClusteringAlgorithm

java.lang.Object

nl.cwts.networkanalysis.CPMClusteringAlgorithm

nl.cwts.networkanalysis.IncrementalCPMClusteringAlgorithm

nl.cwts.networkanalysis.IterativeCPMClusteringAlgorithm

All Implemented Interfaces:

java.lang.Cloneable, ClusteringAlgorithm, IncrementalClusteringAlgorithm, QualityClusteringAlgorithm

Direct Known Subclasses:

FastLocalMovingAlgorithm, LeidenAlgorithm, LouvainAlgorithm

public abstract class IterativeCPMClusteringAlgorithm
extends IncrementalCPMClusteringAlgorithm

Abstract base class for iterative clustering algorithms that use the CPM quality function.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_N_ITERATIONS Default number of iterations.
protected int	nIterations Number of iterations.

Fields inherited from class nl.cwts.networkanalysis.CPMClusteringAlgorithm

DEFAULT_RESOLUTION, resolution

Constructor Summary

Constructors

Constructor and Description
IterativeCPMClusteringAlgorithm() Constructs an iterative CPM clustering algorithm.
IterativeCPMClusteringAlgorithm(double resolution, int nIterations) Constructs an iterative CPM clustering algorithm with a specified resolution parameter and number of iterations.

Method Summary

Modifier and Type	Method and Description
int	getNIterations() Returns the number of iterations.
boolean	improveClustering(Network network, Clustering clustering) Improves a clustering of the nodes in a network.
protected abstract boolean	improveClusteringOneIteration(Network network, Clustering clustering) Improves a clustering by performing one iteration of an iterative clustering algorithm.
void	setNIterations(int nIterations) Sets the number of iterations.

Methods inherited from class nl.cwts.networkanalysis.IncrementalCPMClusteringAlgorithm

findClustering

Methods inherited from class nl.cwts.networkanalysis.CPMClusteringAlgorithm

calcQuality, clone, getResolution, removeCluster, removeSmallClustersBasedOnNNodes, removeSmallClustersBasedOnWeight, setResolution

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_N_ITERATIONS

public static final int DEFAULT_N_ITERATIONS

Default number of iterations.

See Also:

Constant Field Values

nIterations

protected int nIterations

Number of iterations.

Constructor Detail

IterativeCPMClusteringAlgorithm

public IterativeCPMClusteringAlgorithm()

Constructs an iterative CPM clustering algorithm.

IterativeCPMClusteringAlgorithm

public IterativeCPMClusteringAlgorithm(double resolution,
                                       int nIterations)

Constructs an iterative CPM clustering algorithm with a specified resolution parameter and number of iterations.

Parameters:

resolution - Resolution parameter

nIterations - Number of iterations

Method Detail

getNIterations

public int getNIterations()

Returns the number of iterations.

Returns:

Number of iterations

setNIterations

public void setNIterations(int nIterations)

Sets the number of iterations.

Parameters:

nIterations - Number of iterations

improveClustering

public boolean improveClustering(Network network,
                                 Clustering clustering)

Improves a clustering of the nodes in a network.

If the number of iterations nIterations is positive, the clustering is improved by making nIterations calls to improveClusteringOneIteration(Network network, Clustering clustering). If nIterations equals 0, calls to improveClusteringOneIteration(Network network, Clustering clustering) continue to be made until there has been a call that did not result in an improvement of the clustering.

Parameters:

network - Network

clustering - Clustering

Returns:

Boolean indicating whether the clustering has been improved

improveClusteringOneIteration

protected abstract boolean improveClusteringOneIteration(Network network,
                                                         Clustering clustering)

Improves a clustering by performing one iteration of an iterative clustering algorithm.

Parameters:

network - Network

clustering - Clustering

Returns:

Boolean indicating whether the clustering has been improved