bluemira.optimisation._nlopt.conditions
=======================================

.. py:module:: bluemira.optimisation._nlopt.conditions


Classes
-------

.. autoapisummary::

   bluemira.optimisation._nlopt.conditions.NLOptConditions


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

.. py:class:: NLOptConditions

   Hold and validate optimiser stopping conditions.


   .. py:attribute:: ftol_abs
      :type:  float | None
      :value: None



   .. py:attribute:: ftol_rel
      :type:  float | None
      :value: None



   .. py:attribute:: xtol_abs
      :type:  float | None
      :value: None



   .. py:attribute:: xtol_rel
      :type:  float | None
      :value: None



   .. py:attribute:: max_eval
      :type:  int | None
      :value: None



   .. py:attribute:: max_time
      :type:  float | None
      :value: None



   .. py:attribute:: stop_val
      :type:  float | None
      :value: None



   .. py:method:: __post_init__()

      Validate initialised values.



   .. py:method:: to_dict() -> dict[str, float]

      :returns: The data in dictionary form.



   .. py:method:: _validate() -> None


   .. py:method:: _no_stopping_condition_set() -> bool

      Checks if all stopping conditions are unset.

      :returns: `True` if all stopping conditions are `None`, otherwise `False`.