Package org.neo4j.graphalgo

Interface AlgorithmFactory<ALGO extends Algorithm<ALGO,​?>,​CONFIG extends org.neo4j.graphalgo.config.AlgoBaseConfig>

  • All Known Implementing Classes:
    AbstractAlgorithmFactory
    public interface AlgorithmFactory<ALGO extends Algorithm<ALGO,​?>,​CONFIG extends org.neo4j.graphalgo.config.AlgoBaseConfig>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ALGO build​(org.neo4j.graphalgo.api.Graph graph, CONFIG configuration, org.neo4j.graphalgo.core.utils.mem.AllocationTracker tracker, org.neo4j.logging.Log log, org.neo4j.graphalgo.core.utils.progress.ProgressEventTracker eventTracker)  
      org.neo4j.graphalgo.core.utils.mem.MemoryEstimation memoryEstimation​(CONFIG configuration)
      Returns an estimation about the memory consumption of that algorithm.

    • Method Detail

      • build

        ALGO build​(org.neo4j.graphalgo.api.Graph graph,
           CONFIG configuration,
           org.neo4j.graphalgo.core.utils.mem.AllocationTracker tracker,
           org.neo4j.logging.Log log,
           org.neo4j.graphalgo.core.utils.progress.ProgressEventTracker eventTracker)

      • memoryEstimation

        org.neo4j.graphalgo.core.utils.mem.MemoryEstimation memoryEstimation​(CONFIG configuration)
        Returns an estimation about the memory consumption of that algorithm. The memory estimation can be used to compute the actual consumption depending on GraphDimensions and concurrency.
        Returns:
        memory estimation
        See Also:
        MemoryEstimations, MemoryEstimation.estimate(org.neo4j.graphalgo.core.GraphDimensions, int)