SparseQR: clean a bit the documentation, fix rows/cols methods, remove rowsQ methods and rename matrixQR to matrixR.

This commit is contained in:
Gael Guennebaud
2013-01-12 09:40:31 +01:00
parent 581e389c54
commit 50625834e6
3 changed files with 100 additions and 93 deletions

View File

@@ -6,12 +6,12 @@
#include "src/Core/util/DisableStupidWarnings.h"
/** \defgroup SparseQR_Module SparseQR module
*
* \brief Provides QR decomposition for sparse matrices
*
* This module provides a simplicial version of the left-looking Sparse QR decomposition.
* The columns of the input matrix should be reordered to limit the fill-in during the
* decomposition. Built-in methods (COLAMD, AMD) or external methods (METIS) can be used to this end.
* See \link OrderingMethods_Module OrderingMethods_Module \endlink for the list
* See the \link OrderingMethods_Module OrderingMethods\endlink module for the list
* of built-in and external ordering methods.
*
* \code