com.graphhopper.util

Class GHUtility

java.lang.Object

com.graphhopper.util.GHUtility

public class GHUtility
extends Object

A helper class to avoid cluttering the Graph interface with all the common methods. Most of the methods are useful for unit tests or debugging only.

Author:

Peter Karich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHUtility.DisabledEdgeIterator This edge iterator can be used in tests to mock specific iterator behaviour via overloading certain methods.
static class	GHUtility.DisabledNodeAccess This node access can be used in tests to mock specific iterator behaviour via overloading certain methods.

Constructor Summary

Constructors

Constructor and Description
GHUtility()

Method Summary

Modifier and Type	Method and Description
static void	addRandomTurnCosts(Graph graph, long seed, EncodingManager em, FlagEncoder encoder, int maxTurnCost, TurnCostStorage turnCostStorage)
static Set<Integer>	asSet(int... values)
static void	buildRandomGraph(Graph graph, Random random, int numNodes, double meanDegree, boolean allowLoops, boolean allowZeroDistance, BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, Double speed, double pNonZeroLoop, double pBothDir, double pRandomDistanceOffset)
static long	calcMillisWithTurnMillis(Weighting weighting, EdgeIteratorState edgeState, boolean reverse, int prevOrNextEdgeId)
static double	calcWeightWithTurnWeight(Weighting weighting, EdgeIteratorState edgeState, boolean reverse, int prevOrNextEdgeId) Calculates the weight of a given edge like Weighting.calcEdgeWeight(com.graphhopper.util.EdgeIteratorState, boolean) and adds the transition cost (the turn weight, Weighting.calcTurnWeight(int, int, int)) associated with transitioning from/to the edge with ID prevOrNextEdgeId.
static double	calcWeightWithTurnWeightWithAccess(Weighting weighting, EdgeIteratorState edgeState, boolean reverse, int prevOrNextEdgeId)
static Graph	copyTo(Graph fromGraph, Graph toGraph)
static int	count(EdgeIterator iter) Counts reachable edges.
static BBox	createBBox(EdgeIteratorState edgeState)
static int	createEdgeKey(int edgeId, boolean reverse) Creates an edge key, i.e.
static int	createEdgeKey(int nodeA, int nodeB, int edgeId, boolean reverse) Creates unique positive number for specified edgeId taking into account the direction defined by nodeA, nodeB and reverse.
static EdgeIteratorState	createMockedEdgeIteratorState(double distance, IntsRef flags)
static EdgeIteratorState	createMockedEdgeIteratorState(double distance, IntsRef flags, int base, int adj, int edge, int origFirst, int origLast)
static List<Snap>	createRandomSnaps(BBox bbox, LocationIndex locationIndex, Random rnd, int numPoints, boolean acceptTower, EdgeFilter filter)
static int	getAdjNode(Graph g, int edge, int adjNode)
static double	getDistance(int from, int to, NodeAccess nodeAccess)
static CHEdgeIteratorState	getEdge(CHGraph graph, int base, int adj)
static EdgeIteratorState	getEdge(Graph graph, int base, int adj)
static int	getEdgeFromEdgeKey(int edgeKey)
static List<Integer>	getEdgeIds(EdgeIterator iter)
static Set<Integer>	getNeighbors(EdgeIterator iter)
static String	getNodeInfo(CHGraph g, int nodeId, EdgeFilter filter)
static String	getNodeInfo(Graph g, int nodeId, EdgeFilter filter)
static List<String>	getProblems(Graph g) This method could throw an exception if problems like index out of bounds etc
static Snap	getRandomSnap(LocationIndex locationIndex, Random rnd, BBox bbox, EdgeFilter filter)
static boolean	isSameEdgeKeys(int edgeKey1, int edgeKey2) Returns if the specified edgeKeys (created by createEdgeKey) are identical regardless of the direction.
static GraphHopperStorage	newStorage(GraphHopperStorage store) Create a new storage from the specified one without copying the data.
static void	printEdgeInfo(Graph g, FlagEncoder encoder)
static void	printGraphForUnitTest(Graph g, FlagEncoder encoder)
static void	printGraphForUnitTest(Graph g, FlagEncoder encoder, BBox bBox)
static void	printInfo(Graph g, int startNode, int counts, EdgeFilter filter)
static double	randomDoubleInRange(Random rnd, double min, double max)
static int	reverseEdgeKey(int edgeKey) Returns the edgeKey of the opposite direction
static EdgeIteratorState	setSpeed(double averageSpeed, boolean fwd, boolean bwd, FlagEncoder encoder, EdgeIteratorState edge)
static void	setSpeed(double fwdSpeed, double bwdSpeed, FlagEncoder encoder, Collection<EdgeIteratorState> edges)
static void	setSpeed(double fwdSpeed, double bwdSpeed, FlagEncoder encoder, EdgeIteratorState... edges)
static IntsRef	setSpeed(double fwdSpeed, double bwdSpeed, FlagEncoder encoder, IntsRef edgeFlags)
static Graph	shuffle(Graph g, Graph sortedGraph)
static Graph	sortDFS(Graph g, Graph sortedGraph) Sorts the graph according to depth-first search traversal.
static void	updateDistancesFor(Graph g, int node, double lat, double lon)

