Package org.neo4j.gds.modularityoptimization

Class ModularityOptimization

java.lang.Object

org.neo4j.gds.Algorithm<ModularityOptimization>

org.neo4j.gds.modularityoptimization.ModularityOptimization

public final class ModularityOptimization
extends org.neo4j.gds.Algorithm<ModularityOptimization>

Implementation of parallel modularity optimization based on: Lu, Hao, Mahantesh Halappanavar, and Ananth Kalyanaraman. "Parallel heuristics for scalable community detection." Parallel Computing 47 (2015): 19-37. https://arxiv.org/pdf/1410.1237.pdf

Field Summary

Fields

Modifier and Type	Field	Description
static int	K1COLORING_MAX_ITERATIONS

Fields inherited from class org.neo4j.gds.Algorithm

progressTracker, terminationFlag

Constructor Summary

Constructors

Constructor	Description
ModularityOptimization(org.neo4j.gds.api.Graph graph, int maxIterations, double tolerance, @Nullable org.neo4j.gds.api.properties.nodes.NodePropertyValues seedProperty, int concurrency, int minBatchSize, java.util.concurrent.ExecutorService executor, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Method Summary

Modifier and Type	Method	Description
org.neo4j.gds.api.properties.nodes.LongNodePropertyValues	asNodeProperties()
ModularityOptimization	compute()
boolean	didConverge()
long	getCommunityId(long nodeId)
int	getIterations()
double	getModularity()
void	release()

Methods inherited from class org.neo4j.gds.Algorithm

getProgressTracker, getTerminationFlag, setTerminationFlag

Methods inherited from class java.lang.Object

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

Field Detail

K1COLORING_MAX_ITERATIONS

public static final int K1COLORING_MAX_ITERATIONS

See Also:

Constant Field Values

Constructor Detail

ModularityOptimization

public ModularityOptimization(org.neo4j.gds.api.Graph graph,
                              int maxIterations,
                              double tolerance,
                              @Nullable
                              @Nullable org.neo4j.gds.api.properties.nodes.NodePropertyValues seedProperty,
                              int concurrency,
                              int minBatchSize,
                              java.util.concurrent.ExecutorService executor,
                              org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Method Detail

compute

public ModularityOptimization compute()

Specified by:

compute in class org.neo4j.gds.Algorithm<ModularityOptimization>

release

public void release()

Specified by:

release in class org.neo4j.gds.Algorithm<ModularityOptimization>

getCommunityId

public long getCommunityId(long nodeId)

getIterations

public int getIterations()

getModularity

public double getModularity()

didConverge

public boolean didConverge()

asNodeProperties

public org.neo4j.gds.api.properties.nodes.LongNodePropertyValues asNodeProperties()