Package org.neo4j.graphalgo

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

java.lang.Object

org.neo4j.graphalgo.AlgorithmFactory<ALGO,CONFIG>

public abstract class AlgorithmFactory<ALGO extends Algorithm<ALGO,?>,CONFIG extends org.neo4j.graphalgo.config.AlgoBaseConfig>
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AlgorithmFactory()

Method Summary

Modifier and Type	Method	Description
abstract ALGO	build(org.neo4j.graphalgo.api.Graph graph, CONFIG configuration, org.neo4j.graphalgo.core.utils.paged.AllocationTracker tracker, org.neo4j.logging.Log log)
abstract org.neo4j.graphalgo.core.utils.mem.MemoryEstimation	memoryEstimation(CONFIG configuration)	Returns an estimation about the memory consumption of that algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmFactory

public AlgorithmFactory()

Method Detail

build

public abstract ALGO build(org.neo4j.graphalgo.api.Graph graph,
                           CONFIG configuration,
                           org.neo4j.graphalgo.core.utils.paged.AllocationTracker tracker,
                           org.neo4j.logging.Log log)

memoryEstimation

public abstract 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(GraphDimensions, int)