path: root/support/graphbase/gb_dijk.w

% This file is part of the Stanford GraphBase (c) Stanford University 1992
\def\title{GB\_\thinspace DIJK}
@i boilerplate.w %<< legal stuff: PLEASE READ IT BEFORE MAKING ANY CHANGES!

\prerequisite{GB\_\thinspace GRAPH}
@* Introduction. The GraphBase demonstration routine |dijkstra(uu,vv,gg,hh)|
finds a shortest path from vertex~|uu| to vertex~|vv| in graph~|gg|, with the
aid of an optional heuristic function~|hh|. This function implements a
version of Dijkstra's algorithm, a general procedure for determining
shortest paths in a directed graph that has nonnegative arc lengths
[E.~W. Dijkstra, ``A note a two problems in connexion with graphs,''
{\sl Numerische Mathematik\/ \bf1} (1959), 269--271].

If |hh| is null, the length of
every arc in |gg| must be nonnegative. If |hh| is non-null, |hh| should be
a function defined on the vertices of the graph such that the
length |d| of an arc from |u| to~|v| always satisfies the condition
$$ d \ge |hh|(u)-|hh|(v)\,. $$
In such a case, we can effectively replace each arc length |d| by
|d-hh(u)+hh(v)|, obtaining a graph with nonnegative arc lengths;
the shortest paths between vertices in this modified graph
are the same as they were in the original graph.

The basic idea of Dijkstra's algorithm is to explore the vertices of
the graph in order of their distance from the starting vertex~|uu|,
proceeding until |vv| is encountered. If the distances have been
modified by a heuristic function |hh| such that |hh(u)| happens to equal
the true distance from |u| to~|vv|, for all~|u|,
then all of the modified distances on
shortest paths to |vv| will be zero; this means that the algorithm
will explore all of the most useful arcs first, so it will not waste
time wandering off in unfruitful directions. In practice we usually
don't know the exact distances to |vv| in advance, but we can often
compute an approximate value |hh(u)| that will help focus the search.

If the external variable |verbose| is nonzero, |dijkstra| will record
its activities, by printing the distances from |uu| to all vertices
it visits on the standard output file.

After |dijkstra| has found a shortest path, it returns the length of
that path. If no path from |uu| to~|vv| exists (in particular, if
|vv| is~|NULL|), it returns |-1|; in such a case, the shortest distances from
|uu| to all vertices reachable from it will have been computed and
they can be found in the graph.
An auxiliary function, |print_dijkstra_result(vv)|, can be used
to display the actual path found, if one exists.

Examples of the use of |dijkstra| appear in the |ladders| demonstration module.

@f Vertex int
@f Arc int
@f Graph int

@ This \Cee\ module is meant to be loaded as part of another program.
It has the following simple structure:

@p
#include "gb_graph.h" /* define the standard GraphBase data structures */
@<Priority queue procedures@>@;
@<Global declarations@>@;
@<The |dijkstra| procedure@>@;
@<The |print_dijkstra_result| procedure@>@;

@ Users of |gb_dijk| should include the header file \.{gb\_dijk.h}:

