oracle.spatial.network.lod

Interface PairwiseShortestPaths

All Known Implementing Classes:

DefaultPairwiseShortestPaths, ParallelPairwiseShortestPaths

public interface PairwiseShortestPaths

A PairwiseShortestPaths is an algorithm to calculate the the pair-wise shortest paths between a set of candidate start points and end points.

Since:

11gR2

Method Summary

Modifier and Type	Method and Description
void	setNetworkAnalyst(NetworkAnalyst analyst) This method allows caller to pass the network analyst object to this pairwise shortest paths implementation, so that the algorithm can call the analysis functions provided by the network analyst, or access the network explorer associated with the network analyst.
double[][]	shortestPathCosts(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction) Returns the pair-wise shortest path cost between a set of candidate start points and end points.
Matrix<LogicalSubPath>	shortestPaths(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction) Returns the pair-wise shortest paths between a set of candidate start points and end points.
Matrix<LogicalLightSubPath>	shortestPathsLight(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction) Returns the pair-wise light weight shortest paths between a set of candidate start points and end points.
void	shortestPathsLight(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix, int direction, PairwisePathResultIO pathIO) Computes the pair-wise light weight shortest paths between a set of candidate start points and end points, and outputs the light weight paths via PairwisePathResultIO.

Method Detail

shortestPaths

Matrix<LogicalSubPath> shortestPaths(PointOnNet[][] startPoints,
                                     PointOnNet[][] endPoints,
                                     LODNetworkConstraint constraint,
                                     Matrix<java.lang.Integer> pairwiseMatrix,
                                     int direction)
                              throws LODNetworkException

Returns the pair-wise shortest paths between a set of candidate start points and end points.

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Returns:

Throws:

LODNetworkException

shortestPathsLight

Matrix<LogicalLightSubPath> shortestPathsLight(PointOnNet[][] startPoints,
                                               PointOnNet[][] endPoints,
                                               LODNetworkConstraint constraint,
                                               Matrix<java.lang.Integer> pairwiseMatrix,
                                               int direction)
                                        throws LODNetworkException

Returns the pair-wise light weight shortest paths between a set of candidate start points and end points.

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Returns:

Throws:

LODNetworkException

shortestPathsLight

void shortestPathsLight(PointOnNet[][] startPoints,
                        PointOnNet[][] endPoints,
                        LODNetworkConstraint constraint,
                        Matrix<java.lang.Integer> pairwiseMatrix,
                        int direction,
                        PairwisePathResultIO pathIO)
                 throws LODNetworkException

Computes the pair-wise light weight shortest paths between a set of candidate start points and end points, and outputs the light weight paths via PairwisePathResultIO.

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Throws:

LODNetworkException

shortestPathCosts

double[][] shortestPathCosts(PointOnNet[][] startPoints,
                             PointOnNet[][] endPoints,
                             LODNetworkConstraint constraint,
                             Matrix<java.lang.Integer> pairwiseMatrix,
                             int direction)
                      throws LODNetworkException

Returns the pair-wise shortest path cost between a set of candidate start points and end points. This method can be used when the caller is only interested in path costs. the light path results.

Parameters:

startPoints - array of start candidates

endPoints - array of end candidates

constraint - network constraint

pairwiseMatrix - a matrix that specifies for which pairs the shortest paths need to be computed. If the matrix element for pair (i, j) is set to 0, then the shortest path from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the shortest paths for all pairs must be computed.

Returns:

Throws:

LODNetworkException

setNetworkAnalyst

void setNetworkAnalyst(NetworkAnalyst analyst)

This method allows caller to pass the network analyst object to this pairwise shortest paths implementation, so that the algorithm can call the analysis functions provided by the network analyst, or access the network explorer associated with the network analyst. If network analyst is not needed by the algorithm, the algorithm can choose to do nothing with this method.