Package org.neo4j.gds.scaling

Class ScalePropertiesFactory<CONFIG extends ScalePropertiesBaseConfig>

java.lang.Object

org.neo4j.gds.GraphAlgorithmFactory<ScaleProperties,CONFIG>

org.neo4j.gds.scaling.ScalePropertiesFactory<CONFIG>

All Implemented Interfaces:

AlgorithmFactory<org.neo4j.gds.api.Graph,ScaleProperties,CONFIG>

public final class ScalePropertiesFactory<CONFIG extends ScalePropertiesBaseConfig>
extends GraphAlgorithmFactory<ScaleProperties,CONFIG>

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.gds.AlgorithmFactory

AlgorithmFactory.Visitor<ALGO extends Algorithm<?>,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig>

Constructor Summary

Constructors

Constructor	Description
ScalePropertiesFactory()

Method Summary

Modifier and Type	Method	Description
ScaleProperties	build(org.neo4j.gds.api.Graph graph, CONFIG configuration, org.neo4j.gds.core.utils.mem.AllocationTracker allocationTracker, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)
org.neo4j.gds.core.utils.mem.MemoryEstimation	memoryEstimation(CONFIG configuration)	Returns an estimation about the memory consumption of that algorithm.
java.lang.String	taskName()	The name of the task.

Methods inherited from class org.neo4j.gds.GraphAlgorithmFactory

accept

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.AlgorithmFactory

build, progressTask

Constructor Detail

ScalePropertiesFactory

public ScalePropertiesFactory()

Method Detail

taskName

public java.lang.String taskName()

Description copied from interface: AlgorithmFactory

The name of the task. Typically the name of the algorithm, but Java type params are not good enough. Used for progress logging.

Returns:

the name of the task that logs progress

build

public ScaleProperties build(org.neo4j.gds.api.Graph graph,
                             CONFIG configuration,
                             org.neo4j.gds.core.utils.mem.AllocationTracker allocationTracker,
                             org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

memoryEstimation

public org.neo4j.gds.core.utils.mem.MemoryEstimation memoryEstimation(CONFIG configuration)

Description copied from interface: AlgorithmFactory

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.gds.core.GraphDimensions, int)