Methods inherited from class java.lang.Object

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

Constructor Detail

GHUtility

public GHUtility()

Method Detail

getProblems

public static List<String> getProblems(Graph g)

This method could throw an exception if problems like index out of bounds etc

count

public static int count(EdgeIterator iter)

Counts reachable edges.

asSet

public static Set<Integer> asSet(int... values)

getNeighbors

public static Set<Integer> getNeighbors(EdgeIterator iter)

getEdgeIds

public static List<Integer> getEdgeIds(EdgeIterator iter)

printEdgeInfo

public static void printEdgeInfo(Graph g,
                                 FlagEncoder encoder)

printGraphForUnitTest

public static void printGraphForUnitTest(Graph g,
                                         FlagEncoder encoder)

printGraphForUnitTest

public static void printGraphForUnitTest(Graph g,
                                         FlagEncoder encoder,
                                         BBox bBox)

buildRandomGraph

public static void buildRandomGraph(Graph graph,
                                    Random random,
                                    int numNodes,
                                    double meanDegree,
                                    boolean allowLoops,
                                    boolean allowZeroDistance,
                                    BooleanEncodedValue accessEnc,
                                    DecimalEncodedValue speedEnc,
                                    Double speed,
                                    double pNonZeroLoop,
                                    double pBothDir,
                                    double pRandomDistanceOffset)

Parameters:

speed - if null a random speed will be assign to every edge

getDistance

public static double getDistance(int from,
                                 int to,
                                 NodeAccess nodeAccess)

addRandomTurnCosts

public static void addRandomTurnCosts(Graph graph,
                                      long seed,
                                      EncodingManager em,
                                      FlagEncoder encoder,
                                      int maxTurnCost,
                                      TurnCostStorage turnCostStorage)

createRandomSnaps

public static List<Snap> createRandomSnaps(BBox bbox,
                                           LocationIndex locationIndex,
                                           Random rnd,
                                           int numPoints,
                                           boolean acceptTower,
                                           EdgeFilter filter)

getRandomSnap

public static Snap getRandomSnap(LocationIndex locationIndex,
                                 Random rnd,
                                 BBox bbox,
                                 EdgeFilter filter)

randomDoubleInRange

public static double randomDoubleInRange(Random rnd,
                                         double min,
                                         double max)

printInfo

public static void printInfo(Graph g,
                             int startNode,
                             int counts,
                             EdgeFilter filter)

getNodeInfo

public static String getNodeInfo(CHGraph g,
                                 int nodeId,
                                 EdgeFilter filter)

getNodeInfo

public static String getNodeInfo(Graph g,
                                 int nodeId,
                                 EdgeFilter filter)

shuffle

public static Graph shuffle(Graph g,
                            Graph sortedGraph)

sortDFS

public static Graph sortDFS(Graph g,
                            Graph sortedGraph)

Sorts the graph according to depth-first search traversal. Other traversals have either no significant difference (bfs) for querying or are worse (z-curve).

copyTo

