From 1b5ca49d477caa376046fe11b42a1d14268c94d4 Mon Sep 17 00:00:00 2001
From: Manuel Gunther <siebenkopf@googlemail.com>
Date: Tue, 8 Dec 2015 09:47:03 -0700
Subject: [PATCH] Improved documentation
---
bob/math/lp_interior_point.cpp | 4 ++--
doc/guide.rst | 8 +++++---
doc/py_api.rst | 20 ++++++++++++++++++++
3 files changed, 27 insertions(+), 5 deletions(-)
diff --git a/bob/math/lp_interior_point.cpp b/bob/math/lp_interior_point.cpp
index 8dbec4f..492bb43 100644
--- a/bob/math/lp_interior_point.cpp
+++ b/bob/math/lp_interior_point.cpp
@@ -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"
);
diff --git a/doc/guide.rst b/doc/guide.rst
index 10d6877..d1c7448 100644
--- a/doc/guide.rst
+++ b/doc/guide.rst
@@ -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
diff --git a/doc/py_api.rst b/doc/py_api.rst
index 3e745a5..dc6ae68 100644
--- a/doc/py_api.rst
+++ b/doc/py_api.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
--
GitLab