[mlpack-svn] r16027 - mlpack/trunk/src/mlpack/methods/logistic_regression

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

Author: rcurtin
Date: Wed Nov 13 13:21:52 2013
New Revision: 16027

Log:
Make Gradient() const and add comments.


Modified:
   mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.cpp
   mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.hpp

Modified: mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.cpp
==============================================================================
--- mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.cpp	(original)
+++ mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.cpp	Wed Nov 13 13:21:52 2013
@@ -88,7 +88,7 @@
 }
 
 void LogisticRegressionFunction::Gradient(const arma::mat& parameters,
-                                          arma::mat& gradient)
+                                          arma::mat& gradient) const
 {
   // Regularization term.
   arma::mat regularization = arma::zeros<arma::mat>(predictors.n_rows, 1);

Modified: mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.hpp
==============================================================================
--- mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.hpp	(original)
+++ mlpack/trunk/src/mlpack/methods/logistic_regression/logistic_regression_function.hpp	Wed Nov 13 13:21:52 2013
@@ -51,7 +51,14 @@
    */
   double Evaluate(const arma::mat& parameters) const;
 
-  void Gradient(const arma::mat& values, arma::mat& gradient);
+  /**
+   * Evaluate the gradient of the logistic regression log-likelihood function
+   * with the given parameters.
+   *
+   * @param parameters Vector of logistic regression parameters.
+   * @param gradient Vector to output gradient into.
+   */
+  void Gradient(const arma::mat& parameters, arma::mat& gradient) const;
 
   const arma::mat& GetInitialPoint() const { return initialPoint; }