[mlpack] 39/58: * added AMF tutorial to index page * minor changes to doc files

[Barak A. Pearlmutter]

This is an automated email from the git hooks/post-receive script.

bap pushed a commit to branch svn-trunk
in repository mlpack.

commit 1f1a0ab5bb216ae475e0ce2ee9bf654edac5e4bc
Author: sumedhghaisas <sumedhghaisas at 9d5b8971-822b-0410-80eb-d18c1038ef23>
Date:   Thu Aug 21 17:56:01 2014 +0000

    * added AMF tutorial to index page
    * minor changes to doc files
    
    
    git-svn-id: http://svn.cc.gatech.edu/fastlab/mlpack/trunk@17094 9d5b8971-822b-0410-80eb-d18c1038ef23
---
 src/mlpack/core.hpp                                        | 1 +
 src/mlpack/core/util/prefixedoutstream.hpp                 | 2 ++
 src/mlpack/methods/linear_regression/linear_regression.hpp | 3 ++-
 src/mlpack/methods/pca/pca.hpp                             | 2 +-
 4 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/mlpack/core.hpp b/src/mlpack/core.hpp
index 5a63f12..ce001f5 100644
--- a/src/mlpack/core.hpp
+++ b/src/mlpack/core.hpp
@@ -73,6 +73,7 @@
  *  - @ref emst_tutorial
  *  - @ref kmtutorial
  *  - @ref fmkstutorial
+ *  - @ref amftutorial
  *
  * @section methods Methods in MLPACK
  *
diff --git a/src/mlpack/core/util/prefixedoutstream.hpp b/src/mlpack/core/util/prefixedoutstream.hpp
index 61f873a..49a6f53 100644
--- a/src/mlpack/core/util/prefixedoutstream.hpp
+++ b/src/mlpack/core/util/prefixedoutstream.hpp
@@ -56,6 +56,8 @@ class PrefixedOutStream
    *
    * @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,
diff --git a/src/mlpack/methods/linear_regression/linear_regression.hpp b/src/mlpack/methods/linear_regression/linear_regression.hpp
index f908ba8..265e290 100644
--- a/src/mlpack/methods/linear_regression/linear_regression.hpp
+++ b/src/mlpack/methods/linear_regression/linear_regression.hpp
@@ -25,6 +25,7 @@ class LinearRegression
    *
    * @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 @@ class LinearRegression
    *
    * 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,
diff --git a/src/mlpack/methods/pca/pca.hpp b/src/mlpack/methods/pca/pca.hpp
index df6bce6..41a2fe2 100644
--- a/src/mlpack/methods/pca/pca.hpp
+++ b/src/mlpack/methods/pca/pca.hpp
@@ -51,7 +51,7 @@ class PCA
    *
    * @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,

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/mlpack.git