Commit 1b5ca49d authored by Manuel Günther's avatar Manuel Günther

Improved documentation

parent 5112961e
......@@ -52,9 +52,9 @@ auto s_lpinteriorpoint = bob::extension::ClassDoc(
"For more details about the algorithms,please refer to the following book: *'Primal-Dual Interior-Point Methods', Stephen J. Wright, ISBN: 978-0898713824, Chapter 5, 'Path-Following Algorithms'*.\n\n"
".. warning:: You cannot instantiate an object of this type directly, you must use it through one of the inherited types.\n\n"
"The primal linear program (LP) is defined as follows:\n\n"
".. math:: \\min c^T*x \\text{, s.t. } A*x=b, x>=0\n\n"
".. math:: \\min c^T\\cdot x \\text{, s.t. } A\\cdot x=b, x>=0\n\n"
"The dual formulation is:\n\n"
".. math:: \\min b^T*\\lambda \\text{, s.t. } A^T*\\lambda+\\mu=c"
".. math:: \\min b^T\\cdot\\lambda \\text{, s.t. } A^T\\cdot\\lambda+\\mu=c"
);
......
......@@ -7,14 +7,16 @@
import numpy
import bob.math
============
User Guide
============
=============
Users Guide
=============
The math module provides python bindings for C++/LAPACK_ vector and matrix
operations which are not implemented by NumPy_. For NumPy_ supported
operations, consult the NumPy_ manual.
.. todo:: Improve users guide by adding more details about what functionality is in :py:mod:`bob.math` and how to use it.
.. include:: links.rst
......
......@@ -11,23 +11,43 @@ This section includes information for using the pure Python API of ``bob.math``.
Summary
.......
Linear Programming
------------------
.. autosummary::
bob.math.LPInteriorPoint
bob.math.LPInteriorPointShortstep
bob.math.LPInteriorPointPredictorCorrector
bob.math.LPInteriorPointLongstep
Linear Systems
--------------
.. autosummary::
bob.math.linsolve
bob.math.linsolve_sympos
bob.math.linsolve_cg_sympos
Pool-Adjacent-Violators
-----------------------
.. autosummary::
bob.math.pavx
bob.math.pavx_width
bob.math.pavx_width_height
Scatter Matrices
----------------
.. autosummary::
bob.math.scatter
bob.math.scatters
Histogram Similarities
----------------------
.. autosummary::
bob.math.histogram_intersection
bob.math.chi_square
bob.math.kullback_leibler
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment