org.neo4j.graphalgo.shortestpaths

Class KShortestPathsProc

java.lang.Object

org.neo4j.graphalgo.BaseProc

org.neo4j.graphalgo.AlgoBaseProc<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>

org.neo4j.graphalgo.shortestpaths.KShortestPathsProc

public class KShortestPathsProc
extends org.neo4j.graphalgo.AlgoBaseProc<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>

Yen's K shortest paths algorithm. Computes multiple shortest paths from a given start to a goal node in the desired direction. The paths are written to the graph using new relationships named by prefix + index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KShortestPathsProc.KspResult
static class	KShortestPathsProc.KspStreamResult

Nested classes/interfaces inherited from class org.neo4j.graphalgo.AlgoBaseProc

org.neo4j.graphalgo.AlgoBaseProc.ComputationResult<A extends org.neo4j.graphalgo.Algorithm<A,RESULT>,RESULT,CONFIG extends org.neo4j.graphalgo.config.AlgoBaseConfig>

Nested classes/interfaces inherited from class org.neo4j.graphalgo.BaseProc

org.neo4j.graphalgo.BaseProc.FreeMemoryInspector

Field Summary

Fields inherited from class org.neo4j.graphalgo.AlgoBaseProc

STATS_DESCRIPTION

Fields inherited from class org.neo4j.graphalgo.BaseProc

api, callContext, ESTIMATE_DESCRIPTION, log, transaction

Constructor Summary

Constructors

Constructor and Description
KShortestPathsProc()

Method Summary

Modifier and Type	Method and Description
protected org.neo4j.graphalgo.AlgorithmFactory<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>	algorithmFactory(org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig config)
protected org.neo4j.graphalgo.api.Graph	createGraph(org.eclipse.collections.api.tuple.Pair<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig,java.util.Optional<java.lang.String>> configAndName)
protected org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig	newConfig(java.lang.String username, java.util.Optional<java.lang.String> graphName, java.util.Optional<org.neo4j.graphalgo.config.GraphCreateConfig> maybeImplicitCreate, org.neo4j.graphalgo.core.CypherMapWrapper config)
protected org.eclipse.collections.api.tuple.Pair<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig,java.util.Optional<java.lang.String>>	processInput(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,java.lang.Object> configuration)
java.util.stream.Stream<KShortestPathsProc.KspStreamResult>	stream(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,java.lang.Object> configuration)
java.util.stream.Stream<KShortestPathsProc.KspResult>	write(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,java.lang.Object> configuration)

Methods inherited from class org.neo4j.graphalgo.AlgoBaseProc

algoName, compute, compute, computeEstimate, memoryEstimation, newAlgorithm, newConfig, nodePropertyTranslator, validateConfigs

Methods inherited from class org.neo4j.graphalgo.BaseProc

getUsername, newLoader, runWithExceptionLogging, runWithExceptionLogging, tryValidateMemoryUsage, tryValidateMemoryUsage, validateConfig, validateGraphName

Methods inherited from class java.lang.Object

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

Constructor Detail

KShortestPathsProc

public KShortestPathsProc()

Method Detail

stream

public java.util.stream.Stream<KShortestPathsProc.KspStreamResult> stream(java.lang.Object graphNameOrConfig,
                                                                          java.util.Map<java.lang.String,java.lang.Object> configuration)

processInput

protected org.eclipse.collections.api.tuple.Pair<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig,java.util.Optional<java.lang.String>> processInput(java.lang.Object graphNameOrConfig,
                                                                                                                                                                    java.util.Map<java.lang.String,java.lang.Object> configuration)

Overrides:

processInput in class org.neo4j.graphalgo.AlgoBaseProc<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>

write

public java.util.stream.Stream<KShortestPathsProc.KspResult> write(java.lang.Object graphNameOrConfig,
                                                                   java.util.Map<java.lang.String,java.lang.Object> configuration)

newConfig

protected org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig newConfig(java.lang.String username,
                                                                                    java.util.Optional<java.lang.String> graphName,
                                                                                    java.util.Optional<org.neo4j.graphalgo.config.GraphCreateConfig> maybeImplicitCreate,
                                                                                    org.neo4j.graphalgo.core.CypherMapWrapper config)

Specified by:

newConfig in class org.neo4j.graphalgo.AlgoBaseProc<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>

createGraph

protected org.neo4j.graphalgo.api.Graph createGraph(org.eclipse.collections.api.tuple.Pair<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig,java.util.Optional<java.lang.String>> configAndName)

Overrides:

createGraph in class org.neo4j.graphalgo.AlgoBaseProc<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>

algorithmFactory

protected org.neo4j.graphalgo.AlgorithmFactory<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig> algorithmFactory(org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig config)

Specified by:

algorithmFactory in class org.neo4j.graphalgo.AlgoBaseProc<org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPaths,org.neo4j.graphalgo.impl.shortestpaths.YensKShortestPathsConfig>