LevenbergMarquardtSettings
##########################

.. currentmodule:: pyarts3.arts

.. autoclass:: LevenbergMarquardtSettings

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.describe`
      - Explain the current values, their effects, and tuning tradeoffs.
    * - Method
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.readxml`
      - Read variable from file.
    * - Method
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.savexml`
      - Saves variable to file.
    * - Method
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.validate`
      - Check the current named values and their coupled constraints.
    * - Static Method
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.fromxml`
      - Create variable from file.
    * - :class:`float`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.convergence_damping_limit`
      - Largest updated damping at which the ordinary ``stop_dx`` test is enabled.
    * - :class:`float`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.damping_threshold`
      - Positive restart damping and threshold for returning to Gauss--Newton.
    * - :class:`float`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.decrease_factor`
      - Divisor used when the local model warrants decreasing damping.
    * - :class:`float`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.increase_factor`
      - Multiplier used when an unsuccessful trial requires more damping.
    * - :class:`float`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.initial_damping`
      - Initial damping gamma. Larger values restrain initial steps more strongly.
    * - :class:`float`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.maximum_damping`
      - Upper damping limit. Must be finite and positive, and no smaller than
    * - :class:`int`
      - :attr:`~pyarts3.arts.LevenbergMarquardtSettings.maximum_trials`
      - Maximum linear-solve trials per outer iteration, including stationarity checks.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__eq__`
      - Return self==value.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__format__`
      - Default object formatter.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__ge__`
      - Return self>=value.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__gt__`
      - Return self>value.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__init__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__le__`
      - Return self<=value.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__lt__`
      - Return self<value.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__ne__`
      - Return self!=value.
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__repr__`
      - ``__repr__(self) -> str``
    * - Operator
      - :func:`~pyarts3.arts.LevenbergMarquardtSettings.__str__`
      - ``__str__(self) -> str``

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: LevenbergMarquardtSettings.describe
  .. automethod:: LevenbergMarquardtSettings.readxml
  .. automethod:: LevenbergMarquardtSettings.savexml
  .. automethod:: LevenbergMarquardtSettings.validate

  .. rubric:: Static Methods

  .. automethod:: LevenbergMarquardtSettings.fromxml

  .. rubric:: Attributes

  .. attribute:: LevenbergMarquardtSettings.convergence_damping_limit
     :type: float

     Largest updated damping at which the ordinary ``stop_dx`` test is enabled.
     Must be finite and nonnegative. Zero waits until damping reaches zero.
     A positive value permits convergence while damping still restrains steps,
     which can hide a remaining distance to the minimum.

     .. :class:`float`


  .. attribute:: LevenbergMarquardtSettings.damping_threshold
     :type: float

     Positive restart damping and threshold for returning to Gauss--Newton.
     A proposed decrease below this value sets damping to zero. A rejected trial
     below this value restarts here. Must be finite and no greater than ``maximum_damping``.

     .. :class:`float`


  .. attribute:: LevenbergMarquardtSettings.decrease_factor
     :type: float

     Divisor used when the local model warrants decreasing damping.
     Must be finite and greater than one. A larger value releases damping faster.
     Not every accepted step causes a decrease.

     .. :class:`float`


  .. attribute:: LevenbergMarquardtSettings.increase_factor
     :type: float

     Multiplier used when an unsuccessful trial requires more damping.
     Must be finite and greater than one. A larger value increases damping faster;
     an increase from zero first restarts at ``damping_threshold``.

     .. :class:`float`


  .. attribute:: LevenbergMarquardtSettings.initial_damping
     :type: float

     Initial damping gamma. Larger values restrain initial steps more strongly.
     Must be finite, nonnegative, and no greater than ``maximum_damping``.
     Zero starts with a Gauss--Newton step.

     .. :class:`float`


  .. attribute:: LevenbergMarquardtSettings.maximum_damping
     :type: float

     Upper damping limit. Must be finite and positive, and no smaller than
     ``initial_damping`` or ``damping_threshold``.
     Failure to obtain an acceptable step at this value stops the retrieval.
     Check the forward model, Jacobian, and covariance scales before raising it.

     .. :class:`float`


  .. attribute:: LevenbergMarquardtSettings.maximum_trials
     :type: int

     Maximum linear-solve trials per outer iteration, including stationarity checks.

     .. :class:`int`



  .. rubric:: Operators

  .. automethod:: LevenbergMarquardtSettings.__eq__
  .. automethod:: LevenbergMarquardtSettings.__format__
  .. automethod:: LevenbergMarquardtSettings.__ge__
  .. automethod:: LevenbergMarquardtSettings.__gt__
  .. automethod:: LevenbergMarquardtSettings.__hash__
  .. automethod:: LevenbergMarquardtSettings.__init__
  .. automethod:: LevenbergMarquardtSettings.__le__
  .. automethod:: LevenbergMarquardtSettings.__lt__
  .. automethod:: LevenbergMarquardtSettings.__ne__
  .. automethod:: LevenbergMarquardtSettings.__repr__
  .. automethod:: LevenbergMarquardtSettings.__str__