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

.. oe:namespace:: OEOpt



.. meta::
   :keywords: OERibierePolakOpt, RibierePolakOpt


.. _OEOpt_OERibierePolakOpt:

.. oe:class:: OERibierePolakOpt

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OERibierePolakOpt : public OEOptimizer1

   The :ref:`OERibierePolakOpt <OEOpt_OERibierePolakOpt>` class implements the Polak-Ribière
   optimization method belonging to the family of conjugate gradient methods.
   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::

            OERibierePolakOpt()
            OERibierePolakOpt(const OERibierePolakOpt& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERibierePolakOpt() -> OERibierePolakOpt
            OERibierePolakOpt(rhs: OERibierePolakOpt) -> OERibierePolakOpt

      Default and copy constructors.

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

      .. oe:api::

         OERibierePolakOpt &operator=(const OERibierePolakOpt &rhs)

      Assignment operator.

