Dijkstra/A*
Project description
Dijkstar is an implementation of Dijkstra’s singlesource shortestpaths algorithm. If a destination node is given, the algorithm halts when that node is reached; otherwise it continues until paths from the source node to all other nodes are found.
Accepts an optional cost (or “weight”) function that will be called on every iteration.
Also accepts an optional heuristic function that is used to push the algorithm toward a destination instead of fanning out in every direction. Using such a heuristic function converts Dijkstra to A* (and this is where the name “Dijkstar” comes from).
Example:
>>> from dijkstar import Graph, find_path >>> graph = Graph() >>> graph.add_edge(1, 2, 110) >>> graph.add_edge(2, 3, 125) >>> graph.add_edge(3, 4, 108) >>> find_path(graph, 1, 4) PathInfo( nodes=[1, 2, 3, 4], edges=[110, 125, 108], costs=[110, 125, 108], total_cost=343)
In this example, the edges are just simple numeric values–110, 125, 108–that could represent lengths, such as the length of a street segment between two intersections. find_path will use these values directly as costs.
Example with cost function:
>>> from dijkstar import Graph, find_path >>> graph = Graph() >>> graph.add_edge(1, 2, (110, 'Main Street')) >>> graph.add_edge(2, 3, (125, 'Main Street')) >>> graph.add_edge(3, 4, (108, '1st Street')) >>> def cost_func(u, v, edge, prev_edge): ... length, name = edge ... if prev_edge: ... prev_name = prev_edge[1] ... else: ... prev_name = None ... cost = length ... if name != prev_name: ... cost += 10 ... return cost ... >>> find_path(graph, 1, 4, cost_func=cost_func) PathInfo( nodes=[1, 2, 3, 4], edges=[(110, 'Main Street'), (125, 'Main Street'), (108, '1st Street')], costs=[120, 125, 118], total_cost=363)
The cost function is passed the current node (u), a neighbor (v) of the current node, the edge that connects u to v, and the edge that was traversed previously to get to the current node.
A cost function is most useful when computing costs dynamically. If costs in your graph are fixed, a cost function will only add unnecessary overhead. In the example above, a penalty is added when the street name changes.
When using a cost function, one recommendation is to compute a base cost when possible. For example, for a graph that represents a street network, the base cost for each street segment (edge) could be the length of the segment multiplied by the speed limit. There are two advantages to this: the size of the graph will be smaller and the cost function will be doing less work, which may improve performance.
Graph Export & Import
The graph can be saved to disk (pickled) like so:
>>> graph.dump(path)
And read back like this (load is a classmethod that returns a populated Graph instance):
>>> Graph.load(path)
Project details
Release history Release notifications  RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file Dijkstar2.6.0.tar.gz
.
File metadata
 Download URL: Dijkstar2.6.0.tar.gz
 Upload date:
 Size: 14.6 kB
 Tags: Source
 Uploaded using Trusted Publishing? No
 Uploaded via: twine/3.4.1 importlib_metadata/3.8.1 pkginfo/1.7.0 requests/2.25.1 requeststoolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm  Hash digest  

SHA256  ba9fa254c2ab9667a89dbaa9e322e59fc72f20fc6730ea6fe7be1f85e15a5bb7 

MD5  d80c0065634db95f7cc2d60ca1ff70b1 

BLAKE2b256  5991339563337ba35701743a69467c8a95678860935bd99745b5c4fe56028956 
File details
Details for the file Dijkstar2.6.0py3noneany.whl
.
File metadata
 Download URL: Dijkstar2.6.0py3noneany.whl
 Upload date:
 Size: 12.1 kB
 Tags: Python 3
 Uploaded using Trusted Publishing? No
 Uploaded via: twine/3.4.1 importlib_metadata/3.8.1 pkginfo/1.7.0 requests/2.25.1 requeststoolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm  Hash digest  

SHA256  49c7faad4273bc88609f688d5c00b80761d06793cb3285268cb385510c6a6e76 

MD5  ddeb52a6c3feb7ae2a7fc88c6c26e024 

BLAKE2b256  5389620e594fe1a58517d224a9a9cd05d56583e2c12a5a520cb3a67851601570 