[mlpack-svn] r13535 - mlpack/trunk/src/mlpack/core/tree

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: rcurtin
Date: 2012-09-11 16:34:12 -0400 (Tue, 11 Sep 2012)
New Revision: 13535

Modified:
   mlpack/trunk/src/mlpack/core/tree/hrectbound.hpp
Log:
Update documentation for the HRectBound.


Modified: mlpack/trunk/src/mlpack/core/tree/hrectbound.hpp
===================================================================
--- mlpack/trunk/src/mlpack/core/tree/hrectbound.hpp	2012-09-11 20:34:01 UTC (rev 13534)
+++ mlpack/trunk/src/mlpack/core/tree/hrectbound.hpp	2012-09-11 20:34:12 UTC (rev 13535)
@@ -16,9 +16,13 @@
 namespace bound {
 
 /**
- * Hyper-rectangle bound for an L-metric.
+ * Hyper-rectangle bound for an L-metric.  This should be used in conjunction
+ * with the LMetric class.  Be sure to use the same template parameters for
+ * LMetric as you do for HRectBound -- otherwise odd results may occur.
  *
- * Template parameter Power is the metric to use; use 2 for Euclidean (L2).
+ * @tparam Power The metric to use; use 2 for Euclidean (L2).
+ * @tparam TakeRoot Whether or not the root should be taken (see LMetric
+ *     documentation).
  */
 template<int Power = 2, bool TakeRoot = false>
 class HRectBound