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

.. py:module:: starling_sim.basemodel.algorithms.algorithm


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

Classes
~~~~~~~

.. autoapisummary::

   starling_sim.basemodel.algorithms.algorithm.Algorithm




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


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

   .. py:attribute:: NAME
      :value: 'unnamed algorithm'

      

   .. 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:: log_message(message, lvl=ALGO_LEVEL)

      Logs the message in the logger using the class data

      :param message: message displayed in log
      :param lvl: level value, default is ALGO_LEVEL


   .. py:method:: __str__()

      Give a string display to the algorithm.

      :return: string with algorithm information