public static Graph copyTo(Graph fromGraph,
                           Graph toGraph)

Returns:

the specified toGraph which is now filled with data from fromGraph

newStorage

public static GraphHopperStorage newStorage(GraphHopperStorage store)

Create a new storage from the specified one without copying the data.

getAdjNode

public static int getAdjNode(Graph g,
                             int edge,
                             int adjNode)

createMockedEdgeIteratorState

public static EdgeIteratorState createMockedEdgeIteratorState(double distance,
                                                              IntsRef flags)

createMockedEdgeIteratorState

public static EdgeIteratorState createMockedEdgeIteratorState(double distance,
                                                              IntsRef flags,
                                                              int base,
                                                              int adj,
                                                              int edge,
                                                              int origFirst,
                                                              int origLast)

getEdge

public static EdgeIteratorState getEdge(Graph graph,
                                        int base,
                                        int adj)

Returns:

the first edge containing the specified nodes base and adj. Returns null if not found.

getEdge

public static CHEdgeIteratorState getEdge(CHGraph graph,
                                          int base,
                                          int adj)

createEdgeKey

public static int createEdgeKey(int nodeA,
                                int nodeB,
                                int edgeId,
                                boolean reverse)

Creates unique positive number for specified edgeId taking into account the direction defined by nodeA, nodeB and reverse.

createEdgeKey

public static int createEdgeKey(int edgeId,
                                boolean reverse)

Creates an edge key, i.e. an integer number that encodes an edge ID and the direction of an edge

isSameEdgeKeys

public static boolean isSameEdgeKeys(int edgeKey1,
                                     int edgeKey2)

Returns if the specified edgeKeys (created by createEdgeKey) are identical regardless of the direction.

reverseEdgeKey

public static int reverseEdgeKey(int edgeKey)

Returns the edgeKey of the opposite direction

getEdgeFromEdgeKey

public static int getEdgeFromEdgeKey(int edgeKey)

Returns:

edge ID for edgeKey

setSpeed

public static IntsRef setSpeed(double fwdSpeed,
                               double bwdSpeed,
                               FlagEncoder encoder,
                               IntsRef edgeFlags)

setSpeed

public static void setSpeed(double fwdSpeed,
                            double bwdSpeed,
                            FlagEncoder encoder,
                            EdgeIteratorState... edges)

setSpeed

public static void setSpeed(double fwdSpeed,
                            double bwdSpeed,
                            FlagEncoder encoder,
                            Collection<EdgeIteratorState> edges)

setSpeed

public static EdgeIteratorState setSpeed(double averageSpeed,
                                         boolean fwd,
                                         boolean bwd,
                                         FlagEncoder encoder,
                                         EdgeIteratorState edge)

updateDistancesFor

public static void updateDistancesFor(Graph g,
                                      int node,
                                      double lat,
                                      double lon)

calcWeightWithTurnWeightWithAccess

public static double calcWeightWithTurnWeightWithAccess(Weighting weighting,
                                                        EdgeIteratorState edgeState,
                                                        boolean reverse,
                                                        int prevOrNextEdgeId)

calcWeightWithTurnWeight

public static double calcWeightWithTurnWeight(Weighting weighting,
                                              EdgeIteratorState edgeState,
                                              boolean reverse,
                                              int prevOrNextEdgeId)

Calculates the weight of a given edge like Weighting.calcEdgeWeight(com.graphhopper.util.EdgeIteratorState, boolean) and adds the transition cost (the turn weight, Weighting.calcTurnWeight(int, int, int)) associated with transitioning from/to the edge with ID prevOrNextEdgeId.

Parameters:

prevOrNextEdgeId - if reverse is false this has to be the previous edgeId, if true it has to be the next edgeId in the direction from start to end.

calcMillisWithTurnMillis

public static long calcMillisWithTurnMillis(Weighting weighting,
                                            EdgeIteratorState edgeState,
                                            boolean reverse,
                                            int prevOrNextEdgeId)

See Also:

calcWeightWithTurnWeight(Weighting, EdgeIteratorState, boolean, int)

createBBox

public static BBox createBBox(EdgeIteratorState edgeState)