[mlpack-svn] r17094 - in mlpack/trunk/src/mlpack: . core/util methods/linear_regression methods/pca

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: sumedhghaisas
Date: Thu Aug 21 13:56:01 2014
New Revision: 17094

Log:
* added AMF tutorial to index page
* minor changes to doc files


Modified:
   mlpack/trunk/src/mlpack/core.hpp
   mlpack/trunk/src/mlpack/core/util/prefixedoutstream.hpp
   mlpack/trunk/src/mlpack/methods/linear_regression/linear_regression.hpp
   mlpack/trunk/src/mlpack/methods/pca/pca.hpp

Modified: mlpack/trunk/src/mlpack/core.hpp
==============================================================================
--- mlpack/trunk/src/mlpack/core.hpp	(original)
+++ mlpack/trunk/src/mlpack/core.hpp	Thu Aug 21 13:56:01 2014
@@ -73,6 +73,7 @@
  *  - @ref emst_tutorial
  *  - @ref kmtutorial
  *  - @ref fmkstutorial
+ *  - @ref amftutorial
  *
  * @section methods Methods in MLPACK
  *

Modified: mlpack/trunk/src/mlpack/core/util/prefixedoutstream.hpp
==============================================================================
--- mlpack/trunk/src/mlpack/core/util/prefixedoutstream.hpp	(original)
+++ mlpack/trunk/src/mlpack/core/util/prefixedoutstream.hpp	Thu Aug 21 13:56:01 2014
@@ -56,6 +56,8 @@
    *
    * @param destination ostream which receives output from this object.
    * @param prefix The prefix to prepend to each line.
+   * @param ignoreInput if true the stream will not be printed
+   * @param fatal is true program will exit after printing a line
    */
   PrefixedOutStream(std::ostream& destination,
                     const char* prefix,

Modified: mlpack/trunk/src/mlpack/methods/linear_regression/linear_regression.hpp
==============================================================================
--- mlpack/trunk/src/mlpack/methods/linear_regression/linear_regression.hpp	(original)
+++ mlpack/trunk/src/mlpack/methods/linear_regression/linear_regression.hpp	Thu Aug 21 13:56:01 2014
@@ -25,6 +25,7 @@
    *
    * @param predictors X, matrix of data points to create B with.
    * @param responses y, the measured data for each point in X
+   * @param lambda regularization constant
    */
   LinearRegression(const arma::mat& predictors,
                    const arma::vec& responses,
@@ -71,7 +72,7 @@
    *
    * As this number decreases to 0, the linear regression fit is better.
    *
-   * @param predictors Matrix of predictors (X).
+   * @param points Matrix of predictors (X).
    * @param responses Vector of responses (y).
    */
   double ComputeError(const arma::mat& points,

Modified: mlpack/trunk/src/mlpack/methods/pca/pca.hpp
==============================================================================
--- mlpack/trunk/src/mlpack/methods/pca/pca.hpp	(original)
+++ mlpack/trunk/src/mlpack/methods/pca/pca.hpp	Thu Aug 21 13:56:01 2014
@@ -51,7 +51,7 @@
    *
    * @param data Data matrix.
    * @param transformedData Matrix to store results of PCA in.
-   * @param eigval Vector to put eigenvalues into.
+   * @param eigVal Vector to put eigenvalues into.
    */
   void Apply(const arma::mat& data,
              arma::mat& transformedData,