@(gb_dijk.h@>=
extern long dijkstra(); /* procedure to calculate shortest paths */
extern void print_dijkstra_result(); /* procedure to display the answer */

@* The main algorithm.
As Dijkstra's algorithm proceeds, it ``knows'' shortest paths from |uu|
to more and more vertices; we will call these vertices ``known.''
Initially only |uu| itself is known. The procedure terminates when |vv|
becomes known, or when all vertices reachable from~|uu| are known.

Dijkstra's algorithm looks at all vertices adjacent to known vertices.
A vertex is said to have been ``seen'' if it is either known or
adjacent to a vertex that's known.

The algorithm proceeds by learning to know all vertices in a greater
and greater radius from the starting point. Thus, if |v|~is a known
vertex at distance~|d| from~|uu|, every vertex at distance |<d| from
|uu| will also be known.  (Throughout this discussion the word
``distance'' actually means ``distance modified by the heuristic
function''; we omit mentioning the heuristic because we can assume that
the algorithm is operating on a graph with modified distances.)

The algorithm maintains an auxiliary list of all vertices that have been
seen but aren't yet known. For every such vertex~|v|, it remembers
the shortest distance~|d| from |uu| to~|v| by a path that passes entirely
through known vertices except for the very last arc.

This auxiliary list is actually a priority queue, ordered by the |d| values.
If |v|~is a vertex of the priority queue having the smallest |d|, we can
remove |v| from the queue and consider it known, because there cannot be
a path of length less than~|d| from |uu| to~|v|. (This is where the
assumption of nonnegative arc length is crucial to the algorithm's validity.)

@ To implement the ideas just sketched, we use several of the utility
fields in vertex records. Each vertex~|v| has a |dist| field |v->dist|,
representing its true distance from |uu| if |v| is known, otherwise
representing the shortest distance from |uu| discovered so far.

Each vertex |v| also has a |backlink| field |v->backlink|, which is non-|NULL|
if and only if |v| has been seen. In that case |v->backlink| is a vertex one
step ``closer'' to |uu|, on a path from |uu| to |v| that achieves the
current distance |v->dist|. (Exception:
Vertex~|uu| has a backlink pointing to itself.) The backlink
fields thereby allow us to construct shortest paths from |uu| to all the
known vertices, if desired.

@d dist z.i /* distance from |uu|, modified by |hh|,
                 appears in vertex utility field |z| */
@d backlink y.v /* pointer to previous vertex appears in utility field |y| */

@(gb_dijk.h@>=
#define dist @[z.i@]
#define backlink @[y.v@]

@ The priority queue is implemented by four procedures:

\def\]#1 {\smallskip\hangindent2\parindent \hangafter1 \indent #1 }

\]|init_queue(d)| makes the queue empty and prepares for subsequent keys |>=d|.

\]|enqueue(v,d)| puts vertex |v| in the queue and assigns it the key
value |v->dist=d|.

\]|requeue(v,d)| takes vertex |v| out of the queue and enters it again
with the smaller key value |v->dist=d|.

\]|delete_min()| removes a vertex with minimum key from the queue and
returns a pointer to that vertex. If the queue is empty, |NULL| is returned.

\smallskip\noindent
These procedures are accessed via external pointers,
so that the user of |gb_dijk| can supply alternate queueing methods if desired.

