[PPL-devel] [GIT] ppl/ppl(master): Improved doxygen docs for Matrix::permute_columns().

[Enea Zaffanella]

Module: ppl/ppl
Branch: master
Commit: fb8063c03702de01c22e136ef8a12bb2109b28f1
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=fb8063c03702de01c22e136ef8a12bb2109b28f1

Author: Enea Zaffanella <zaffanella at cs.unipr.it>
Date:   Sun Aug 15 15:24:43 2010 +0200

Improved doxygen docs for Matrix::permute_columns().

---

 src/Matrix.defs.hh |    8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/Matrix.defs.hh b/src/Matrix.defs.hh
index 2ee3a24..294d40e 100644
--- a/src/Matrix.defs.hh
+++ b/src/Matrix.defs.hh
@@ -279,13 +279,17 @@ public:
 
     The \p cycles vector contains, one after the other, the
     non-trivial cycles (i.e., the cycles of length greater than one)
-    of a permutation of non-zero column indexes.  Each cycle is
-    terminated by zero.  For example, assuming the matrix has 6
+    of a permutation of \e non-zero column indexes.  Each cycle is
+    terminated by zero.  For example, assuming the matrix has 7
     columns, the permutation \f$ \{ 1 \mapsto 3, 2 \mapsto 4,
     3 \mapsto 6, 4 \mapsto 2, 5 \mapsto 5, 6 \mapsto 1 \}\f$ can be
     represented by the non-trivial cycles \f$(1 3 6)(2 4)\f$ that, in
     turn can be represented by a vector of 6 elements containing 1, 3,
     6, 0, 2, 4, 0.
+
+    \note
+    The first column of the matrix, having index zero, is never involved
+    in a permutation.
   */
   void permute_columns(const std::vector<dimension_type>& cycles);