com.graphhopper.routing

Class AbstractBidirAlgo

java.lang.Object

com.graphhopper.routing.AbstractRoutingAlgorithm

com.graphhopper.routing.AbstractBidirAlgo

All Implemented Interfaces:

RoutingAlgorithm

Direct Known Subclasses:

AbstractBidirectionEdgeCHNoSOD, AStarBidirection, DijkstraBidirectionRef

public abstract class AbstractBidirAlgo
extends AbstractRoutingAlgorithm

Common subclass for bidirectional algorithms.

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
protected PathBidirRef	bestPath
protected com.carrotsearch.hppc.IntObjectMap<SPTEntry>	bestWeightMapFrom
protected com.carrotsearch.hppc.IntObjectMap<SPTEntry>	bestWeightMapOther
protected com.carrotsearch.hppc.IntObjectMap<SPTEntry>	bestWeightMapTo
protected SPTEntry	currFrom
protected SPTEntry	currTo
protected boolean	finishedFrom
protected boolean	finishedTo
protected int	from
protected int	to

Fields inherited from class com.graphhopper.routing.AbstractRoutingAlgorithm

additionalEdgeFilter, flagEncoder, graph, inEdgeExplorer, maxVisitedNodes, nodeAccess, outEdgeExplorer, traversalMode, weighting

Constructor Summary

Constructors

Constructor and Description
AbstractBidirAlgo(Graph graph, Weighting weighting, TraversalMode tMode)

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(EdgeIteratorState edge, SPTEntry currEdge, boolean reverse)
protected boolean	bwdSearchCanBeStopped()
Path	calcPath(int from, int to) Calculates the best path between the specified nodes.
protected double	calcWeight(EdgeIteratorState iter, SPTEntry currEdge, boolean reverse)
protected Path	createAndInitPath()
protected abstract SPTEntry	createEntry(EdgeIteratorState edge, int incEdge, double weight, SPTEntry parent, boolean reverse) Creates a new entry of the shortest path tree (a SPTEntry or one of its subclasses) during a dijkstra expansion.
protected abstract SPTEntry	createStartEntry(int node, double weight, boolean reverse) Creates the root shortest path tree entry for the forward or backward search.
protected Path	extractPath() To be overwritten from extending class.
protected boolean	finished() To be overwritten from extending class.
protected boolean	fromEntryCanBeSkipped()
protected boolean	fwdSearchCanBeStopped()
protected double	getCurrentFromWeight()
protected double	getCurrentToWeight()
protected int	getIncomingEdge(SPTEntry entry)
protected int	getOrigEdgeId(EdgeIteratorState edge, boolean reverse)
protected int	getTraversalId(EdgeIteratorState edge, int origEdgeId, boolean reverse)
int	getVisitedNodes() Returns the visited nodes after searching.
protected void	initCollections(int size)
protected void	initFrom(int from, double weight)
protected void	initTo(int to, double weight)
protected void	postInit(int from, int to)
protected void	postInitFrom()
protected void	postInitTo()
protected void	runAlgo()
protected void	setUpdateBestPath(boolean b)
protected boolean	toEntryCanBeSkipped()
protected void	updateBestPath(EdgeIteratorState edgeState, SPTEntry entry, int traversalId, boolean reverse)
protected void	updateEntry(SPTEntry entry, EdgeIteratorState edge, int edgeId, double weight, SPTEntry parent, boolean reverse)

Methods inherited from class com.graphhopper.routing.AbstractRoutingAlgorithm

accept, calcPaths, checkAlreadyRun, createEmptyPath, getName, isMaxVisitedNodesExceeded, setEdgeFilter, setMaxVisitedNodes, toString

Methods inherited from class java.lang.Object

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

Field Detail

from

protected int from

to

protected int to

bestWeightMapFrom

protected com.carrotsearch.hppc.IntObjectMap<SPTEntry> bestWeightMapFrom

bestWeightMapTo

protected com.carrotsearch.hppc.IntObjectMap<SPTEntry> bestWeightMapTo

bestWeightMapOther

protected com.carrotsearch.hppc.IntObjectMap<SPTEntry> bestWeightMapOther

