com.graphhopper.storage

Interface CHGraph

All Superinterfaces:

Graph

All Known Implementing Classes:

CHGraphImpl

public interface CHGraph
extends Graph

Extended graph interface which supports Contraction Hierarchies. Ie. storing and retrieving the levels for a node and creating shortcuts, which are additional 'artificial' edges to speedup traversal in certain cases.

Author:

Peter Karich

Method Summary

Modifier and Type	Method and Description
CHEdgeExplorer	createEdgeExplorer()
CHEdgeExplorer	createEdgeExplorer(EdgeFilter filter) Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node.
EdgeExplorer	createOriginalEdgeExplorer()
EdgeExplorer	createOriginalEdgeExplorer(EdgeFilter filter)
void	disconnect(CHEdgeExplorer edgeExplorer, EdgeIteratorState edgeState) Disconnects the edges (higher to lower node) via the specified edgeState pointing from lower to higher node.
AllCHEdgesIterator	getAllEdges()
CHProfile	getCHProfile() Returns the profile of this CH graph.
CHEdgeIteratorState	getEdgeIteratorState(int edgeId, int endNode) Returns a wrapper over the specified edgeId.
int	getLevel(int nodeId)
NodeOrderingProvider	getNodeOrderingProvider()
int	getOriginalEdges()
boolean	isReadyForContraction()
boolean	isShortcut(int edgeId)
void	setLevel(int nodeId, int level) This methods sets the level of the specified node.
int	shortcut(int a, int b, int accessFlags, double weight, double distance, int skippedEdge1, int skippedEdge2) This method creates a shortcut between a to b which is nearly identical to creating an edge except that it can be excluded or included for certain traversals or algorithms.
int	shortcutEdgeBased(int a, int b, int accessFlags, double weight, double distance, int skippedEdge1, int skippedEdge2, int origFirst, int origLast) like shortcut(), but for edge-based CH

Methods inherited from interface com.graphhopper.storage.Graph

copyTo, edge, edge, getBaseGraph, getBounds, getEdges, getExtension, getNodeAccess, getNodes, getOtherNode, isAdjacentToNode

Method Detail

setLevel

void setLevel(int nodeId,
              int level)

This methods sets the level of the specified node.

getLevel

int getLevel(int nodeId)

Returns:

the level of the specified node. The higher the more important the node is. Virtual nodes have the biggest level associated.

getCHProfile

CHProfile getCHProfile()

Returns the profile of this CH graph. This is used to identify the CH graph.

isShortcut

boolean isShortcut(int edgeId)

shortcut

int shortcut(int a,
             int b,
             int accessFlags,
             double weight,
             double distance,
             int skippedEdge1,
             int skippedEdge2)

This method creates a shortcut between a to b which is nearly identical to creating an edge except that it can be excluded or included for certain traversals or algorithms.

shortcutEdgeBased

int shortcutEdgeBased(int a,
                      int b,
                      int accessFlags,
                      double weight,
                      double distance,
                      int skippedEdge1,
                      int skippedEdge2,
                      int origFirst,
                      int origLast)

like shortcut(), but for edge-based CH

getEdgeIteratorState

CHEdgeIteratorState getEdgeIteratorState(int edgeId,
                                         int endNode)

Description copied from interface: Graph

Returns a wrapper over the specified edgeId.

Specified by:

getEdgeIteratorState in interface Graph

endNode - is the node that will be returned via adjNode(). If adjNode is Integer.MIN_VALUE then the edge will be returned in the direction of how it is stored

Returns:

an edge iterator state or potentially null if adjNode does not match

createEdgeExplorer

CHEdgeExplorer createEdgeExplorer()

Specified by:

createEdgeExplorer in interface Graph

See Also:

Graph.createEdgeExplorer(com.graphhopper.routing.util.EdgeFilter)

createEdgeExplorer

CHEdgeExplorer createEdgeExplorer(EdgeFilter filter)

Description copied from interface: Graph

Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node. Reduce calling this method as much as possible, e.g. create an explorer before a for loop!

Specified by:

createEdgeExplorer in interface Graph

See Also:

EdgeExplorer, Graph.createEdgeExplorer()

createOriginalEdgeExplorer

EdgeExplorer createOriginalEdgeExplorer()

createOriginalEdgeExplorer

EdgeExplorer createOriginalEdgeExplorer(EdgeFilter filter)

getAllEdges

AllCHEdgesIterator getAllEdges()

Specified by:

getAllEdges in interface Graph

Returns:

all edges in this graph, where baseNode will be the smaller node.

disconnect

void disconnect(CHEdgeExplorer edgeExplorer,
                EdgeIteratorState edgeState)

Disconnects the edges (higher to lower node) via the specified edgeState pointing from lower to higher node.

Parameters:

edgeState - the edge from lower to higher

getOriginalEdges

int getOriginalEdges()

Returns:

the number of original edges in this graph (without shortcuts)

getNodeOrderingProvider

NodeOrderingProvider getNodeOrderingProvider()

isReadyForContraction

boolean isReadyForContraction()

Returns:

true if contraction can be started (add shortcuts and set levels), false otherwise