NAG Library Routine Document

h03adf (shortestpath)

1
Purpose

h03adf finds the shortest path through a directed or undirected acyclic network using Dijkstra's algorithm.

2
Specification

Fortran Interface
Subroutine h03adf ( n, ns, ne, direct, nnz, d, irow, icol, splen, path, iwork, work, ifail)
Integer, Intent (In):: n, ns, ne, nnz, icol(nnz)
Integer, Intent (Inout):: irow(nnz), ifail
Integer, Intent (Out):: path(n), iwork(3*n+1)
Real (Kind=nag_wp), Intent (In):: d(nnz)
Real (Kind=nag_wp), Intent (Out):: splen, work(2*n)
Logical, Intent (In):: direct
C Header Interface
#include <nagmk26.h>
void  h03adf_ (const Integer *n, const Integer *ns, const Integer *ne, const logical *direct, const Integer *nnz, const double d[], Integer irow[], const Integer icol[], double *splen, Integer path[], Integer iwork[], double work[], Integer *ifail)

3
Description

h03adf attempts to find the shortest path through a directed or undirected acyclic network, which consists of a set of points called vertices and a set of curves called arcs that connect certain pairs of distinct vertices. An acyclic network is one in which there are no paths connecting a vertex to itself. An arc whose origin vertex is i and whose destination vertex is j can be written as ij. In an undirected network the arcs ij and ji are equivalent (i.e., ij), whereas in a directed network they are different. Note that the shortest path may not be unique and in some cases may not even exist (e.g., if the network is disconnected).
The network is assumed to consist of n vertices which are labelled by the integers 1,2,,n. The lengths of the arcs between the vertices are defined by the n by n distance matrix d, in which the element dij gives the length of the arc ij; dij=0 if there is no arc connecting vertices i and j (as is the case for an acyclic network when i=j). Thus the matrix D is usually sparse. For example, if n=4 and the network is directed, then
d= 0 d12 d13 d14 d21 0 d23 d24 d31 d32 0 d34 d41 d42 d43 0 .  
If the network is undirected, d is symmetric since dij=dji (i.e., the length of the arc ij the length of the arc ji).
The method used by h03adf is described in detail in Section 9.

4
References

Dijkstra E W (1959) A note on two problems in connection with graphs Numer. Math. 1 269–271

5
Arguments

1:     n – IntegerInput
On entry: n, the number of vertices.
Constraint: n2.
2:     ns – IntegerInput
3:     ne – IntegerInput
On entry: ns and ne, the labels of the first and last vertices, respectively, between which the shortest path is sought.
Constraints:
  • 1nsn;
  • 1nen;
  • nsne.
4:     direct – LogicalInput
On entry: indicates whether the network is directed or undirected.
direct=.TRUE.
The network is directed.
direct=.FALSE.
The network is undirected.
5:     nnz – IntegerInput
On entry: the number of nonzero elements in the distance matrix D.
Constraints:
  • if direct=.TRUE., 1nnzn×n-1;
  • if direct=.FALSE., 1nnzn×n-1/2.
6:     dnnz – Real (Kind=nag_wp) arrayInput
On entry: the nonzero elements of the distance matrix D, ordered by increasing row index and increasing column index within each row. More precisely, dk must contain the value of the nonzero element with indices (irowk,icolk); this is the length of the arc from the vertex with label irowk to the vertex with label icolk. Elements with the same row and column indices are not allowed. If direct=.FALSE., then only those nonzero elements in the strict upper triangle of d need be supplied since dij=dji. (f11zaf may be used to sort the elements of an arbitrarily ordered matrix into the required form. This is illustrated in Section 10.)
Constraint: dk>0.0, for k=1,2,,nnz.
7:     irownnz – Integer arrayInput
8:     icolnnz – Integer arrayInput
On entry: irowk and icolk must contain the row and column indices, respectively, for the nonzero element stored in dk.
Constraints:
irow and icol must satisfy the following constraints (which may be imposed by a call to f11zaf):
  • irowk-1<irowk;
  • irowk-1=irowk and icolk-1<icolk, for k=2,3,,nnz.
