bluemira.optimisation._algorithm
================================

.. py:module:: bluemira.optimisation._algorithm

.. autoapi-nested-parse::

   Enumeration of supported optimiser algorithms.

   Note that it may not be the case that all backends support all
   algorithms. Each `Optimiser` implementation must state which of these
   algorithms it supports.



Attributes
----------

.. autoapisummary::

   bluemira.optimisation._algorithm.AlgorithmType


Classes
-------

.. autoapisummary::

   bluemira.optimisation._algorithm.Algorithm
   bluemira.optimisation._algorithm.AlgorithmConditions
   bluemira.optimisation._algorithm.AlgorithmDefaultConditions


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

.. py:class:: Algorithm(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: bluemira.optimisation._algorithm.Algorithm
      :parts: 1
      :private-bases:


   Enumeration of available optimisation algorithms.


   .. py:attribute:: SLSQP


   .. py:attribute:: COBYLA


   .. py:attribute:: SBPLX


   .. py:attribute:: MMA


   .. py:attribute:: BFGS


   .. py:attribute:: DIRECT


   .. py:attribute:: DIRECT_L


   .. py:attribute:: CRS


   .. py:attribute:: ISRES


   .. py:attribute:: NELDER_MEAD


   .. py:attribute:: POWELL


   .. py:attribute:: L_BFGS_B


   .. py:attribute:: TNC


   .. py:attribute:: COBYLA_SCIPY


   .. py:attribute:: COBYQA


   .. py:attribute:: SLSQP_SCIPY


   .. py:attribute:: TRUST_CONSTR


   .. py:method:: _missing_(value: str) -> Algorithm
      :classmethod:


      Handle cases where the algorithm type provided is not a valid algorithm.

      :param value: The string representation of the algorithm type.

      :returns: The corresponding algorithm.

      :raises ValueError: If the algorithm type is not a valid algorithm.



.. py:data:: AlgorithmType

.. py:class:: AlgorithmConditions

   Algorithm conditions container


   .. 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
      :value: 2000



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



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



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

      :returns: Converted dictionary without Nones



.. py:class:: AlgorithmDefaultConditions

   Default Algorithm conditions


   .. py:attribute:: SLSQP
      :type:  AlgorithmConditions


   .. py:attribute:: COBYLA
      :type:  AlgorithmConditions


   .. py:attribute:: SBPLX
      :type:  AlgorithmConditions


   .. py:attribute:: MMA
      :type:  AlgorithmConditions


   .. py:attribute:: BFGS
      :type:  AlgorithmConditions


   .. py:attribute:: DIRECT
      :type:  AlgorithmConditions


   .. py:attribute:: DIRECT_L
      :type:  AlgorithmConditions


   .. py:attribute:: CRS
      :type:  AlgorithmConditions


   .. py:attribute:: ISRES
      :type:  AlgorithmConditions