Package org.neo4j.gds.paths.dijkstra

Class Dijkstra

java.lang.Object

org.neo4j.gds.Algorithm<DijkstraResult>

org.neo4j.gds.paths.dijkstra.Dijkstra

public final class Dijkstra
extends org.neo4j.gds.Algorithm<DijkstraResult>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Dijkstra.HeuristicFunction
static interface	Dijkstra.RelationshipFilter
static interface	Dijkstra.TraversalPredicate

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESCRIPTION_SOURCE_TARGET

Fields inherited from class org.neo4j.gds.Algorithm

progressTracker, terminationFlag

Method Summary

Modifier and Type	Method	Description
DijkstraResult	compute()
static org.neo4j.gds.core.utils.mem.MemoryEstimation	memoryEstimation(boolean trackRelationships)
void	release()
void	resetTraversalState()
static Dijkstra	singleSource(org.neo4j.gds.api.Graph graph, AllShortestPathsBaseConfig config, java.util.Optional<Dijkstra.HeuristicFunction> heuristicFunction, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)	Configure Dijkstra to compute all single-source shortest path.
static Dijkstra	sourceTarget(org.neo4j.gds.api.Graph graph, ShortestPathBaseConfig config, java.util.Optional<Dijkstra.HeuristicFunction> heuristicFunction, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)	Configure Dijkstra to compute at most one source-target shortest path.
Dijkstra	withRelationshipFilter(Dijkstra.RelationshipFilter relationshipFilter)
Dijkstra	withSourceNode(long sourceNode)

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

DESCRIPTION_SOURCE_TARGET

public static final java.lang.String DESCRIPTION_SOURCE_TARGET

See Also:

Constant Field Values

Method Detail

sourceTarget

public static Dijkstra sourceTarget(org.neo4j.gds.api.Graph graph,
                                    ShortestPathBaseConfig config,
                                    java.util.Optional<Dijkstra.HeuristicFunction> heuristicFunction,
                                    org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Configure Dijkstra to compute at most one source-target shortest path.

singleSource

public static Dijkstra singleSource(org.neo4j.gds.api.Graph graph,
                                    AllShortestPathsBaseConfig config,
                                    java.util.Optional<Dijkstra.HeuristicFunction> heuristicFunction,
                                    org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Configure Dijkstra to compute all single-source shortest path.

memoryEstimation

public static org.neo4j.gds.core.utils.mem.MemoryEstimation memoryEstimation(boolean trackRelationships)

withSourceNode

public Dijkstra withSourceNode(long sourceNode)

withRelationshipFilter

public Dijkstra withRelationshipFilter(Dijkstra.RelationshipFilter relationshipFilter)

resetTraversalState

public void resetTraversalState()

compute

public DijkstraResult compute()

Specified by:

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

release

public void release()

Specified by:

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