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.

Constructor Summary

Constructors

Constructor and Description
GHUtility()

Method Summary

Modifier and Type	Method and Description
static void	addRandomTurnCosts(Graph graph, long seed, BooleanEncodedValue accessEnc, DecimalEncodedValue turnCostEnc, 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 void	checkDAVersion(String name, int expectedVersion, int version)
static int	count(EdgeIterator iter) Counts reachable edges.
static int	count(EdgeIterator iterator, int adj)
static int	count(RoutingCHEdgeIterator iter)
static BBox	createBBox(EdgeIteratorState edgeState)
static int	createEdgeKey(int edgeId, boolean isLoop, boolean reverse) Creates an edge key, i.e.
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 EdgeIteratorState	getEdge(Graph graph, int base, int adj)
static int	getEdgeFromEdgeKey(int edgeKey)
static List<Integer>	getEdgeIds(EdgeIterator iter)
static CustomArea	getFirstDuplicateArea(List<CustomArea> areas, String id)
static Set<Integer>	getNeighbors(EdgeIterator iter)
static Set<Integer>	getNeighbors(RoutingCHEdgeIterator iter)
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 BaseGraph	newGraph(BaseGraph baseGraph) Create a new storage from the specified one without copying the data.
static void	printGraphForUnitTest(Graph g, BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc)
static void	printGraphForUnitTest(Graph g, BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, BBox bBox)
static double	randomDoubleInRange(Random rnd, double min, double max)
static List<CustomArea>	readCountries() Reads the country borders from the countries.geojson resource file
static int	reverseEdgeKey(int edgeKey) Returns the edgeKey of the opposite direction, be careful not to use this for loops!
static void	runConcurrently(Stream<Callable<String>> callables, int threads)
static EdgeIteratorState	setSpeed(double averageSpeed, boolean fwd, boolean bwd, BooleanEncodedValue accessEnc, DecimalEncodedValue avSpeedEnc, EdgeIteratorState edge)
static void	setSpeed(double fwdSpeed, double bwdSpeed, BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, Collection<EdgeIteratorState> edges)
static void	setSpeed(double fwdSpeed, double bwdSpeed, BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, EdgeIteratorState... edges)
static IntsRef	setSpeed(double fwdSpeed, double bwdSpeed, BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, 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.

count

public static int count(RoutingCHEdgeIterator iter)

asSet

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

getNeighbors

public static Set<Integer> getNeighbors(RoutingCHEdgeIterator iter)

getNeighbors

public static Set<Integer> getNeighbors(EdgeIterator iter)

getEdgeIds

public static List<Integer> getEdgeIds(EdgeIterator iter)

printGraphForUnitTest

public static void printGraphForUnitTest(Graph g,
                                         BooleanEncodedValue accessEnc,
                                         DecimalEncodedValue speedEnc)

printGraphForUnitTest

public static void printGraphForUnitTest(Graph g,
                                         BooleanEncodedValue accessEnc,
                                         DecimalEncodedValue speedEnc,
                                         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,
                                      BooleanEncodedValue accessEnc,
                                      DecimalEncodedValue turnCostEnc,
                                      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)

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

newGraph

public static BaseGraph newGraph(BaseGraph baseGraph)

Create a new storage from the specified one without copying the data. CHGraphs won't be copied.

getAdjNode

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

checkDAVersion

public static void checkDAVersion(String name,
                                  int expectedVersion,
                                  int version)

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 the edge between base and adj, or null if there is no such edge

Throws:

IllegalArgumentException - when there are multiple edges

count

public static int count(EdgeIterator iterator,
                        int adj)

Returns:

the number of edges with the given adj node

createEdgeKey

public static int createEdgeKey(int edgeId,
                                boolean isLoop,
                                boolean reverse)

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

reverseEdgeKey

public static int reverseEdgeKey(int edgeKey)

Returns the edgeKey of the opposite direction, be careful not to use this for loops!

getEdgeFromEdgeKey

public static int getEdgeFromEdgeKey(int edgeKey)

Returns:

edge ID for edgeKey

setSpeed

public static IntsRef setSpeed(double fwdSpeed,
                               double bwdSpeed,
                               BooleanEncodedValue accessEnc,
                               DecimalEncodedValue speedEnc,
                               IntsRef edgeFlags)

setSpeed

public static void setSpeed(double fwdSpeed,
                            double bwdSpeed,
                            BooleanEncodedValue accessEnc,
                            DecimalEncodedValue speedEnc,
                            EdgeIteratorState... edges)

setSpeed

public static void setSpeed(double fwdSpeed,
                            double bwdSpeed,
                            BooleanEncodedValue accessEnc,
                            DecimalEncodedValue speedEnc,
                            Collection<EdgeIteratorState> edges)

setSpeed

public static EdgeIteratorState setSpeed(double averageSpeed,
                                         boolean fwd,
                                         boolean bwd,
                                         BooleanEncodedValue accessEnc,
                                         DecimalEncodedValue avSpeedEnc,
                                         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)

readCountries

public static List<CustomArea> readCountries()

Reads the country borders from the countries.geojson resource file

getFirstDuplicateArea

public static CustomArea getFirstDuplicateArea(List<CustomArea> areas,
                                               String id)

runConcurrently

public static void runConcurrently(Stream<Callable<String>> callables,
                                   int threads)

createBBox

public static BBox createBBox(EdgeIteratorState edgeState)