diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2016-01-01 21:45:06 +0100 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2016-01-01 21:45:06 +0100 |
| commit | 8b0d1eb0f7f1ab017a8e603f3887143df15662d7 (patch) | |
| tree | f4dfaa8f9daeb27595923d052afd844435f90ae7 /Eigen/src/OrderingMethods/Amd.h | |
| parent | 9900782e882b9429e44ad4902476cbaa489edbfa (diff) | |
Fix numerous doxygen shortcomings, and workaround some clang -Wdocumentation warnings
Diffstat (limited to 'Eigen/src/OrderingMethods/Amd.h')
| -rw-r--r-- | Eigen/src/OrderingMethods/Amd.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Eigen/src/OrderingMethods/Amd.h b/Eigen/src/OrderingMethods/Amd.h index 323255e0a..d1d08ca57 100644 --- a/Eigen/src/OrderingMethods/Amd.h +++ b/Eigen/src/OrderingMethods/Amd.h @@ -84,8 +84,11 @@ StorageIndex cs_tdfs(StorageIndex j, StorageIndex k, StorageIndex *head, const S /** \internal * \ingroup OrderingMethods_Module * Approximate minimum degree ordering algorithm. - * \returns the permutation P reducing the fill-in of the input matrix \a C - * The input matrix \a C must be a selfadjoint compressed column major SparseMatrix object. Both the upper and lower parts have to be stored, but the diagonal entries are optional. + * + * \param[in] C the input selfadjoint matrix stored in compressed column major format. + * \param[out] perm the permutation P reducing the fill-in of the input matrix \a C + * + * Note that the input matrix \a C must be complete, that is both the upper and lower parts have to be stored, as well as the diagonal entries. * On exit the values of C are destroyed */ template<typename Scalar, typename StorageIndex> void minimum_degree_ordering(SparseMatrix<Scalar,ColMajor,StorageIndex>& C, PermutationMatrix<Dynamic,Dynamic,StorageIndex>& perm) |