From c7a3aa70075673ffa4b97bd623857eeb93c0130a Mon Sep 17 00:00:00 2001
From: Ryan Curtin <ryan@ratml.org>
Date: Mon, 9 Feb 2015 11:07:53 -0500
Subject: [PATCH] Fix documentation; thanks to Kumar.

---
 src/mlpack/methods/amf/amf.hpp | 80 +++++++++++++++++-----------------
 1 file changed, 40 insertions(+), 40 deletions(-)

diff --git a/src/mlpack/methods/amf/amf.hpp b/src/mlpack/methods/amf/amf.hpp
index d6ac467a60..e7631b7379 100644
--- a/src/mlpack/methods/amf/amf.hpp
+++ b/src/mlpack/methods/amf/amf.hpp
@@ -54,7 +54,7 @@ namespace amf /** Alternating Matrix Factorization **/ {
  * arma::mat H; // Encoding matrix
  *
  * AMF<> amf; // Default options: NMF with multiplicative distance update rules.
- * amf.Apply(V, W, H, r);
+ * amf.Apply(V, r, W, H);
  * @endcode
  *
  * @tparam TerminationPolicy The policy to use for determining when the
@@ -133,15 +133,15 @@ class AMF
 }; // class AMF
 
 typedef amf::AMF<amf::SimpleResidueTermination,
-                 amf::RandomInitialization, 
+                 amf::RandomInitialization,
                  amf::NMFALSUpdate> NMFALSFactorizer;
 
-//! Add simple typedefs 
+//! Add simple typedefs
 #ifdef MLPACK_USE_CXX11
 
 /**
  * SVDBatchFactorizer factorizes given matrix V into two matrices W and H by
- * gradient descent. SVD batch learning is described in paper 'A Guide to 
+ * gradient descent. SVD batch learning is described in paper 'A Guide to
  * singular Value Decomposition' by Chih-Chao Ma.
  *
  * @see SVDBatchLearning
@@ -152,25 +152,25 @@ using SVDBatchFactorizer = amf::AMF<amf::SimpleToleranceTermination<MatType>,
                                     amf::SVDBatchLearning>;
 
 /**
- * SVDIncompleteIncrementalFactorizer factorizes given matrix V into two matrices 
- * W and H by incomplete incremental gradient descent. SVD incomplete incremental 
- * learning is described in paper 'A Guide to singular Value Decomposition' 
+ * SVDIncompleteIncrementalFactorizer factorizes given matrix V into two matrices
+ * W and H by incomplete incremental gradient descent. SVD incomplete incremental
+ * learning is described in paper 'A Guide to singular Value Decomposition'
  * by Chih-Chao Ma.
  *
  * @see SVDIncompleteIncrementalLearning
- */                                    
+ */
 template<class MatType>
 using SVDIncompleteIncrementalFactorizer = amf::AMF<amf::SimpleToleranceTermination<MatType>,
                                                     amf::RandomInitialization,
                                                     amf::SVDIncompleteIncrementalLearning>;
 /**
- * SVDCompleteIncrementalFactorizer factorizes given matrix V into two matrices 
- * W and H by complete incremental gradient descent. SVD complete incremental 
- * learning is described in paper 'A Guide to singular Value Decomposition' 
+ * SVDCompleteIncrementalFactorizer factorizes given matrix V into two matrices
+ * W and H by complete incremental gradient descent. SVD complete incremental
+ * learning is described in paper 'A Guide to singular Value Decomposition'
  * by Chih-Chao Ma.
  *
  * @see SVDCompleteIncrementalLearning
- */                                                        
+ */
 template<class MatType>
 using SVDCompleteIncrementalFactorizer = amf::AMF<amf::SimpleToleranceTermination<MatType>,
                                                   amf::RandomInitialization,
