.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEOpt



.. meta::
   :keywords: OESteepestDescentOpt, SteepestDescentOpt


.. _OEOpt_OESteepestDescentOpt:

.. oe:class:: OESteepestDescentOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESteepestDescentOpt : public OEOptimizer1

   The :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>` class implements the steepest descent
   optimization method. The convergence criteria in based on  :math:`\sum_i {g_ig_i}`.

   The following methods are publicly inherited from :ref:`OEOptimizer1 <OEOpt_OEOptimizer1>`:
    * :oe:meth:`operator()<OEOpt::OEOptimizer1::operator()>`         
    * :oe:meth:`GetIterLimit<OEOpt::OEOptimizer1::GetIterLimit>` and
      :oe:meth:`SetIterLimit<OEOpt::OEOptimizer1::SetIterLimit>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`

   The :ref:`OESteepestDescentOpt <OEOpt_OESteepestDescentOpt>` class defines the following public methods:
    * :oe:meth:`SetInitialStep<OEOpt::OESteepestDescentOpt::SetInitialStep>`
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESteepestDescentOpt()

      .. oe:language:: python

         .. oe:api:: python

            OESteepestDescentOpt() -> OESteepestDescentOpt

      Default and copy constructors.


   .. oe:method:: SetInitialStep

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInitialStep(double step)

      .. oe:language:: python

         .. oe:api:: python

            SetInitialStep(step: float) -> None

      Sets the initial step. The default initial step is :math:`\sqrt(1.0/\sum_i{g_ig_i})`

