Fix several documentation issues

This commit is contained in:
Gael Guennebaud
2012-12-24 13:33:22 +01:00
parent f450303321
commit f41d96deb9
29 changed files with 115 additions and 108 deletions

View File

@@ -38,7 +38,7 @@ namespace Eigen {
* An important parameter of this class is the ordering method. It is used to reorder the columns
* (and eventually the rows) of the matrix to reduce the number of new elements that are created during
* numerical factorization. The cheapest method available is COLAMD.
* See \link Ordering_Modules the Ordering module \endlink for the list of
* See \link OrderingMethods_Module the OrderingMethods module \endlink for the list of
* built-in and external ordering methods.
*
* Simple example with key steps
@@ -55,10 +55,10 @@ namespace Eigen {
* x = solver.solve(b);
* \endcode
*
* \WARNING The input matrix A should be in a \b compressed and \b column-major form.
* \warning The input matrix A should be in a \b compressed and \b column-major form.
* Otherwise an expensive copy will be made. You can call the inexpensive makeCompressed() to get a compressed matrix.
*
* \NOTE Unlike the initial SuperLU implementation, there is no step to equilibrate the matrix.
* \note Unlike the initial SuperLU implementation, there is no step to equilibrate the matrix.
* For badly scaled matrices, this step can be useful to reduce the pivoting during factorization.
* If this is the case for your matrices, you can try the basic scaling method at
* "unsupported/Eigen/src/IterativeSolvers/Scaling.h"
@@ -68,7 +68,7 @@ namespace Eigen {
*
*
* \sa \ref TutorialSparseDirectSolvers
* \sa \ref Ordering_Modules
* \sa \ref OrderingMethods_Module
*/
template <typename _MatrixType, typename _OrderingType>
class SparseLU

View File

@@ -44,10 +44,10 @@
/**
* Expand the existing storage to accomodate more fill-ins
* \param vec Valid pointer to the vector to allocate or expand
* \param [in,out]length At input, contain the current length of the vector that is to be increased. At output, length of the newly allocated vector
* \param [in]nbElts Current number of elements in the factors
* \param[in,out] length At input, contain the current length of the vector that is to be increased. At output, length of the newly allocated vector
* \param[in] nbElts Current number of elements in the factors
* \param keep_prev 1: use length and do not expand the vector; 0: compute new_len and expand
* \param [in,out]num_expansions Number of times the memory has been expanded
* \param[in,out] num_expansions Number of times the memory has been expanded
*/
template <typename Scalar, typename Index>
template <typename VectorType>

View File

@@ -15,7 +15,7 @@
* \brief Performs numeric block updates from a given supernode to a single column
*
* \param segsize Size of the segment (and blocks ) to use for updates
* \param [in,out]dense Packed values of the original matrix
* \param[in,out] dense Packed values of the original matrix
* \param tempv temporary vector to use for updates
* \param lusup array containing the supernodes
* \param lda Leading dimension in the supernode

View File

@@ -169,18 +169,18 @@ void SparseLUBase<Scalar,Index>::LU_dfs_kernel(const int jj, IndexVector& perm_r
* marker[i] == jj, if i was visited during dfs of current column jj;
* marker1[i] >= jcol, if i was visited by earlier columns in this panel;
*
* \param [in]m number of rows in the matrix
* \param [in]w Panel size
* \param [in]jcol Starting column of the panel
* \param [in]A Input matrix in column-major storage
* \param [in]perm_r Row permutation
* \param [out]nseg Number of U segments
* \param [out]dense Accumulate the column vectors of the panel
* \param [out]panel_lsub Subscripts of the row in the panel
* \param [out]segrep Segment representative i.e first nonzero row of each segment
* \param [out]repfnz First nonzero location in each row
* \param [out]xprune
* \param [out]marker
* \param[in] m number of rows in the matrix
* \param[in] w Panel size
* \param[in] jcol Starting column of the panel
* \param[in] A Input matrix in column-major storage
* \param[in] perm_r Row permutation
* \param[out] nseg Number of U segments
* \param[out] dense Accumulate the column vectors of the panel
* \param[out] panel_lsub Subscripts of the row in the panel
* \param[out] segrep Segment representative i.e first nonzero row of each segment
* \param[out] repfnz First nonzero location in each row
* \param[out] xprune
* \param[out] marker
*
*
*/

View File

@@ -45,9 +45,9 @@
*
* \param jcol The current column of L
* \param u diagonal pivoting threshold
* \param [in,out]perm_r Row permutation (threshold pivoting)
* \param [in] iperm_c column permutation - used to finf diagonal of Pc*A*Pc'
* \param [out]pivrow The pivot row
* \param[in,out] perm_r Row permutation (threshold pivoting)
* \param[in] iperm_c column permutation - used to finf diagonal of Pc*A*Pc'
* \param[out] pivrow The pivot row
* \param glu Global LU data
* \return 0 if success, i > 0 if U(i,i) is exactly zero
*

View File

@@ -37,12 +37,12 @@
*
*
* \param jcol The current column of L
* \param [in]perm_r Row permutation
* \param [out]pivrow The pivot row
* \param[in] perm_r Row permutation
* \param[out] pivrow The pivot row
* \param nseg Number of segments
* \param segrep
* \param repfnz
* \param [out]xprune
* \param[out] xprune
* \param glu Global LU data
*
*/