@@ -179,76 +179,76 @@ using SVDCompleteIncrementalFactorizer = amf::AMF<amf::SimpleToleranceTerminatio
 #else // #ifdef MLPACK_USE_CXX11
 
 /**
- * SparseSVDBatchFactorizer factorizes given sparse matrix V into two matrices 
- * W and H by gradient descent. SVD batch learning is described in paper 'A Guide to 
- * singular Value Decomposition' by Chih-Chao Ma. 
+ * SparseSVDBatchFactorizer factorizes given sparse matrix V into two matrices
+ * W and H by gradient descent. SVD batch learning is described in paper 'A Guide to
+ * singular Value Decomposition' by Chih-Chao Ma.
  *
  * @see SVDBatchLearning
- */              
+ */
 typedef amf::AMF<amf::SimpleToleranceTermination<arma::sp_mat>,
                  amf::RandomInitialization,
                  amf::SVDBatchLearning> SparseSVDBatchFactorizer;
 
 /**
- * SparseSVDBatchFactorizer factorizes given matrix V into two matrices 
- * W and H by gradient descent. SVD batch learning is described in paper 'A Guide to 
- * singular Value Decomposition' by Chih-Chao Ma. 
+ * SparseSVDBatchFactorizer factorizes given matrix V into two matrices
+ * W and H by gradient descent. SVD batch learning is described in paper 'A Guide to
+ * singular Value Decomposition' by Chih-Chao Ma.
  *
  * @see SVDBatchLearning
- */             
+ */
 typedef amf::AMF<amf::SimpleToleranceTermination<arma::mat>,
                  amf::RandomInitialization,
                  amf::SVDBatchLearning> SVDBatchFactorizer;
 /**
- * SparseSVDIncompleteIncrementalFactorizer factorizes given sparse matrix V 
- * into two matrices W and H by incomplete incremental gradient descent. 
- * SVD incomplete incremental learning is described in paper 'A Guide to singular 
+ * SparseSVDIncompleteIncrementalFactorizer factorizes given sparse matrix V
+ * into two matrices W and H by incomplete incremental gradient descent.
+ * SVD incomplete incremental learning is described in paper 'A Guide to singular
  * Value Decomposition' by Chih-Chao Ma.
  *
  * @see SVDIncompleteIncrementalLearning
- */                   
+ */
 typedef amf::AMF<amf::SimpleToleranceTermination<arma::sp_mat>,
                  amf::RandomInitialization,
-                 amf::SVDIncompleteIncrementalLearning> 
+                 amf::SVDIncompleteIncrementalLearning>
         SparseSVDIncompleteIncrementalFactorizer;
 
 /**
- * SVDIncompleteIncrementalFactorizer factorizes given matrix V into two matrices 
- * W and H by incomplete incremental gradient descent. SVD incomplete incremental 
- * learning is described in paper 'A Guide to singular Value Decomposition' 
+ * SVDIncompleteIncrementalFactorizer factorizes given matrix V into two matrices
+ * W and H by incomplete incremental gradient descent. SVD incomplete incremental
+ * learning is described in paper 'A Guide to singular Value Decomposition'
  * by Chih-Chao Ma.
  *
  * @see SVDIncompleteIncrementalLearning
- */              
+ */
 typedef amf::AMF<amf::SimpleToleranceTermination<arma::mat>,
                  amf::RandomInitialization,
-                 amf::SVDIncompleteIncrementalLearning> 
+                 amf::SVDIncompleteIncrementalLearning>
         SVDIncompleteIncrementalFactorizer;
 
 /**
- * SparseSVDCompleteIncrementalFactorizer factorizes given sparse matrix V 
- * into two matrices W and H by complete incremental gradient descent. SVD 
- * complete incremental learning is described in paper 'A Guide to singular 
+ * SparseSVDCompleteIncrementalFactorizer factorizes given sparse matrix V
+ * into two matrices W and H by complete incremental gradient descent. SVD
+ * complete incremental learning is described in paper 'A Guide to singular
  * Value Decomposition' by Chih-Chao Ma.
  *
  * @see SVDCompleteIncrementalLearning
- */   
+ */
 typedef amf::AMF<amf::SimpleToleranceTermination<arma::sp_mat>,
                  amf::RandomInitialization,
-                 amf::SVDCompleteIncrementalLearning<arma::sp_mat> > 
+                 amf::SVDCompleteIncrementalLearning<arma::sp_mat> >
         SparseSVDCompleteIncrementalFactorizer;
 
 /**
- * SVDCompleteIncrementalFactorizer factorizes given matrix V into two matrices 
- * W and H by complete incremental gradient descent. SVD complete incremental 
- * learning is described in paper 'A Guide to singular Value Decomposition' 
+ * SVDCompleteIncrementalFactorizer factorizes given matrix V into two matrices
+ * W and H by complete incremental gradient descent. SVD complete incremental
+ * learning is described in paper 'A Guide to singular Value Decomposition'
  * by Chih-Chao Ma.
  *
  * @see SVDCompleteIncrementalLearning
- */                      
+ */
 typedef amf::AMF<amf::SimpleToleranceTermination<arma::mat>,
                  amf::RandomInitialization,
-                 amf::SVDCompleteIncrementalLearning<arma::mat> > 
+                 amf::SVDCompleteIncrementalLearning<arma::mat> >
         SVDCompleteIncrementalFactorizer;
 
 #endif // #ifdef MLPACK_USE_CXX11