From a34a615af904c85d4a64dede8f7657cac52d5fe5 Mon Sep 17 00:00:00 2001 From: jeffinsam Date: Sun, 3 Nov 2019 12:16:36 +0530 Subject: [PATCH] update documentation and style issues --- src/mlpack/methods/lmnn/lmnn.hpp | 2 ++ src/mlpack/methods/nca/nca.hpp | 2 ++ src/mlpack/tests/nca_test.cpp | 2 +- 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/mlpack/methods/lmnn/lmnn.hpp b/src/mlpack/methods/lmnn/lmnn.hpp index a62f8b86e4..e7c29977f8 100644 --- a/src/mlpack/methods/lmnn/lmnn.hpp +++ b/src/mlpack/methods/lmnn/lmnn.hpp @@ -77,7 +77,9 @@ class LMNN * LearnDistance() is called with an outputMatrix with correct dimensions, * then that matrix will be used as the starting point for optimization. * + * @tparam CallbackTypes Types of Callback functions. * @param outputMatrix Covariance matrix of Mahalanobis distance. + * @param callbacks Callback Functions. */ template void LearnDistance(arma::mat& outputMatrix, CallbackTypes&&... callbacks); diff --git a/src/mlpack/methods/nca/nca.hpp b/src/mlpack/methods/nca/nca.hpp index 046f8e6608..98a88b7c20 100644 --- a/src/mlpack/methods/nca/nca.hpp +++ b/src/mlpack/methods/nca/nca.hpp @@ -73,7 +73,9 @@ class NCA * dataset.n_rows), that matrix will be used as the starting point for * optimization. * + * @tparam CallbackTypes Types of Callback functions. * @param output_matrix Covariance matrix of Mahalanobis distance. + * @param callbacks Callback Functions. */ template void LearnDistance(arma::mat& outputMatrix, CallbackTypes&&... callbacks); diff --git a/src/mlpack/tests/nca_test.cpp b/src/mlpack/tests/nca_test.cpp index 3760d6e870..3aa410501b 100644 --- a/src/mlpack/tests/nca_test.cpp +++ b/src/mlpack/tests/nca_test.cpp @@ -272,7 +272,7 @@ BOOST_AUTO_TEST_CASE(NCASGDSimpleDataset) nca.Optimizer().Shuffle() = true; arma::mat outputMatrix; - + std::stringstream stream; nca.LearnDistance(outputMatrix, ens::ProgressBar(70, stream)); BOOST_REQUIRE_GT(stream.str().length(), 0);