:py:mod:`starling_sim.basemodel.algorithms.pal_zhang_GCH`
=========================================================

.. py:module:: starling_sim.basemodel.algorithms.pal_zhang_GCH


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

Classes
~~~~~~~

.. autoapisummary::

   starling_sim.basemodel.algorithms.pal_zhang_GCH.PalZhangGCH




.. py:class:: PalZhangGCH(simulation_model, operator, verb=False)


   Bases: :py:obj:`starling_sim.basemodel.algorithms.algorithm.Algorithm`

   This class describes a generic structure for the algorithms of the simulation

   .. py:attribute:: NAME
      :value: 'PalZhangGCH'

      

   .. py:attribute:: SCHEMA

      

   .. py:method:: setup_new_run()


   .. py:method:: run()

      Core method of the Algorithm class, called to run the algorithm.

      This method must be implemented for all algorithms.

      Algorithm inputs are accessed in the class attributes.

      :return: None, the algorithm result is stored in self.result


   .. py:method:: breaking_condition(end_time)


   .. py:method:: compute_operations_needed()


   .. py:method:: compute_station_target_stock(station_id)


   .. py:method:: compute_station_variation(station_id)


   .. py:method:: maximum_operations()


   .. py:method:: select_next_neighbor(current_station_id, max_operations)


   .. py:method:: append_depot_to_planning()


   .. py:method:: init_demand_dict()