com.graphhopper.routing

Class AbstractBidirAlgo

java.lang.Object

com.graphhopper.routing.AbstractBidirAlgo

All Implemented Interfaces:

BidirRoutingAlgorithm, RoutingAlgorithm

Direct Known Subclasses:

AbstractBidirCHAlgo, AbstractNonCHBidirAlgo

public abstract class AbstractBidirAlgo
extends Object
implements BidirRoutingAlgorithm

Field Summary

Fields

Modifier and Type	Field and Description
protected SPTEntry	bestBwdEntry
protected SPTEntry	bestFwdEntry
protected double	bestWeight
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	fromOutEdge
protected int	maxVisitedNodes
protected int	to
protected int	toInEdge
protected TraversalMode	traversalMode
protected boolean	updateBestPath

Constructor Summary

Constructors

Constructor and Description
AbstractBidirAlgo(TraversalMode traversalMode)

Method Summary

Modifier and Type	Method and Description
protected boolean	bwdSearchCanBeStopped()
Path	calcPath(int from, int to) Calculates the best path between the specified nodes.
Path	calcPath(int from, int to, int fromOutEdge, int toInEdge) like RoutingAlgorithm.calcPath(int, int), but this method also allows to strictly restrict the edge the path will begin with and the edge it will end with.
List<Path>	calcPaths(int from, int to) Calculates multiple possibilities for a path.
protected void	checkAlreadyRun()
protected abstract SPTEntry	createStartEntry(int node, double weight, boolean reverse) Creates the root shortest path tree entry for the forward or backward search.
protected abstract Path	extractPath()
protected boolean	finished()
protected boolean	fromEntryCanBeSkipped()
protected boolean	fwdSearchCanBeStopped()
protected double	getCurrentFromWeight()
protected double	getCurrentToWeight()
protected int	getIncomingEdge(SPTEntry entry)
protected abstract double	getInEdgeWeight(SPTEntry entry)
String	getName()
protected abstract int	getOtherNode(int edge, int node)
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 boolean	isMaxVisitedNodesExceeded()
protected void	postInit(int from, int to)
protected abstract void	postInitFrom()
protected abstract void	postInitTo()
protected void	runAlgo()
void	setMaxVisitedNodes(int numberOfNodes) Limit the search to numberOfNodes.
protected void	setUpdateBestPath(boolean b)
protected boolean	toEntryCanBeSkipped()
protected void	updateBestPath(double edgeWeight, SPTEntry entry, int origEdgeIdForCH, int traversalId, boolean reverse)

Methods inherited from class java.lang.Object

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

Field Detail

traversalMode

protected final TraversalMode traversalMode

from

protected int from

to

protected int to

fromOutEdge

protected int fromOutEdge

toInEdge

protected int toInEdge

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

bestFwdEntry

protected SPTEntry bestFwdEntry

bestBwdEntry

protected SPTEntry bestBwdEntry

bestWeight

protected double bestWeight

maxVisitedNodes

protected int maxVisitedNodes

updateBestPath

protected boolean updateBestPath

finishedFrom

protected boolean finishedFrom

finishedTo

protected boolean finishedTo

Constructor Detail

AbstractBidirAlgo

public AbstractBidirAlgo(TraversalMode traversalMode)

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.

calcPaths

public List<Path> calcPaths(int from,
                            int to)

Description copied from interface: RoutingAlgorithm

Calculates multiple possibilities for a path.

Specified by:

calcPaths in interface RoutingAlgorithm

See Also:

RoutingAlgorithm.calcPath(int, int)

calcPath

public Path calcPath(int from,
                     int to)

Description copied from interface: RoutingAlgorithm

Calculates the best path between the specified nodes.

Specified by:

calcPath in interface RoutingAlgorithm

Returns:

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

calcPath

public Path calcPath(int from,
                     int to,
                     int fromOutEdge,
                     int toInEdge)

Description copied from interface: BidirRoutingAlgorithm

like RoutingAlgorithm.calcPath(int, int), but this method also allows to strictly restrict the edge the path will begin with and the edge it will end with.

Specified by:

calcPath in interface BidirRoutingAlgorithm

fromOutEdge - the edge id of the first edge of the path. using EdgeIterator.ANY_EDGE means not enforcing the first edge of the path

toInEdge - the edge id of the last edge of the path. using EdgeIterator.ANY_EDGE means not enforcing the last edge of the path

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 abstract void postInitFrom()

postInitTo

protected abstract void postInitTo()

runAlgo

protected void runAlgo()

finished

protected boolean finished()

updateBestPath

protected void updateBestPath(double edgeWeight,
                              SPTEntry entry,
                              int origEdgeIdForCH,
                              int traversalId,
                              boolean reverse)

getInEdgeWeight

protected abstract double getInEdgeWeight(SPTEntry entry)

getOtherNode

protected abstract int getOtherNode(int edge,
                                    int node)

getIncomingEdge

protected int getIncomingEdge(SPTEntry entry)

extractPath

protected abstract Path extractPath()

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.

Specified by:

getVisitedNodes in interface RoutingAlgorithm

setMaxVisitedNodes

public void setMaxVisitedNodes(int numberOfNodes)

Description copied from interface: RoutingAlgorithm

Limit the search to numberOfNodes. See #681

Specified by:

setMaxVisitedNodes in interface RoutingAlgorithm

checkAlreadyRun

protected void checkAlreadyRun()

getName

public String getName()

Specified by:

getName in interface RoutingAlgorithm

Returns:

name of this algorithm

isMaxVisitedNodesExceeded

protected boolean isMaxVisitedNodesExceeded()