Added some notes to preprocessors

shogun-toolbox · Oct 7, 2011 · 5f2a5c8 · 5f2a5c8
1 parent a0cc551
commit 5f2a5c8
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 13 deletions.
diff --git a/src/shogun/preprocessor/HessianLocallyLinearEmbedding.h b/src/shogun/preprocessor/HessianLocallyLinearEmbedding.h
@@ -20,7 +20,6 @@ namespace shogun
 {
 
 class CFeatures;
-
 class CDistance;
 
 /** @brief the class HessianLocallyLinearEmbedding used to preprocess
@@ -65,6 +64,7 @@ class CHessianLocallyLinearEmbedding: public CLocallyLinearEmbedding
 	/** get type */
 	virtual EPreprocessorType get_type() const;
 
+/// HELPER
 protected:
 
 	/** construct weight matrix 
@@ -75,6 +75,7 @@ class CHessianLocallyLinearEmbedding: public CLocallyLinearEmbedding
 	virtual SGMatrix<float64_t> construct_weight_matrix(CSimpleFeatures<float64_t>* simple_features,float64_t* W_matrix, 
                                                             SGMatrix<int32_t> neighborhood_matrix);
 
+/// THREAD
 protected:
 
 	/** run hessian estimation thread

diff --git a/src/shogun/preprocessor/KernelLocalTangentSpaceAlignment.h b/src/shogun/preprocessor/KernelLocalTangentSpaceAlignment.h
@@ -56,14 +56,16 @@ class CKernelLocalTangentSpaceAlignment: public CKernelLocallyLinearEmbedding
 	/** get type */
 	virtual EPreprocessorType get_type() const;
 
+/// HELPERS
 protected:
 
 	/** construct weight matrix 
 	 */
 	virtual SGMatrix<float64_t> construct_weight_matrix(SGMatrix<float64_t> kernel_matrix, 
-                                                            SGMatrix<int32_t> neighborhood_matrix,
+	                                                    SGMatrix<int32_t> neighborhood_matrix,
 	                                                    int32_t target_dim);
 
+/// THREADS
 protected:
 
 	/** run kernel ltsa thread

diff --git a/src/shogun/preprocessor/KernelLocallyLinearEmbedding.h b/src/shogun/preprocessor/KernelLocallyLinearEmbedding.h
@@ -21,7 +21,6 @@ namespace shogun
 {
 
 class CFeatures;
-
 class CKernel;
 
 /** @brief the class KernelLocallyLinearEmbedding used to preprocess
@@ -72,6 +71,7 @@ class CKernelLocallyLinearEmbedding: public CLocallyLinearEmbedding
 	/** get type */
 	virtual EPreprocessorType get_type() const;
 
+/// HELPERS
 protected:
 
 	/** default init */
@@ -82,6 +82,17 @@ class CKernelLocallyLinearEmbedding: public CLocallyLinearEmbedding
 	                                                    SGMatrix<int32_t> neighborhood_matrix,
 	                                                    int32_t target_dim);
 
+	/** construct neighborhood matrix by kernel matrix
+	 * @param kernel_matrix kernel matrix to be used
+	 * @return matrix containing indexes of neighbors of i-th object
+	 * in i-th column
+	 */
+	SGMatrix<int32_t> get_neighborhood_matrix(SGMatrix<float64_t> kernel_matrix);
+
+
+/// THREADS
+protected:
+
 	/** runs neighborhood determination thread
 	 * @param p thread params
 	 */
@@ -92,13 +103,6 @@ class CKernelLocallyLinearEmbedding: public CLocallyLinearEmbedding
 	 */
 	static void* run_linearreconstruction_thread(void* p);
 
-	/** construct neighborhood matrix by kernel matrix
-	 * @param kernel_matrix kernel matrix to be used
-	 * @return matrix containing indexes of neighbors of i-th object
-	 * in i-th column
-	 */
-	SGMatrix<int32_t> get_neighborhood_matrix(SGMatrix<float64_t> kernel_matrix);
-
 };
 }
 

diff --git a/src/shogun/preprocessor/LocalTangentSpaceAlignment.h b/src/shogun/preprocessor/LocalTangentSpaceAlignment.h
@@ -20,10 +20,8 @@ namespace shogun
 {
 
 class CFeatures;
-
 class CDistance;
 
-
 /** @brief the class LocalTangentSpaceAlignment used to preprocess
  * data using Local Tangent Space Alignment (LTSA) algorithm as described in:
  *
@@ -67,6 +65,7 @@ class CLocalTangentSpaceAlignment: public CLocallyLinearEmbedding
 	/** get type */
 	virtual EPreprocessorType get_type() const;
 
+/// HELPER
 protected:
 
 	/** construct weight matrix 
@@ -77,6 +76,7 @@ class CLocalTangentSpaceAlignment: public CLocallyLinearEmbedding
 	virtual SGMatrix<float64_t> construct_weight_matrix(CSimpleFeatures<float64_t>* simple_features,float64_t* W_matrix, 
                                                             SGMatrix<int32_t> neighborhood_matrix);
 
+/// THREAD
 protected:
 
 	/** run ltsa thread

diff --git a/src/shogun/preprocessor/MultidimensionalScaling.h b/src/shogun/preprocessor/MultidimensionalScaling.h
@@ -20,7 +20,6 @@ namespace shogun
 {
 
 class CFeatures;
-
 class CDistance;
 
 /** @brief the class Multidimensionalscaling is used to perform
@@ -127,6 +126,7 @@ class CMultidimensionalScaling: public CDimensionReductionPreprocessor<float64_t
 	 */
 	bool get_landmark() const;
 
+/// HELPERS
 protected:
 
 	/** default initialization */
@@ -144,6 +144,7 @@ class CMultidimensionalScaling: public CDimensionReductionPreprocessor<float64_t
 	 */
 	SGMatrix<float64_t> landmark_embedding(SGMatrix<float64_t> distance_matrix);
 
+/// FIELDS
 protected:
 
 	/** last embedding eigenvalues */
@@ -155,6 +156,7 @@ class CMultidimensionalScaling: public CDimensionReductionPreprocessor<float64_t
 	/** number of landmarks */
 	int32_t m_landmark_number;
 
+/// STATIC
 protected:
 
 	/** run triangulation thread for landmark embedding