Package Overview
The DJK package provides an API that finds a set of shortest paths from a source vertex to a destination vertex in a graph. In the context of this package, “shortest path” means the least-cost path, where cost is the sum of the edge weights of a path.
The algorithms and data-structures at the core of the DJK package are based on Dijkstra’s shortest path algorithm, with modifications and extensions. It is helpful to be familiar with Dijkstra’s algorithm before using this package. There are numerous good references describing the basic Dijkstra’s algorithm, including references 1, 3, and 4 (listed in References).
Choices made in API selection can greatly affect the performance of code that uses the DJK package. Some functions are intended to be stand-alone functions, while others are meant to be used together by building a cache of results that can be retrieved through follow-up calls. The purpose of this section is to give some guidance regarding efficient use of the DJK package for common use cases.