Package org.neo4j.gds.louvain

Class Louvain

  • public final class Louvain
extends org.neo4j.gds.Algorithm<Louvain>

    • Field Summary

      • Fields inherited from class org.neo4j.gds.Algorithm

        progressTracker, terminationFlag

    • Constructor Summary

      Constructors 
      Constructor Description
      Louvain​(org.neo4j.gds.api.Graph graph, LouvainBaseConfig config, boolean trackIntermediateCommunities, int maxLevels, int maxIterations, double tolerance, int concurrency, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker, java.util.concurrent.ExecutorService executorService)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Louvain compute()  
      org.neo4j.gds.core.utils.paged.HugeLongArray[] dendrograms()  
      org.neo4j.gds.core.utils.paged.HugeLongArray finalDendrogram()  
      long[] getCommunities​(long nodeId)  
      long getCommunity​(long nodeId)  
      int levels()  
      double[] modularities()  
      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

    • Constructor Detail

      • Louvain

        public Louvain​(org.neo4j.gds.api.Graph graph,
               LouvainBaseConfig config,
               boolean trackIntermediateCommunities,
               int maxLevels,
               int maxIterations,
               double tolerance,
               int concurrency,
               org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker,
               java.util.concurrent.ExecutorService executorService)

    • Method Detail

      • compute

        public Louvain compute()
        Specified by:
        compute in class org.neo4j.gds.Algorithm<Louvain>

      • dendrograms

        public org.neo4j.gds.core.utils.paged.HugeLongArray[] dendrograms()

      • finalDendrogram

        public org.neo4j.gds.core.utils.paged.HugeLongArray finalDendrogram()

      • getCommunity

        public long getCommunity​(long nodeId)

      • getCommunities

        public long[] getCommunities​(long nodeId)

      • levels

        public int levels()

      • modularities

        public double[] modularities()

      • release

        public void release()
        Specified by:
        release in class org.neo4j.gds.Algorithm<Louvain>