currFrom

protected SPTEntry currFrom

currTo

protected SPTEntry currTo

bestPath

protected PathBidirRef bestPath

finishedFrom

protected boolean finishedFrom

finishedTo

protected boolean finishedTo

Constructor Detail

AbstractBidirAlgo

public AbstractBidirAlgo(Graph graph,
                         Weighting weighting,
                         TraversalMode tMode)

Method Detail

initCollections

protected void initCollections(int size)

createStartEntry

protected abstract SPTEntry createStartEntry(int node,
                                             double weight,
                                             boolean reverse)

Creates the root shortest path tree entry for the forward or backward search.

createEntry

protected abstract SPTEntry createEntry(EdgeIteratorState edge,
                                        int incEdge,
                                        double weight,
                                        SPTEntry parent,
                                        boolean reverse)

Creates a new entry of the shortest path tree (a SPTEntry or one of its subclasses) during a dijkstra expansion.

Parameters:

edge - the edge that is currently processed for the expansion

incEdge - the id of the edge that is incoming to the node the edge is pointed at. usually this is the same as edge.getEdge(), but for edge-based CH and in case edge is a shortcut incEdge is the original edge that is incoming to the node

weight - the weight the shortest path three entry should carry

parent - the parent entry of in the shortest path tree

reverse - true if we are currently looking at the backward search, false otherwise

calcPath

public Path calcPath(int from,
                     int to)

Description copied from interface: RoutingAlgorithm

Calculates the best path between the specified nodes.

Returns:

the path. Call the method found() to make sure that the path is valid.

createAndInitPath

protected Path createAndInitPath()

initFrom

protected void initFrom(int from,
                        double weight)

initTo

protected void initTo(int to,
                      double weight)

postInit

protected void postInit(int from,
                        int to)

postInitFrom

protected void postInitFrom()

postInitTo

protected void postInitTo()

runAlgo

protected void runAlgo()

finished

protected boolean finished()

Description copied from class: AbstractRoutingAlgorithm

To be overwritten from extending class. Should we make this available in RoutingAlgorithm interface?

Specified by:

finished in class AbstractRoutingAlgorithm

Returns:

true if finished.

updateBestPath

protected void updateBestPath(EdgeIteratorState edgeState,
                              SPTEntry entry,
                              int traversalId,
                              boolean reverse)

updateEntry

protected void updateEntry(SPTEntry entry,
                           EdgeIteratorState edge,
                           int edgeId,
                           double weight,
                           SPTEntry parent,
                           boolean reverse)

accept

protected boolean accept(EdgeIteratorState edge,
                         SPTEntry currEdge,
                         boolean reverse)

getOrigEdgeId

protected int getOrigEdgeId(EdgeIteratorState edge,
                            boolean reverse)

getIncomingEdge

protected int getIncomingEdge(SPTEntry entry)

getTraversalId

protected int getTraversalId(EdgeIteratorState edge,
                             int origEdgeId,
                             boolean reverse)

calcWeight

protected double calcWeight(EdgeIteratorState iter,
                            SPTEntry currEdge,
                            boolean reverse)

extractPath

protected Path extractPath()

Description copied from class: AbstractRoutingAlgorithm

To be overwritten from extending class. Should we make this available in RoutingAlgorithm interface?

Specified by:

extractPath in class AbstractRoutingAlgorithm

Returns:

true if finished.

fromEntryCanBeSkipped

protected boolean fromEntryCanBeSkipped()

fwdSearchCanBeStopped

protected boolean fwdSearchCanBeStopped()

toEntryCanBeSkipped

protected boolean toEntryCanBeSkipped()

bwdSearchCanBeStopped

protected boolean bwdSearchCanBeStopped()

getCurrentFromWeight

protected double getCurrentFromWeight()

getCurrentToWeight

protected double getCurrentToWeight()

setUpdateBestPath

protected void setUpdateBestPath(boolean b)

getVisitedNodes

public int getVisitedNodes()

Description copied from interface: RoutingAlgorithm

Returns the visited nodes after searching. Useful for debugging.