graphs.bi_directional_dijkstra
==============================

.. py:module:: graphs.bi_directional_dijkstra

.. autoapi-nested-parse::

   Bi-directional Dijkstra's algorithm.

   A bi-directional approach is an efficient and
   less time consuming optimization for Dijkstra's
   searching algorithm

   Reference: shorturl.at/exHM7



Attributes
----------

.. autoapisummary::

   graphs.bi_directional_dijkstra.graph_bwd
   graphs.bi_directional_dijkstra.graph_fwd


Functions
---------

.. autoapisummary::

   graphs.bi_directional_dijkstra.bidirectional_dij
   graphs.bi_directional_dijkstra.pass_and_relaxation


Module Contents
---------------

.. py:function:: bidirectional_dij(source: str, destination: str, graph_forward: dict, graph_backward: dict) -> int

   Bi-directional Dijkstra's algorithm.

   Returns:
       shortest_path_distance (int): length of the shortest path.

   Warnings:
       If the destination is not reachable, function returns -1

   >>> bidirectional_dij("E", "F", graph_fwd, graph_bwd)
   3


.. py:function:: pass_and_relaxation(graph: dict, v: str, visited_forward: set, visited_backward: set, cst_fwd: dict, cst_bwd: dict, queue: queue.PriorityQueue, parent: dict, shortest_distance: float) -> float

.. py:data:: graph_bwd

.. py:data:: graph_fwd