[PPL-devel] [GIT] ppl/ppl(sparse_matrices): Update some comments referring to the Dense_Matrix class.

[Marco Poletti]

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

Author: Marco Poletti <poletti.marco at gmail.com>
Date:   Sun Dec 26 23:16:45 2010 +0100

Update some comments referring to the Dense_Matrix class.

---

 src/Congruence_System.defs.hh |    2 +-
 src/Grid.defs.hh              |   12 ++++++------
 src/Matrix.defs.hh            |   18 ++----------------
 3 files changed, 9 insertions(+), 23 deletions(-)

diff --git a/src/Congruence_System.defs.hh b/src/Congruence_System.defs.hh
index c66591e..d0bd438 100644
--- a/src/Congruence_System.defs.hh
+++ b/src/Congruence_System.defs.hh
@@ -310,7 +310,7 @@ public:
 #ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
   /*!
     Returns <CODE>true</CODE> if and only if \p *this is a valid
-    Dense_Matrix, each row in the system is a valid Congruence and the
+    Matrix, each row in the system is a valid Congruence and the
     number of columns is consistent with the number of congruences.
   */
 #endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
diff --git a/src/Grid.defs.hh b/src/Grid.defs.hh
index 3d523fc..a056dff 100644
--- a/src/Grid.defs.hh
+++ b/src/Grid.defs.hh
@@ -2432,7 +2432,7 @@ private:
     Uses the line \p pivot to change the representation of the line \p
     row so that the element at index \p col of \p row is zero.
   */
-  // A member of Grid for access to Dense_Matrix::rows.
+  // A member of Grid for access to Matrix<Dense_Row>::rows.
   static void reduce_line_with_line(Grid_Generator& row,
 				    Grid_Generator& pivot,
 				    dimension_type col);
@@ -2443,7 +2443,7 @@ private:
     equality \p row so that the element at index \p col of \p row is
     zero.
   */
-  // A member of Grid for access to Dense_Matrix::rows.
+  // A member of Grid for access to Matrix<Dense_Row>::rows.
   static void reduce_equality_with_equality(Congruence& row,
 					    const Congruence& pivot,
 					    dimension_type col);
@@ -2456,7 +2456,7 @@ private:
     is zero.  Only elements from index \p start to index \p end are
     modified (i.e. it is assumed that all other elements are zero).
   */
-  // Part of Grid for access to Dense_Matrix::rows.
+  // Part of Grid for access to Matrix<Dense_Row>::rows.
   template <typename R>
   static void reduce_pc_with_pc(R& row,
 				R& pivot,
@@ -2470,7 +2470,7 @@ private:
     parameter \p row such that the element at index \p col of \p row
     is zero.
   */
-  // A member of Grid for access to Dense_Matrix::rows.
+  // A member of Grid for access to Matrix<Dense_Row>::rows.
   static void reduce_parameter_with_line(Grid_Generator& row,
 					 const Grid_Generator& pivot,
 					 dimension_type col,
@@ -2482,7 +2482,7 @@ private:
     congruence \p row such that element at index \p col of \p row is
     zero.
   */
-  // A member of Grid for access to Dense_Matrix::rows.
+  // A member of Grid for access to Matrix<Dense_Row>::rows.
   static void reduce_congruence_with_equality(Congruence& row,
 					      const Congruence& pivot,
 					      dimension_type col,
@@ -2512,7 +2512,7 @@ private:
 			     bool generators = true);
 
   //! Multiply the elements of \p dest by \p multiplier.
-  // A member of Grid for access to Dense_Matrix::rows and cgs::operator[].
+  // A member of Grid for access to Matrix<Dense_Row>::rows and cgs::operator[].
   static void multiply_grid(const Coefficient& multiplier,
 			    Congruence& cg, Congruence_System& dest,
 			    dimension_type num_rows,
diff --git a/src/Matrix.defs.hh b/src/Matrix.defs.hh
index 6d8b088..3d29333 100644
--- a/src/Matrix.defs.hh
+++ b/src/Matrix.defs.hh
@@ -171,8 +171,6 @@ public:
     The matrix is expanded to the specified dimensions avoiding
     reallocation whenever possible.
     The contents of the original matrix is lost.
-
-    This method is provided for compatibility with Dense_Matrix.
   */
   void resize_no_copy(dimension_type new_n_rows, dimension_type new_n_columns,
                       Flags row_flags);
@@ -201,8 +199,6 @@ public:
 
   //! Adds to the matrix \p n rows of zeroes with flags set to \p row_flags.
   /*!
-    Provided for compatibilty with Dense_Matrix.
-
     \param n
     The number of rows to be added: must be strictly positive.
 
@@ -242,8 +238,6 @@ public:
     the \f$(r+1) \times c\f$ matrix
     \f$\genfrac{(}{)}{0pt}{}{M}{y}\f$.
     The matrix is expanded avoiding reallocation whenever possible.
-
-    This method is provided for compatibility with Dense_Matrix.
   */
   void add_recycled_row(Row& y);
 
@@ -253,7 +247,6 @@ public:
     \param n
     The number of row that will be removed.
 
-    Provided for compatibility with Dense_Matrix.
     It is equivalent to num_rows() - n, num_columns()).
 
     This method takes \f$O(n+k)\f$ amortized time, where k is the total number
@@ -266,8 +259,8 @@ public:
 
   //! Permutes the columns of the matrix.
   /*!
-    This method is provided for compatibilty with Dense_Matrix but it is slow
-    and should be avoided if possible.
+    This method may be slow for some Row types, and should be avoided if
+    possible.
 
     \param cycles
     A vector representing the non-trivial cycles of the permutation
@@ -301,8 +294,6 @@ public:
 
   //! Adds \p n columns of zeroes to the matrix.
   /*!
-    Provided for compatibilty with Dense_Matrix.
-
     \param n
     The number of columns to be added: must be strictly positive.
 
@@ -359,8 +350,6 @@ public:
     \param n
     The number of trailing columns that will be removed.
 
-    This method is provided for compatibility with Dense_Matrix.
-
     This operation invalidates existing iterators.
 
     This method takes \f$O(\sum_{j=1}^r (k_j*\log n_j))\f$ amortized time,
@@ -374,9 +363,6 @@ public:
   void remove_trailing_columns(dimension_type n);
 
   //! Equivalent to resize(0,0).
-  /*!
-    Provided for compatibility with Dense_Matrix.
-  */
   void clear();
 
   //! Returns an %iterator pointing to the first row.