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.
AllCHEdgesIterator	getAllEdges()
CHEdgeIteratorState	getEdgeIteratorState(int edgeId, int endNode) Returns a wrapper over the specified edgeId.
int	getLevel(int nodeId)
boolean	isShortcut(int edgeId)
void	setLevel(int nodeId, int level) This methods sets the level of the specified node.
CHEdgeIteratorState	shortcut(int a, int b) 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.

Methods inherited from interface com.graphhopper.storage.Graph

copyTo, edge, edge, getBaseGraph, getBounds, getExtension, getNodeAccess, getNodes

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.

isShortcut

boolean isShortcut(int edgeId)

shortcut

CHEdgeIteratorState shortcut(int a,
                             int b)

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.

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 with uncertain values for adjNode and baseNode (two possibilities) will be returned.

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()

getAllEdges

AllCHEdgesIterator getAllEdges()

Specified by:

getAllEdges in interface Graph

Returns:

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