diff options
author | 2013-01-21 15:39:18 +0100 | |
---|---|---|
committer | 2013-01-21 15:39:18 +0100 | |
commit | 3d9150870d6a62b2641ae835f07e182ddceda7c7 (patch) | |
tree | 66cdfc9c000ff9bb3cc9e77e96b4db60e95eaac5 /Eigen/src/SparseCore | |
parent | d2dd5063b6f52e16e15790eac7c9d1f57a60c96f (diff) |
Fix documentation for SparseLU
Diffstat (limited to 'Eigen/src/SparseCore')
-rw-r--r-- | Eigen/src/SparseCore/SparseColEtree.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Eigen/src/SparseCore/SparseColEtree.h b/Eigen/src/SparseCore/SparseColEtree.h index 2d7c85a08..df6b9f966 100644 --- a/Eigen/src/SparseCore/SparseColEtree.h +++ b/Eigen/src/SparseCore/SparseColEtree.h @@ -52,8 +52,9 @@ int etree_find (int i, IndexVector& pp) } /** Compute the column elimination tree of a sparse matrix - * NOTE : The matrix is supposed to be in column-major format. - * + * \param mat The matrix in column-major format. + * \param parent The elimination tree + * \param firstRowElt The column index of the first element in each row */ template <typename MatrixType, typename IndexVector> int coletree(const MatrixType& mat, IndexVector& parent, IndexVector& firstRowElt) @@ -161,7 +162,8 @@ void nr_etdfs (int n, IndexVector& parent, IndexVector& first_kid, IndexVector& /** - * Post order a tree + * \brief Post order a tree + * \param n the number of nodes * \param parent Input tree * \param post postordered tree */ |