Package org.neo4j.gds

Class Algorithm<ME extends Algorithm<ME,​RESULT>,​RESULT>

  • All Implemented Interfaces:
    org.neo4j.gds.core.utils.TerminationFlag
    Direct Known Subclasses:
    ScaleProperties
    public abstract class Algorithm<ME extends Algorithm<ME,​RESULT>,​RESULT>
extends java.lang.Object
implements org.neo4j.gds.core.utils.TerminationFlag

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker  
      protected org.neo4j.gds.core.utils.TerminationFlag terminationFlag  

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

        RUN_CHECK_NODE_COUNT, RUNNING_TRUE

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Algorithm​(org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract RESULT compute()  
      org.neo4j.gds.core.utils.progress.tasks.ProgressTracker getProgressTracker()  
      org.neo4j.gds.core.utils.TerminationFlag getTerminationFlag()  
      abstract ME me()  
      abstract void release()
      Release internal data structures used by the algorithm.
      boolean running()  
      ME withTerminationFlag​(org.neo4j.gds.core.utils.TerminationFlag terminationFlag)  

      • Methods inherited from class java.lang.Object

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

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

        assertRunning

    • Field Detail

      • progressTracker

        protected final org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker

      • terminationFlag

        protected org.neo4j.gds.core.utils.TerminationFlag terminationFlag

    • Constructor Detail

      • Algorithm

        protected Algorithm​(org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

    • Method Detail

      • compute

        public abstract RESULT compute()

      • me

        public abstract ME me()

      • release

        public abstract void release()
        Release internal data structures used by the algorithm.

      • withTerminationFlag

        public ME withTerminationFlag​(org.neo4j.gds.core.utils.TerminationFlag terminationFlag)

      • getTerminationFlag

        public org.neo4j.gds.core.utils.TerminationFlag getTerminationFlag()

      • getProgressTracker

        public org.neo4j.gds.core.utils.progress.tasks.ProgressTracker getProgressTracker()

      • running

        public boolean running()
        Specified by:
        running in interface org.neo4j.gds.core.utils.TerminationFlag