Merge pull request #750 from pluskid/multiclass

added doc to kill warnings
shogun-toolbox · Aug 21, 2012 · 4cbdfa4 · 4cbdfa4
2 parents 4ec5ff5 + 2590cf5
commit 4cbdfa4
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 1 deletion.
diff --git a/src/shogun/features/DenseSubsetFeatures.h b/src/shogun/features/DenseSubsetFeatures.h
@@ -21,6 +21,7 @@ template<class ST> class CDenseFeatures;
 template<class ST> class SGVector;
 class CDotFeatures;
 
+/** SubsetFeatures wrap features but only uses a subset of the variables */
 template<class ST> class CDenseSubsetFeatures: public CDotFeatures
 {
 public:

diff --git a/src/shogun/machine/BaseMulticlassMachine.h b/src/shogun/machine/BaseMulticlassMachine.h
@@ -18,6 +18,8 @@ namespace shogun
 
 class CMachine;
 
+/** Base class of all Multiclass Machines.
+ */
 class CBaseMulticlassMachine: public CMachine
 {
 public:

diff --git a/src/shogun/multiclass/ShareBoostOptimizer.h b/src/shogun/multiclass/ShareBoostOptimizer.h
@@ -16,6 +16,7 @@
 namespace shogun
 {
 
+/** Utility for ShareBoost to handle optimization */
 class ShareBoostOptimizer
 {
 public:

diff --git a/src/shogun/multiclass/tree/RandomConditionalProbabilityTree.h b/src/shogun/multiclass/tree/RandomConditionalProbabilityTree.h
@@ -16,6 +16,8 @@
 namespace shogun
 {
 
+/** Conditional Probability Tree, decide subtree by a random strategy.
+ */
 class CRandomConditionalProbabilityTree: public CConditionalProbabilityTree
 {
 public:

diff --git a/src/shogun/multiclass/tree/RelaxedTreeNodeData.h b/src/shogun/multiclass/tree/RelaxedTreeNodeData.h
@@ -16,6 +16,7 @@
 namespace shogun
 {
 
+/** Data for the tree nodes in a RelaxedTree */
 struct RelaxedTreeNodeData
 {
 	/** mu */

diff --git a/src/shogun/multiclass/tree/RelaxedTreeUtil.h b/src/shogun/multiclass/tree/RelaxedTreeUtil.h
@@ -19,6 +19,7 @@
 namespace shogun
 {
 
+/** Utility class for CRelaxedTree */
 class RelaxedTreeUtil
 {
 public:

diff --git a/src/shogun/multiclass/tree/TreeMachineNode.h b/src/shogun/multiclass/tree/TreeMachineNode.h
@@ -17,6 +17,7 @@
 namespace shogun
 {
 
+/** The node of the tree structure forming a TreeMachine */
 template <typename T>
 class CTreeMachineNode
 	: public CSGObject
@@ -104,10 +105,10 @@ class CTreeMachineNode
 	/** extra data carried by the tree node */
 	T data;
 
+	typedef void (*data_print_func_t) (const T&);
 	/** debug print the tree structure
 	 * @param data_print_func the function to print the data payload
 	 */
-	typedef void (*data_print_func_t) (const T&);
 	void debug_print(data_print_func_t data_print_func)
 	{
 		debug_print_impl(data_print_func, this, 0);
@@ -119,6 +120,7 @@ class CTreeMachineNode
 	CTreeMachineNode *m_parent;  ///< parent node
 	int32_t           m_machine; ///< machine index associated with this node
 
+    /** implementation of printing the tree for debugging purpose */
 	static void debug_print_impl(data_print_func_t data_print_func, CTreeMachineNode<T> *node, int32_t depth)
 	{
 		for (int32_t i=0; i < depth; ++i)

diff --git a/src/shogun/multiclass/tree/VwConditionalProbabilityTree.h b/src/shogun/multiclass/tree/VwConditionalProbabilityTree.h
@@ -19,6 +19,7 @@
 namespace shogun
 {
 
+/** Tree Data for Vowpal Wabbit Conditional Probability Tree */
 struct VwConditionalProbabilityTreeNodeData
 {
 	int32_t label;
@@ -27,6 +28,7 @@ struct VwConditionalProbabilityTreeNodeData
 	VwConditionalProbabilityTreeNodeData():label(-1), p_right(0) {}
 };
 
+/** Conditional Probability Tree using Vowpal Wabbit for base machine. */
 class CVwConditionalProbabilityTree: public CTreeMachine<VwConditionalProbabilityTreeNodeData>
 {
 public: