[PPL-devel] [GIT] ppl/ppl(master): Document parameter indent_level in PIP_Tree_Node:: solve().

[Enea Zaffanella]

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

Author: Enea Zaffanella <zaffanella at cs.unipr.it>
Date:   Mon Feb 14 11:57:05 2011 +0100

Document parameter indent_level in PIP_Tree_Node::solve().

---

 src/PIP_Tree.defs.hh |   20 +++++++++++++-------
 1 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/src/PIP_Tree.defs.hh b/src/PIP_Tree.defs.hh
index e7de640..3dec637 100644
--- a/src/PIP_Tree.defs.hh
+++ b/src/PIP_Tree.defs.hh
@@ -205,13 +205,16 @@ protected:
 
     \param space_dim
     The space dimension of parent, including artificial parameters.
+
+    \param indent_level
+    The indentation level (for debugging output only).
   */
   virtual PIP_Tree_Node* solve(const PIP_Problem& pip,
                                bool check_feasible_context,
                                const Matrix& context,
                                const Variables_Set& params,
                                dimension_type space_dim,
-                               unsigned recursion_depth) = 0;
+                               unsigned indent_level) = 0;
 
   //! Inserts a new parametric constraint in internal row format
   void add_constraint(const Row& x, const Variables_Set& parameters);
@@ -648,25 +651,28 @@ protected:
                                const Matrix& context,
                                const Variables_Set& params,
                                dimension_type space_dim,
-                               unsigned recursion_depth);
+                               unsigned indent_level);
 
   /*! \brief
     Generate a Gomory cut using non-integer tableau row \p i.
 
     \param i
-    row index in simplex tableau from which the cut is generated
+    Row index in simplex tableau from which the cut is generated
 
     \param parameters
-    a std::set of the current parameter dimensions (including artificials);
+    A std::set of the current parameter dimensions (including artificials);
     to be updated if a new artificial parameter is to be created
 
     \param context
-    a set of linear inequalities on the parameters, in matrix form; to be
+    A set of linear inequalities on the parameters, in matrix form; to be
     updated if a new artificial parameter is to be created
 
     \param space_dimension
-    the current space dimension, including variables and all parameters; to
+    The current space dimension, including variables and all parameters; to
     be updated if an extra parameter is to be created
+
+    \param indent_level
+    The indentation level (for debugging output only).
   */
   void generate_cut(dimension_type i, Variables_Set& parameters,
                     Matrix& context, dimension_type& space_dimension,
@@ -781,7 +787,7 @@ protected:
                                const Matrix& context,
                                const Variables_Set& params,
                                dimension_type space_dim,
-                               unsigned recursion_depth);
+                               unsigned indent_level);
 
   //! Prints on \p s the tree rooted in \p *this.
   virtual void print_tree(std::ostream& s, unsigned indent,