:py:mod:`MomentGauge.Optim.BaseOptimizer`
=========================================

.. py:module:: MomentGauge.Optim.BaseOptimizer


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

Classes
~~~~~~~

.. autoapisummary::

   MomentGauge.Optim.BaseOptimizer.BaseOptimizer




.. py:class:: BaseOptimizer(target_function, **kwargs)

   
   The base class for optimizer

   :param target_function:
                           the function to be optimized by the Netwons method whose

                                   **Parameters**:

                                       **input_para** : float array of shape (n) - The parameter to be optimized

                                       :math:`*` **aux_paras** : - Arbitrary many extra parameters not to be optimized. The :math:`*` refers to the unpacking operator in python.

                                   **Returns**:

                                       float -- the function value
   :type target_function: function
   :param \*\*kwargs:
   :type \*\*kwargs: other key word arguments.

   .. py:method:: optimize(input_para, *aux_paras)
      :abstractmethod:

      optimization of the **target_function**

      :param input_para: the input parameters for the **target_function** to be optimized.
      :type input_para: float array of shape (n)
      :param \*aux_paras: Arbitrary many extra parameters not to be optimized for the **target_function**.

      :returns:

                A tuple containing

                    **opt_para**: *float array of shape (n)* - The optimized parameters.

                    **opt_info**: *tuple* - A tuple containing other information
      :rtype: Tuple