pyepo.model.omo.shortestpath
============================

.. py:module:: pyepo.model.omo.shortestpath

.. autoapi-nested-parse::

   Shortest path problem



Attributes
----------

.. autoapisummary::

   pyepo.model.omo.shortestpath._HAS_PYOMO
   pyepo.model.omo.shortestpath.cost


Classes
-------

.. autoapisummary::

   pyepo.model.omo.shortestpath.shortestPathModel


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

.. py:data:: _HAS_PYOMO
   :value: True


.. py:class:: shortestPathModel(grid, solver='glpk')

   Bases: :py:obj:`pyepo.model.omo.omomodel.optOmoModel`


   This class is optimization model for shortest path problem

   .. attribute:: _model

      Pyomo model

      :type: PyOmo model

   .. attribute:: solver

      optimization solver in the background

      :type: str

   .. attribute:: grid

      size of grid network

      :type: tuple of int

   .. attribute:: arcs

      list of arcs

      :type: list


   .. py:attribute:: grid


   .. py:attribute:: arcs
      :value: []



   .. py:method:: _getArcs()

      A method to get list of arcs for grid network

      :returns: arcs
      :rtype: list



   .. py:method:: _getModel()

      A method to build pyomo model



.. py:data:: cost