Package org.neo4j.gds.spanningtree

Class Prim

java.lang.Object

org.neo4j.gds.Algorithm<SpanningTree>

org.neo4j.gds.spanningtree.Prim

public class Prim
extends org.neo4j.gds.Algorithm<SpanningTree>

Sequential Single-Source minimum weight spanning tree algorithm (PRIM).

The algorithm computes the MST by traversing all nodes from a given startNodeId. It aggregates all transitions into a MinPriorityQueue and visits each (unvisited) connected node by following only the cheapest transition and adding it to a specialized form of undirected tree.

The algorithm also computes the minimum, maximum and sum of all weights in the MST.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.function.DoubleUnaryOperator	MAX_OPERATOR
static java.util.function.DoubleUnaryOperator	MIN_OPERATOR

Fields inherited from class org.neo4j.gds.Algorithm

progressTracker, terminationFlag

Constructor Summary

Constructors

Constructor	Description
Prim(org.neo4j.gds.api.Graph graph, java.util.function.DoubleUnaryOperator minMax, long startNodeId, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Method Summary

Modifier and Type	Method	Description
SpanningTree	compute()
SpanningTree	getSpanningTree()
void	release()

Methods inherited from class org.neo4j.gds.Algorithm

getProgressTracker, getTerminationFlag, setTerminationFlag

Methods inherited from class java.lang.Object

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

Field Detail

MAX_OPERATOR

public static final java.util.function.DoubleUnaryOperator MAX_OPERATOR

MIN_OPERATOR

public static final java.util.function.DoubleUnaryOperator MIN_OPERATOR

Constructor Detail

Prim

public Prim(org.neo4j.gds.api.Graph graph,
            java.util.function.DoubleUnaryOperator minMax,
            long startNodeId,
            org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Method Detail

compute

public SpanningTree compute()

Specified by:

compute in class org.neo4j.gds.Algorithm<SpanningTree>

getSpanningTree

public SpanningTree getSpanningTree()

release

public void release()

Specified by:

release in class org.neo4j.gds.Algorithm<SpanningTree>