[mlpack-git] master: Minor syntax fixes. (8305b36)

gitdub at big.cc.gt.atl.ga.us gitdub at big.cc.gt.atl.ga.us
Thu Mar 5 22:14:18 EST 2015


Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40

>---------------------------------------------------------------

commit 8305b363f619b6460d1e6b2ea3f359a9f4fcd978
Author: Ryan Curtin <ryan at ratml.org>
Date:   Thu Jan 22 11:44:50 2015 -0500

    Minor syntax fixes.


>---------------------------------------------------------------

8305b363f619b6460d1e6b2ea3f359a9f4fcd978
 .../incomplete_incremental_termination.hpp         | 64 +++++++++++-----------
 1 file changed, 33 insertions(+), 31 deletions(-)

diff --git a/src/mlpack/methods/amf/termination_policies/incomplete_incremental_termination.hpp b/src/mlpack/methods/amf/termination_policies/incomplete_incremental_termination.hpp
index 519afd5..944677e 100644
--- a/src/mlpack/methods/amf/termination_policies/incomplete_incremental_termination.hpp
+++ b/src/mlpack/methods/amf/termination_policies/incomplete_incremental_termination.hpp
@@ -4,8 +4,8 @@
  *
  * Termination policy used in AMF (Alternating Matrix Factorization).
  */
-#ifndef _MLPACK_METHODS_AMF_INCOMPLETEINCREMENTALTERMINATION_HPP_INCLUDED
-#define _MLPACK_METHODS_AMF_INCOMPLETEINCREMENTALTERMINATION_HPP_INCLUDED
+#ifndef _MLPACK_METHODS_AMF_INCOMPLETE_INCREMENTAL_TERMINATION_HPP
+#define _MLPACK_METHODS_AMF_INCOMPLETE_INCREMENTAL_TERMINATION_HPP
 
 #include <mlpack/core.hpp>
 
@@ -26,22 +26,23 @@ class IncompleteIncrementalTermination
   /**
    * Empty constructor
    *
-   * @param t_policy object of wrapped class.
+   * @param tPolicy object of wrapped class.
    */
-  IncompleteIncrementalTermination(TerminationPolicy t_policy = TerminationPolicy())
-            : t_policy(t_policy) {}
+  IncompleteIncrementalTermination(
+      TerminationPolicy tPolicy = TerminationPolicy()) :
+      tPolicy(tPolicy) { }
 
   /**
    * Initializes the termination policy before stating the factorization.
    *
    * @param V Input matrix to be factorized.
    */
-  template <class MatType>
+  template<class MatType>
   void Initialize(const MatType& V)
   {
-    t_policy.Initialize(V);
+    tPolicy.Initialize(V);
 
-    // initialize incremental index to number of rows
+    // Initialize incremental index to number of rows.
     incrementalIndex = V.n_rows;
     iteration = 0;
   }
@@ -57,40 +58,41 @@ class IncompleteIncrementalTermination
     // increment iteration count
     iteration++;
 
-    // if iteration count is multiple of incremental index,
-    // return wrapped class function
-    if(iteration % incrementalIndex == 0)  
-      return t_policy.IsConverged(W, H);
-    // else just return false
-    else return false;
+    // If the iteration count is a multiple of incremental index, return the
+    // wrapped termination policy result.
+    if (iteration % incrementalIndex == 0)
+      return tPolicy.IsConverged(W, H);
+    else
+      return false;
   }
 
-  //! Get current value of residue
-  const double& Index() const { return t_policy.Index(); }
+  //! Get current value of residue.
+  const double& Index() const { return tPolicy.Index(); }
 
-  //! Get current iteration count  
+  //! Get current iteration count.
   const size_t& Iteration() const { return iteration; }
 
-  //! Access upper limit of iteration count
-  const size_t& MaxIterations() const { return t_policy.MaxIterations(); }
-  size_t& MaxIterations() { return t_policy.MaxIterations(); }
+  //! Access maximum number of iterations.
+  size_t MaxIterations() const { return tPolicy.MaxIterations(); }
+  //! Modify maximum number of iterations.
+  size_t& MaxIterations() { return tPolicy.MaxIterations(); }
 
-  //! Access the wrapped class object
-  const TerminationPolicy& TPolicy() const { return t_policy; }
-  TerminationPolicy& TPolicy() { return t_policy; }
+  //! Access the wrapped termination policy.
+  const TerminationPolicy& TPolicy() const { return tPolicy; }
+  //! Modify the wrapped termination policy.
+  TerminationPolicy& TPolicy() { return tPolicy; }
 
  private:
-  //! wrapped class object
-  TerminationPolicy t_policy;
+  //! Wrapped termination policy.
+  TerminationPolicy tPolicy;
 
-  //! number of iterations after which wrapped class object will be called
+  //! Number of iterations after which wrapped class object will be called.
   size_t incrementalIndex;
-  //! current iteration count
+  //! Current iteration count.
   size_t iteration;
 }; // class IncompleteIncrementalTermination
 
-}; // namespace amf
-}; // namespace mlpack
-
-#endif // _MLPACK_METHODS_AMF_INCOMPLETEINCREMENTALTERMINATION_HPP_INCLUDED
+} // namespace amf
+} // namespace mlpack
 
+#endif



More information about the mlpack-git mailing list