[mlpack] 12/149: Add comment pointing out that there is a bug.

[Barak A. Pearlmutter]

This is an automated email from the git hooks/post-receive script.

bap pushed a commit to branch svn-trunk
in repository mlpack.

commit c91611781a1d356dbeb6f86d65d1e65de0a9d379
Author: rcurtin <rcurtin at 9d5b8971-822b-0410-80eb-d18c1038ef23>
Date:   Tue Sep 16 21:04:26 2014 +0000

    Add comment pointing out that there is a bug.
    
    
    git-svn-id: http://svn.cc.gatech.edu/fastlab/mlpack/trunk@17186 9d5b8971-822b-0410-80eb-d18c1038ef23
---
 src/mlpack/core/tree/rectangle_tree/x_tree_split.hpp | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/src/mlpack/core/tree/rectangle_tree/x_tree_split.hpp b/src/mlpack/core/tree/rectangle_tree/x_tree_split.hpp
index a6800ac..68de44c 100644
--- a/src/mlpack/core/tree/rectangle_tree/x_tree_split.hpp
+++ b/src/mlpack/core/tree/rectangle_tree/x_tree_split.hpp
@@ -2,8 +2,10 @@
  * @file x_tre_split.hpp
  * @author Andrew Wells
  *
- * Defintion of the XTreeSplit class, a class that splits the nodes of an X tree, starting
- * at a leaf node and moving upwards if necessary.
+ * Defintion of the XTreeSplit class, a class that splits the nodes of an X
+ * tree, starting at a leaf node and moving upwards if necessary.
+ *
+ * This is known to have a bug: see #368.
  */
 #ifndef __MLPACK_CORE_TREE_RECTANGLE_TREE_X_TREE_SPLIT_HPP
 #define __MLPACK_CORE_TREE_RECTANGLE_TREE_X_TREE_SPLIT_HPP
@@ -25,11 +27,11 @@ class XTreeSplit
 {
 public:
 
-/** 
+/**
  * The X-tree paper says that a maximum allowable overlap of 20% works well.
  */
 const static double MAX_OVERLAP = 0.2;
-  
+
 /**
  * Split a leaf node using the algorithm described in "The R*-tree: An Efficient and Robust Access method
  * for Points and Rectangles."  If necessary, this split will propagate
@@ -38,7 +40,7 @@ const static double MAX_OVERLAP = 0.2;
 static void SplitLeafNode(RectangleTree<XTreeSplit<DescentType, StatisticType, MatType>, DescentType, StatisticType, MatType>* tree, std::vector<bool>& relevels);
 
 /**
- * Split a non-leaf node using the "default" algorithm.  If this is a root node, the 
+ * Split a non-leaf node using the "default" algorithm.  If this is a root node, the
  * tree increases in depth.
  */
 static bool SplitNonLeafNode(RectangleTree<XTreeSplit<DescentType, StatisticType, MatType>, DescentType, StatisticType, MatType>* tree, std::vector<bool>& relevels);
@@ -75,4 +77,4 @@ static void InsertNodeIntoTree(
 // Include implementation
 #include "x_tree_split_impl.hpp"
 
-#endif
\ No newline at end of file
+#endif

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/mlpack.git