com.graphhopper.routing.weighting

Interface Weighting

All Known Implementing Classes:

AbstractAdjustedWeighting, AbstractWeighting, AvoidEdgesWeighting, BlockAreaWeighting, CustomWeighting, FastestWeighting, PriorityWeighting, QueryGraphWeighting, ShortestWeighting, ShortFastestWeighting

public interface Weighting

Specifies how the best route is calculated. E.g. the fastest or shortest route.

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITE_U_TURN_COSTS

Method Summary

Modifier and Type	Method and Description
long	calcEdgeMillis(EdgeIteratorState edgeState, boolean reverse) This method calculates the time taken (in milli seconds) to travel along the specified edgeState.
double	calcEdgeWeight(EdgeIteratorState edgeState, boolean reverse) This method calculates the weight of a given EdgeIteratorState.
default double	calcEdgeWeightWithAccess(EdgeIteratorState edgeState, boolean reverse)
long	calcTurnMillis(int inEdge, int viaNode, int outEdge)
double	calcTurnWeight(int inEdge, int viaNode, int outEdge)
boolean	edgeHasNoAccess(EdgeIteratorState edgeState, boolean reverse)
double	getMinWeight(double distance) Used only for the heuristic estimation in A*
String	getName()
boolean	hasTurnCosts() This method can be used to check whether or not this weighting returns turn costs (or if they are all zero).

Field Detail

INFINITE_U_TURN_COSTS

static final int INFINITE_U_TURN_COSTS

See Also:

Constant Field Values

Method Detail

getMinWeight

double getMinWeight(double distance)

Used only for the heuristic estimation in A*

Returns:

minimal weight for the specified distance in meter. E.g. if you calculate the fastest way the return value is 'distance/max_velocity'

edgeHasNoAccess

boolean edgeHasNoAccess(EdgeIteratorState edgeState,
                        boolean reverse)

Returns:

true if the edge is not accessible in the given direction. Note that when false is returned it does **not** mean the weight is finite! But when true is returned the weight must be infinite as well.

calcEdgeWeight

double calcEdgeWeight(EdgeIteratorState edgeState,
                      boolean reverse)

This method calculates the weight of a given EdgeIteratorState. E.g. a high value indicates that the edge should be avoided during shortest path search. Make sure that this method is very fast and optimized as this is called potentially millions of times for one route or a lot more for nearly any preprocessing phase.

Parameters:

edgeState - the edge for which the weight should be calculated

reverse - if the specified edge is specified in reverse direction e.g. from the reverse case of a bidirectional search.

Returns:

the calculated weight with the specified velocity has to be in the range of 0 and +Infinity. Make sure your method does not return NaN which can e.g. occur for 0/0.

calcEdgeMillis

long calcEdgeMillis(EdgeIteratorState edgeState,
                    boolean reverse)

This method calculates the time taken (in milli seconds) to travel along the specified edgeState. It is typically used for post-processing and on only a few thousand edges.

calcTurnWeight

double calcTurnWeight(int inEdge,
                      int viaNode,
                      int outEdge)

calcTurnMillis

long calcTurnMillis(int inEdge,
                    int viaNode,
                    int outEdge)

hasTurnCosts

boolean hasTurnCosts()

This method can be used to check whether or not this weighting returns turn costs (or if they are all zero). This is sometimes needed to do safety checks as not all graph algorithms can be run edge-based and might yield wrong results when turn costs are applied while running node-based.

getName

String getName()

calcEdgeWeightWithAccess

default double calcEdgeWeightWithAccess(EdgeIteratorState edgeState,
                                        boolean reverse)