[mlpack-git] master: Add a basic comment. (d39a6b2)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/de9cc4b05069e1fa4793d9355f2f595af5ff45d2...6070527af14296cd99739de6c62666cc5d2a2125

>---------------------------------------------------------------

commit d39a6b28e59205e28c5500176a3f411d18ab681a
Author: ryan <ryan at ratml.org>
Date:   Tue Sep 15 18:40:08 2015 -0400

    Add a basic comment.


>---------------------------------------------------------------

d39a6b28e59205e28c5500176a3f411d18ab681a
 .../hoeffding_trees/hoeffding_categorical_split.hpp   | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/src/mlpack/methods/hoeffding_trees/hoeffding_categorical_split.hpp b/src/mlpack/methods/hoeffding_trees/hoeffding_categorical_split.hpp
index 6d6f9e7..e870445 100644
--- a/src/mlpack/methods/hoeffding_trees/hoeffding_categorical_split.hpp
+++ b/src/mlpack/methods/hoeffding_trees/hoeffding_categorical_split.hpp
@@ -11,6 +11,25 @@
 namespace mlpack {
 namespace tree {
 
+/**
+ * This is the standard Hoeffding-bound categorical feature proposed in the
+ * paper below:
+ *
+ * @code
+ * @inproceedings{domingos2000mining,
+ *   title={{Mining High-Speed Data Streams}},
+ *   author={Domingos, P. and Hulten, G.},
+ *   year={2000},
+ *   booktitle={Proceedings of the Sixth ACM SIGKDD International Conference on
+ *       Knowledge Discovery and Data Mining (KDD '00)},
+ *   pages={71--80}
+ * }
+ * @endcode
+ *
+ * This class will track the sufficient statistics of the training points it has
+ * seen.  The HoeffdingSplit class (and other related classes) can use this
+ * class to track categorical features and split decision tree nodes.
+ */
 template<typename FitnessFunction>
 class HoeffdingCategoricalSplit
 {