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

.. oe:namespace:: OEOpt



.. meta::
   :keywords: OEConjGradOpt, ConjGradOpt


.. _OEOpt_OEConjGradOpt:

.. oe:class:: OEConjGradOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEConjGradOpt : public OEOptimizer1

   The :ref:`OEConjGradOpt <OEOpt_OEConjGradOpt>` implements the conjugate gradient 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:`SetLineMinimize<OEOpt::OEOptimizer1::SetLineMinimize>`
    * :oe:meth:`GetTolerance<OEOpt::OEOptimizer1::GetTolerance>` and
      :oe:meth:`SetTolerance<OEOpt::OEOptimizer1::SetTolerance>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEConjGradOpt()
            OEConjGradOpt(const OEConjGradOpt &)

      .. oe:language:: python

         .. oe:api:: python

            OEConjGradOpt() -> OEConjGradOpt
            OEConjGradOpt(arg2: OEConjGradOpt) -> OEConjGradOpt

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEConjGradOpt &operator=(const OEConjGradOpt &)

      Assignment operator.



