[mlpack-git] master: Some changes for the sake of Doxygen. (1e33fe6)

[gitdub at big.cc.gt.atl.ga.us]

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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/d81511957f5fcc5e46cee49c6103e3ae7ac1d45d...9061d83c0b0068dec13ea80c6837b688b6321023

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

commit 1e33fe6dcdf1719950a71d748b798289bb466c5f
Author: Ryan Curtin <ryan at ratml.org>
Date:   Tue Jan 13 10:27:35 2015 -0500

    Some changes for the sake of Doxygen.


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

1e33fe6dcdf1719950a71d748b798289bb466c5f
 .../methods/matrix_completion/matrix_completion.hpp   | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/src/mlpack/methods/matrix_completion/matrix_completion.hpp b/src/mlpack/methods/matrix_completion/matrix_completion.hpp
index 382b748..4e6d8e5 100644
--- a/src/mlpack/methods/matrix_completion/matrix_completion.hpp
+++ b/src/mlpack/methods/matrix_completion/matrix_completion.hpp
@@ -47,7 +47,6 @@ namespace matrix_completion {
 class MatrixCompletion
 {
  public:
-
   /**
    * Construct a matrix completion problem, specifying the maximum rank of the
    * solution.
@@ -112,24 +111,26 @@ class MatrixCompletion
   optimization::LRSDP& Sdp() { return sdp; }
 
  private:
+  //! Number of rows in original matrix.
   size_t m;
-
+  //! Number of columns in original matrix.
   size_t n;
-
+  //! Matrix containing the indices of the known entries (has two rows).
   arma::umat indices;
-
+  //! Vector containing the values of the known entries.
   arma::mat values;
 
+  //! The underlying SDP to be solved.
   optimization::LRSDP sdp;
 
+  //! Validate the input matrices.
   void checkValues();
-
+  //! Initialize the SDP.
   void initSdp();
 
-  static size_t
-  DefaultRank(const size_t m,
-              const size_t n,
-              const size_t p);
+  //! Select a rank of the matrix given that is of size m x n and has p known
+  //! elements.
+  static size_t DefaultRank(const size_t m, const size_t n, const size_t p);
 };
 
 } // namespace matrix_completion