From 3d9150870d6a62b2641ae835f07e182ddceda7c7 Mon Sep 17 00:00:00 2001 From: Desire NUENTSA Date: Mon, 21 Jan 2013 15:39:18 +0100 Subject: Fix documentation for SparseLU --- Eigen/src/SparseCore/SparseColEtree.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'Eigen/src/SparseCore/SparseColEtree.h') 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 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 */ -- cgit v1.2.3