com.sparsity.sparksee.algorithms

Class SinglePairShortestPathDijkstraDynamicCost

java.lang.Object

com.sparsity.sparksee.algorithms.SinglePairShortestPathDijkstraDynamicCost

public class SinglePairShortestPathDijkstraDynamicCost
extends java.lang.Object

Defines how to calculate an edge weight.

This is an interface which must be implemented by the user. While the algorithm is running, one or more calls for each edge that can be in the shortest path will be issued to get the weight of the edge that could change based on the predecessor node and the current minimum path from the source.

Author:

Sparsity Technologies http://www.sparsity-technologies.com

Method Summary

Modifier and Type	Method and Description
double	calculateEdgeCost(long sourceNode, double sourceCost, int sourceLevel, long targetNode, long edge, int edgeWeightAttr) Dynamic calculation of an edge weight.

Methods inherited from class java.lang.Object

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

Method Detail

calculateEdgeCost

public double calculateEdgeCost(long sourceNode,
                                double sourceCost,
                                int sourceLevel,
                                long targetNode,
                                long edge,
                                int edgeWeightAttr)

Dynamic calculation of an edge weight.

This method will be called several times during the algorithm execution. It can be called for the same edge multiple times because the path to the source node (and as a consequence the source weight and levels) might change while the algorithm is running. This method will have the normal default implementation that only uses the specified edge attribute to get the weight or the unweighted edge cost if the edge doesn't have the specified cost attribute. But it can be overriden in a derived user class to implement a dinamic edge weight, that may need the sourceCost and sourceLevels to calculate the weight. Returns the current weight of the edge (>=0) or <0 if the edge can not be used.

Parameters:

sourceNode - [in] The current node

sourceCost - [in] Current total cost up to the source node

sourceLevel - [in] Current path size up to the source node

targetNode - [in] The next node

edge - [in] The edge to the next node that this methos must weight

edgeWeightAttr - [in] The attribute that stores the edge weight or InvalidAttribute

Returns:

Returns the current weight of the edge (>=0) or <0 if the edge can not be used.