pyHarm.StopCriterion.ABCStopCriterion
=====================================

.. py:module:: pyHarm.StopCriterion.ABCStopCriterion


Classes
-------

.. autoapisummary::

   pyHarm.StopCriterion.ABCStopCriterion.ABCStopCriterion


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

.. py:class:: ABCStopCriterion(bounds: list[float, float], ds_min: float, **kwargs)

   Bases: :py:obj:`abc.ABC`


   Abstract class for the stopping criterion. Any stopping criterion code
   shall inherit from this class.

   :param bounds: A list of upper and lower bounds.
   :type bounds: list[float, float]
   :param ds_min: The minimum step size.
   :param \*\*kwargs: Additional keyword arguments.

   :raises NotImplementedError: If the subclass lacks the factory_keyword class attribute.
   :raises TypeError: If the factory_keyword is not a string value.


   .. py:property:: factory_keyword
      :type: str

      :abstractmethod:


      Returns:
      str: keyword that is used to call the creation of this class in the system factory.


   .. py:attribute:: puls_inf


   .. py:attribute:: puls_sup


   .. py:attribute:: epsilon_bounds


   .. py:attribute:: bound_inf


   .. py:attribute:: bound_sup


   .. py:attribute:: ds_min


   .. py:method:: getStopCriterionStatus(sol: pyHarm.Solver.SystemSolution, sollist: list, **kwargs) -> bool
      :abstractmethod:


      Abstract method to get the stop criterion status.

      :param sol: A SystemSolution object.
      :type sol: SystemSolution
      :param sollist: A list of solutions.
      :type sollist: list
      :param \*\*kwargs: Additional keyword arguments.

      :raises None.: