pyHarm.StepSizeRules.FactoryStepSize
====================================

.. py:module:: pyHarm.StepSizeRules.FactoryStepSize

.. autoapi-nested-parse::

   Module that contains the factory of ABCStepSizeRule objects.

   .. attribute:: StepSizer_dico

      Dictionary containing the factory keywords and their associated class of ABCStepSizeRule objects.

      :type: dict



Attributes
----------

.. autoapisummary::

   pyHarm.StepSizeRules.FactoryStepSize.StepSizer_dico


Functions
---------

.. autoapisummary::

   pyHarm.StepSizeRules.FactoryStepSize.generateStepSizeRule


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

.. py:data:: StepSizer_dico

   Dictionary containing the factory keywords and their associated class of ABCStepSizeRule objects.

   :type: dict

.. py:function:: generateStepSizeRule(name_stepsize, bounds: list[float, float], stepsize_options) -> pyHarm.StepSizeRules.ABCStepSizeRule.ABCStepSizeRule

   Factory function that creates a ABCStepSizeRule object.

   :param name_stepsize: Type of the stepsize rule object that is to be instanciated.
   :type name_stepsize: str
   :param bounds: list containing the bounds of the step-size [min_step, max_step].
   :type bounds: list[float,float]
   :param stepsize_options: dictionary containing complementary keywords argument that is passed to the initialisation of the object.
   :type stepsize_options: dict

   :returns: Instance of the required ABCStepSizeRule class.
   :rtype: ABCStepSizeRule