Added doxygen comments

shogun-toolbox · Apr 12, 2012 · 3255541 · 3255541
1 parent 04677a7
commit 3255541
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/src/shogun/classifier/NearestCentroid.cpp b/src/shogun/classifier/NearestCentroid.cpp
@@ -43,7 +43,7 @@ namespace shogun{
 
 	void CNearestCentroid::store_model_features()
 	{
-
+		distance->init(m_centroids,distance->get_rhs());
 	}
 
 	bool CNearestCentroid::train_machine(CFeatures* data)
@@ -106,9 +106,6 @@ namespace shogun{
 
 		m_centroids->free_feature_matrix();
 		m_centroids->set_feature_matrix(centroids,num_feats,num_classes);
-
-
-		distance->init(m_centroids,distance->get_rhs());
 
 		m_is_trained=true;
 

diff --git a/src/shogun/classifier/NearestCentroid.h b/src/shogun/classifier/NearestCentroid.h
@@ -64,7 +64,11 @@ class CNearestCentroid : public CDistanceMachine{
 	float64_t get_shrinking() const{
 		return m_shrinking;
 	}
-
+
+	/** Get the centroids
+	 * 
+	 * @return Matrix containing the centroids
+	 */
 	CSimpleFeatures<float64_t>* get_centroids() const{
 		return m_centroids;
 	}
@@ -80,15 +84,26 @@ class CNearestCentroid : public CDistanceMachine{
 	 */
 	virtual bool train_machine(CFeatures* data=NULL);
 
+	/** Stores feature data of underlying model.
+	 *
+	 * Sets centroids as lhs
+	 */
 	virtual void store_model_features();
 
 private:
 	void init();
 
 protected:
+	///	number of classes (i.e. number of values labels can take)
 	int32_t m_num_classes;
+
+	///	Shrinking parameter
 	float64_t m_shrinking;
+
+	///	The centroids of the trained features
 	CSimpleFeatures<float64_t>* m_centroids;
+
+	///	Tells if the classifier has been trained or not
 	bool m_is_trained;
 };