In addition, if direct=.TRUE., 1irowkn, 1icolkn and irowkicolk;
  • if direct=.FALSE., 1irowk<icolkn.
9:     splen – Real (Kind=nag_wp)Output
On exit: the length of the shortest path between the specified vertices ns and ne.
10:   pathn – Integer arrayOutput
On exit: contains details of the shortest path between the specified vertices ns and ne. More precisely, ns=path1path2pathp=ne for some pn. The remaining n-p elements are set to zero.
11:   iwork3×n+1 – Integer arrayWorkspace
12:   work2×n – Real (Kind=nag_wp) arrayWorkspace
13:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 or 1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1 or 1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6
Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
On entry,n<2,
orns<1,
orns>n,
orne<1,
orne>n,
orns=ne.
ifail=2
On entry,nnz>n×n-1 when direct=.TRUE.,
ornnz>n×n-1/2 when direct=.FALSE.,
ornnz<1.
ifail=3
On entry, irowk<1 or irowk>n or icolk<1 or icolk>n or irowk=icolk for some k when direct=.TRUE..
ifail=4
On entry, irowk<1 or irowkicolk or icolk>n for some k when direct=.FALSE..
ifail=5
dk0.0 for some k.
ifail=6
On entry, irowk-1>irowk or irowk-1=irowk and icolk-1>icolk for some k.
ifail=7
On entry, irowk-1=irowk and icolk-1=icolk for some k.
ifail=8
No connected network exists between vertices ns and ne.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

The results are exact, except for the obvious rounding errors in summing the distances in the length of the shortest path.

8
Parallelism and Performance

h03adf is not threaded in any implementation.

9
Further Comments

h03adf is based upon Dijkstra's algorithm (see Dijkstra (1959)), which attempts to find a path nsne between two specified vertices ns and ne of shortest length dns,ne.
The algorithm proceeds by assigning labels to each vertex, which may be temporary or permanent. A temporary label can be changed, whereas a permanent one cannot. For example, if vertex p has a permanent label q,r, then r is the distance dns,r and q is the previous vertex on a shortest length nsp path. If the label is temporary, then it has the same meaning but it refers only to the shortest nsp path found so far. A shorter one may be found later, in which case the label may become permanent.
The algorithm consists of the following steps.
1. Assign the permanent label -,0 to vertex ns and temporary labels -, to every other vertex. Set k=ns and go to 2.
2. Consider each vertex y adjacent to vertex k with a temporary label in turn. Let the label at k be p,q and at yr,s. If q+dky<s, then a new temporary label k,q+dky is assigned to vertex y; otherwise no change is made in the label of y. When all vertices y with temporary labels adjacent to k have been considered, go to 3.
3. From the set of temporary labels, select the one with the smallest second component and declare that label to be permanent. The vertex it is attached to becomes the new vertex k. If k=ne go to 4. Otherwise go to 2 unless no new vertex can be found (e.g., when the set of temporary labels is ‘empty’ but kne, in which case no connected network exists between vertices ns and ne).
4. To find the shortest path, let y,z denote the label of vertex ne. The column label (z) gives dns,ne while the row label (y) then links back to the previous vertex on a shortest length nsne path. Go to vertex y. Suppose that the (permanent) label of vertex y is w,x, then the next previous vertex is w on a shortest length nsy path. This process continues until vertex ns is reached. Hence the shortest path is
nswyne,  
which has length dns,ne.

10
Example

This example finds the shortest path between vertices 1 and 11 for the undirected network
Figure H03ADF1
Figure 1

10.1
Program Text

Program Text (h03adfe.f90)

10.2
Program Data

Program Data (h03adfe.d)

10.3
Program Results

Program Results (h03adfe.r)