@(gb_dijk.h@>=
extern void (*init_queue)(); /* create an empty priority queue for |dijkstra| */
extern void (*enqueue)(); /* insert a new element in the priority queue */
extern void (*requeue)(); /* decrease the key of an element in the queue */
extern Vertex *(*delete_min)(); /* remove an element with smallest key */

@ The heuristic function may take awhile to compute, so we avoid recomputation
by storing |hh(v)| in another utility field |v->hh_val| once we've
evaluated it. 

@d hh_val x.i /* computed value of |hh(u)| */

@(gb_dijk.h@>=
#define hh_val @[x.i@]

@ If no heuristic function is supplied by the user, we replace it by a
dummy function that simply returns 0 in all cases.

@<Global...@>=
long dummy(v)
  Vertex *v;
{@+return 0;@+}

@ Here now is |dijkstra|:

@<The |dijkstra| procedure@>=
long dijkstra(uu,vv,gg,hh)
  Vertex *uu; /* the starting point */
  Vertex *vv; /* the ending point */
  Graph *gg; /* the graph they belong to */
  long (*hh)(); /* heuristic function */
{@+register Vertex *t; /* current vertex of interest */
  if (hh==NULL)
    hh=dummy; /* change to default heuristic */
  @<Make |uu| the only vertex seen; also make it known@>;
  t=uu;
  if (verbose) @<Print initial message@>;
  while (t!=vv) {
    @<Put all unseen vertices adjacent to |t| into the queue,
       and update the distances of other vertices adjacent to~|t|@>;
    t=(*delete_min)();
    if (t==NULL)
      return -1; /* if the queue becomes, there's no way to get to |vv| */
    if (verbose) @<Print the distance to |t|@>;
  }
  return vv->dist-vv->hh_val+uu->hh_val; /* true distance from |uu| to |vv| */
}

@ As stated above, a vertex is considered seen only when its backlink
isn't null, and known only when it is seen but not in the queue.

@<Make |uu| the only...@>=
for (t=gg->vertices+gg->n-1; t>=gg->vertices; t--) t->backlink=NULL;
uu->backlink=uu;
uu->dist=0;
uu->hh_val=(*hh)(uu);
(*init_queue)(0); /* make the priority queue empty */

@ Here we help the \Cee\ compiler in case it hasn't got a great optimizer.

@<Put all unseen vertices adjacent to |t| into the queue...@>=
{@+register Arc *a; /* an arc leading from |t| */
  register long d = t->dist - t->hh_val;
  for (a=t->arcs; a; a=a->next) {
    register Vertex *v = a->tip; /* a vertex adjacent to |t| */
    if (v->backlink) { /* |v| has already been seen */
      register long dd = d + a->len + v->hh_val;
      if (dd< v->dist) {
        v->backlink = t;
        (*requeue)(v,dd); /* we found a better way to get there */
      }
    } else { /* |v| hasn't been seen before */
      v->hh_val = (*hh)(v);
      v->backlink = t;
      (*enqueue)(v, d + a->len + v->hh_val);
    }
  }
}

@ The |dist| fields don't contain true distances in the graph; they
represent distances modified by the heuristic function. The true distance
from |uu| to vertex |v| is |v->dist - v->hh_val + uu->hh_val|.

When printing the results, we show true distances. Also, if a nontrivial
heuristic is being used, we give the |hh| value in brackets; the user can then
observe that vertices are becoming known in order of true distance
plus |hh| value.

@<Print initial message@>=
{@+printf("Distances from %s", uu->name);
  if (hh!=dummy) printf(" [%ld]", uu->hh_val);
  printf(":\n");
}

@ @<Print the distance to |t|@>=
{@+printf(" %ld to %s", t->dist - t->hh_val + uu->hh_val, t->name);
  if (hh!=dummy) printf(" [%ld]", t->hh_val);
  printf(" via %s\n", t->backlink->name);
}

@ After |dijkstra| has found a shortest path, the backlinks from~|vv|
specify the steps of that path. We want to print the path in the forward
direction, so we reverse the links.

We also unreverse them again, just in case the user didn't want the backlinks
to be trashed. Indeed, this procedure can be used for any vertex |vv| whose
backlink is nonnull, not only the |vv| that was a parameter to |dijkstra|.

List reversal is conveniently regarded as a process of popping off one stack
and pushing onto another.

@<The |print_dijkstra_result| procedure@>=
void print_dijkstra_result(vv)
  Vertex *vv; /* ending vertices */
{@+register Vertex *t, *p, *q; /* registers for reversing links */
  t=NULL, p=vv;
  if (!p->backlink) {
    printf("Sorry, %s is unreachable.\n",p->name);
    return;
  }
  do { /* pop an item from |p| to |t| */
    q=p->backlink;
    p->backlink=t;
    t=p;
    p=q;
  } while (t!=p); /* the loop stops with |t==p==uu| */
  do {
    printf("%10ld %s\n", t->dist-t->hh_val+p->hh_val, t->name);
    t=t->backlink;
  } while (t);
  t=p;
  do { /* pop an item from |t| to |p| */
    q=t->backlink;
    t->backlink=p;
    p=t;
    t=q;
  } while (p!=vv);
}

@* Priority queues. Here we provide a simple doubly linked list
for queueing; this is a convenient default, good enough for applications
that aren't too large. (See |miles_span| for implementations of
other schemes that are more efficient when the queue gets large.)

@<Glob...@>=
void (*init_queue)() = init_dlist; /* create an empty dlist */
void (*enqueue)() = enlist; /* insert a new element in dlist */
void (*requeue)() = reenlist ; /* decrease the key of an element in dlist */
Vertex *(*delete_min)() = delete_first; /* remove element with smallest key */

@ The two queue links will occupy two of a vertex's remaining utility fields.
There's a special list head, from which we get to everything else in the
queue in decreasing order of keys by following |llink| fields.

The following declaration actually provides for 128 list heads. Only the first
of these will be used here, but we'll find something to do with the
other 127 later.

@d llink v.v /* |llink| is stored in utility field |v| of a vertex */
@d rlink w.v /* |rlink| is stored in utility field |w| of a vertex */

@<Prior...@>=
Vertex head[128]; /* list-head elements that are always present */
@#
void init_dlist(d)
  long d;
{
  head->llink=head->rlink=head;
  head->dist=d-1; /* a value guaranteed to be smaller than any actual key */
}

@ It seems reasonable to assume that an element entering the queue for the
first time will tend to have a larger key than the other elements.

Indeed, in the special case that all arcs in the graph have the same
length, this strategy turns out to be quite fast. For in that case,
every vertex will be added to the end of the queue and deleted from the
front, without any requeueing; the algorithm will produce a strict
first-in-first-one queueing discipline.

@<Prior...@>=
void enlist(v,d)
  Vertex *v;
  long d;
{@+register Vertex *t=head->llink;
  v->dist=d;
  while (d<t->dist) t=t->llink;
  v->llink=t;
  (v->rlink=t->rlink)->llink=v;
  t->rlink=v;
}

@ @<Prior...@>=
void reenlist(v,d)
  Vertex *v;
  long d;
{@+register Vertex *t=v->llink;
  (t->rlink=v->rlink)->llink=v->llink; /* remove |v| */
  v->dist=d; /* we assume that the new |dist| is smaller than it was before */
  while (d<t->dist) t=t->llink;
  v->llink=t;
  (v->rlink=t->rlink)->llink=v;
  t->rlink=v;
}

@ @<Prior...@>=
Vertex *delete_first()
{@+Vertex *t;
  t=head->rlink;
  if (t==head) return NULL;
  (head->rlink=t->rlink)->llink=head;
  return t;
}

@* A special case. When the arc lengths in the graph are all fairly small,
we can substitute another queuing discipline that does each operation
quickly. Suppose the only lengths are 0, 1, \dots,~|k-1|; then we can
prove easily that the priority queue will never contain more than |k|
different values at once. Moreover, we can implement it by maintaining
|k| doubly linked lists, one for each key value mod~|k|.

For example, let |k=128|.  Here is an alternate set of queue commands,
to be used when the arc lengths are known to be less than~128.

@ @<Prior...@>=
long master_key; /* smallest key that may be present in the priority queue */
@#
void init_128(d)
  long d;
{@+register Vertex *u;
  master_key=d;
  for (u=head; u<head+128; u++)
    u->llink=u->rlink=u;
}

@ If the number of lists were not a power of 2, we would calculate a remainder
by division instead of by logical-anding with |0x7f|.

@<Prior...@>=
Vertex *delete_from_128()
{@+long d;
  register Vertex *u, *t;
  for (d=master_key; d<master_key+128; d++) {
    u=head+(d&0x7f); /* that's |d%128| */
    t=u->rlink;
    if (t!=u) { /* we found a nonempty list with minimum key */
      master_key=d;
      (u->rlink = t->rlink)->llink = u;
      return t; /* incidentally, |t->dist = d| */
    }
  }
  return NULL; /* all 128 lists are empty */
}

@ @<Prior...@>=
void enqueue_128(v,d)
  Vertex *v; /* new vertex for the queue */
  long d; /* its |dist| */
{@+register Vertex *u=head+(d&0x7f);
  v->dist = d;
  (v->llink = u->llink)->rlink = v;
  v->rlink = u;
  u->llink = v;
}

@ All of these operations have been so simple, one wonders why the lists
should be doubly linked. Single linking would indeed be plenty---if we
didn't have to support the |requeue| operation.

But requeueing involves deleting an arbitrary element from the middle of
its list. And we do seem to need two links for that.

In the application to Dijkstra's algorithm, the new |d| will always
be |master_key| or more. But we want to implement requeueing in general,
so that this procedure can be used also for other algorithms,
such as the calculation of minimum spanning trees (see |miles_span|).

@<Prior...@>=
void requeue_128(v,d)
  Vertex *v; /* vertex to be moved to another list */
  long d; /* its new |dist| */
{@+register Vertex *u=head+(d&0x7f);
  (v->llink->rlink=v->rlink)->llink=v->llink; /* remove |v| */  
  v->dist=d; /* the new |dist| is smaller than it was before */
  (v->llink=u->llink)->rlink = v;
  v->rlink = u;
  u->llink = v;
  if (d<master_key) master_key=d; /* not needed for Dijkstra's algorithm */
}

@ The user of |gb_dijk| needs to know the names of these queueing procedures
if changes to the defaults are made, so we'd better put the necessary info
into the header file.

@(gb_dijk.h@>=
extern void init_dlist();
extern void enlist();
extern void reenlist();
extern Vertex *delete_first();
extern void init_128();
extern Vertex *delete_from_128();
extern void enqueue_128();
extern void requeue_128();

@* Index. Here is a list that shows where the identifiers of this program are
defined and used.