CHGraph (GraphHopper Core 2.4 API)

All Known Implementing Classes:

CHGraphImpl
```
public interface CHGraph
```
Graph structure used for Contraction Hierarchies. It allows 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CHEdgeExplorer`	`createEdgeExplorer()`
`CHEdgeExplorer`	`createEdgeExplorer(EdgeFilter filter)`
`EdgeExplorer`	`createOriginalEdgeExplorer()`
`EdgeExplorer`	`createOriginalEdgeExplorer(EdgeFilter filter)`
`AllCHEdgesIterator`	`getAllEdges()`
`Graph`	`getBaseGraph()`
`CHConfig`	`getCHConfig()` Returns the profile of this CH graph.
`CHEdgeIteratorState`	`getEdgeIteratorState(int edgeId, int endNode)`
`int`	`getEdges()`
`int`	`getLevel(int nodeId)`
`NodeOrderingProvider`	`getNodeOrderingProvider()`
`int`	`getNodes()`
`int`	`getOriginalEdges()`
`int`	`getOtherNode(int edge, int node)`
`boolean`	`isAdjacentToNode(int edge, int node)`
`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, 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, int skippedEdge1, int skippedEdge2, int origFirst, int origLast)` like shortcut(), but for edge-based CH

- 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.
  - getCHConfig
```
CHConfig getCHConfig()
```
    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,
             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,
                      int skippedEdge1,
                      int skippedEdge2,
                      int origFirst,
                      int origLast)
```
    like shortcut(), but for edge-based CH
    
    Parameters:
    
    origFirst - The first original edge that is skipped by this shortcut. For example for the following shortcut edge from x to y, which itself skips the shortcuts x->v and v->y the first original edge would be x->u: x->u->v->w->y
    
    origLast - like origFirst, but the last orig edge, i.e w->y in above example
  - getEdgeIteratorState
```
CHEdgeIteratorState getEdgeIteratorState(int edgeId,
                                         int endNode)
```
  - createEdgeExplorer
```
CHEdgeExplorer createEdgeExplorer()
```
  - createEdgeExplorer
```
CHEdgeExplorer createEdgeExplorer(EdgeFilter filter)
```
  - createOriginalEdgeExplorer
```
EdgeExplorer createOriginalEdgeExplorer()
```
  - createOriginalEdgeExplorer
```
EdgeExplorer createOriginalEdgeExplorer(EdgeFilter filter)
```
  - getAllEdges
```
AllCHEdgesIterator getAllEdges()
```
  - 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
  - getBaseGraph
```
Graph getBaseGraph()
```
  - getNodes
```
int getNodes()
```
  - getEdges
```
int getEdges()
```
    Returns:
    
    the number of edges (including shortcuts) in this graph. Equivalent to getAllEdges().length().
  - getOtherNode
```
int getOtherNode(int edge,
                 int node)
```
    Returns:
    
    the 'opposite' node of a given edge, so if there is an edge 3-2 and node =2 this returns 3
  - isAdjacentToNode
```
boolean isAdjacentToNode(int edge,
                         int node)
```
    Returns:
    
    true if the edge with id edge is adjacent to node, false otherwise

Interface CHGraph

Method Summary

Method Detail

setLevel

getLevel

getCHConfig

isShortcut

shortcut

shortcutEdgeBased

getEdgeIteratorState

createEdgeExplorer

createEdgeExplorer

createOriginalEdgeExplorer

createOriginalEdgeExplorer

getAllEdges

getOriginalEdges

getNodeOrderingProvider

isReadyForContraction

getBaseGraph

getNodes

getEdges

getOtherNode

isAdjacentToNode