********
peri.opt
********

* :ref:`peri.opt.optimize`

  * Functions:

    * :func:`peri.opt.optimize.burn`
    * :func:`peri.opt.optimize.finish`
    * :func:`peri.opt.optimize.do_levmarq`
    * :func:`peri.opt.optimize.do_levmarq_particles`
    * :func:`peri.opt.optimize.do_levmarq_all_particle_groups`

  * Classes:

    * :class:`peri.opt.optimize.LMEngine`
    * :class:`peri.opt.optimize.LMGlobals`
    * :class:`peri.opt.optimize.LMParticles`
    * :class:`peri.opt.optimize.LMParticleGroupCollection`
    * :class:`peri.opt.optimize.LMAugmentedState`

* :ref:`peri.opt.addsubtract`

  * :func:`peri.opt.addsubtract.add_subtract`
  * :func:`peri.opt.addsubtract.add_subtract_locally`
  * :func:`peri.opt.addsubtract.feature_guess`

peri.opt.optimize.burn
----------------------

.. autofunction:: peri.opt.optimize.burn

peri.opt.optimize.finish
------------------------

.. autofunction:: peri.opt.optimize.finish


.. _peri.opt.optimize:

peri.opt.optimize
=================

peri.opt.optimize functions
---------------------------

.. autofunction:: peri.opt.optimize.do_levmarq

.. autofunction:: peri.opt.optimize.do_levmarq_all_particle_groups

.. autofunction:: peri.opt.optimize.do_levmarq_particles

peri.opt.optimize classes
-------------------------

.. autoclass:: peri.opt.optimize.LMEngine
    :members:

.. autoclass:: peri.opt.optimize.LMGlobals

.. autoclass:: peri.opt.optimize.LMParticles

.. autoclass:: peri.opt.optimize.LMParticleGroupCollection

.. autoclass:: peri.opt.optimize.LMAugmentedState

.. _peri.opt.addsubtract:

peri.opt.addsubtract
====================

.. autofunction:: peri.opt.addsubtract.add_subtract

.. autofunction:: peri.opt.addsubtract.add_subtract_locally

.. autofunction:: peri.opt.addsubtract.feature_guess