Package org.neo4j.graphalgo.louvain

Class Louvain

  • All Implemented Interfaces:
    org.neo4j.graphalgo.core.utils.TerminationFlag
    public final class Louvain
extends org.neo4j.graphalgo.Algorithm<Louvain,​Louvain>

    • Field Summary

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

        progressLogger, terminationFlag

      • Fields inherited from interface org.neo4j.graphalgo.core.utils.TerminationFlag

        RUN_CHECK_NODE_COUNT, RUNNING_TRUE

    • Constructor Summary

      Constructors 
      Constructor Description
      Louvain​(org.neo4j.graphalgo.api.Graph graph, LouvainBaseConfig config, java.util.concurrent.ExecutorService executorService, org.neo4j.graphalgo.core.utils.ProgressLogger progressLogger, org.neo4j.graphalgo.core.utils.paged.AllocationTracker tracker)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Louvain compute()  
      LouvainBaseConfig config()  
      org.neo4j.graphalgo.core.utils.paged.HugeLongArray[] dendrograms()  
      org.neo4j.graphalgo.core.utils.paged.HugeLongArray finalDendrogram()  
      long[] getCommunities​(long nodeId)  
      long getCommunity​(long nodeId)  
      int levels()  
      Louvain me()  
      double[] modularities()  
      void release()  

      • Methods inherited from class org.neo4j.graphalgo.Algorithm

        getProgressLogger, getTerminationFlag, running, withProgressLogger, withTerminationFlag

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.neo4j.graphalgo.core.utils.TerminationFlag

        assertRunning

    • Constructor Detail

      • Louvain

        public Louvain​(org.neo4j.graphalgo.api.Graph graph,
               LouvainBaseConfig config,
               java.util.concurrent.ExecutorService executorService,
               org.neo4j.graphalgo.core.utils.ProgressLogger progressLogger,
               org.neo4j.graphalgo.core.utils.paged.AllocationTracker tracker)

    • Method Detail

      • compute

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

      • dendrograms

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

      • finalDendrogram

        public org.neo4j.graphalgo.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.graphalgo.Algorithm<Louvain,​Louvain>