=========
Reference
=========

This is the class and function reference of pyprox.

.. contents:: List of modules
   :local:

.. _algorithms:

:mod:`pyprox`: Proximal algorithms
=============================================

.. automodule:: pyprox
    :no-members:
    :no-inherited-members:

Primal algorithms
-----------------

.. currentmodule:: pyprox

.. autosummary::
    :toctree: generated/
    :template: function.rst

    douglas_rachford
    forward_backward

Dual algorithms
---------------

.. currentmodule:: pyprox

.. autosummary::
    :toctree: generated/
    :template: function.rst

    forward_backward_dual

Primal-dual algorithms
----------------------

.. currentmodule:: pyprox

.. autosummary::
    :toctree: generated/
    :template: function.rst

    admm