[mlpack-git] master: Add more documentation for FastMKSRules. (d0d22f7)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/ef51b032f275266f781d42b9bd0aa50aa26a3077...8522b04c3d9a82fb7e964bafd72e70f0cd30bf4b

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

commit d0d22f72f79bea8510d2cb8862353eef3413808a
Author: MarcosPividori <marcos.pividori at gmail.com>
Date:   Fri Jul 22 01:58:34 2016 -0300

    Add more documentation for FastMKSRules.


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

d0d22f72f79bea8510d2cb8862353eef3413808a
 src/mlpack/methods/fastmks/fastmks_rules.hpp | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/src/mlpack/methods/fastmks/fastmks_rules.hpp b/src/mlpack/methods/fastmks/fastmks_rules.hpp
index 13be5f5..11b9604 100644
--- a/src/mlpack/methods/fastmks/fastmks_rules.hpp
+++ b/src/mlpack/methods/fastmks/fastmks_rules.hpp
@@ -16,12 +16,27 @@ namespace mlpack {
 namespace fastmks {
 
 /**
- * The base case and pruning rules for FastMKS (fast max-kernel search).
+ * The FastMKSRules class is a template helper class used by FastMKS class when
+ * performing exact max-kernel search. For each point in the query dataset, it
+ * keeps track of the k best candidates in the reference dataset.
+ *
+ * @tparam KernelType Type of kernel to run FastMKS with.
+ * @tparam TreeType Type of tree to run FastMKS with; it must satisfy the
+ *     TreeType policy API.
  */
 template<typename KernelType, typename TreeType>
 class FastMKSRules
 {
  public:
+  /**
+   * Construct the FastMKSRules object.  This is usually done from within the
+   * FastMKS class at search time.
+   *
+   * @param referenceSet Set of reference data.
+   * @param querySet Set of query data.
+   * @param k Number of candidates to search for.
+   * @param kernel Kernel to run FastMKS with.
+   */
   FastMKSRules(const typename TreeType::Mat& referenceSet,
                const typename TreeType::Mat& querySet,
                const size_t k,
@@ -30,7 +45,7 @@ class FastMKSRules
   /**
    * Store the list of candidates for each query point in the given matrices.
    *
-   * @param indices Matrix storing lists of candidate points for each query point.
+   * @param indices Matrix storing lists of candidate for each query point.
    * @param products Matrix storing kernel value for each candidate.
    */
   void GetResults(arma::Mat<size_t>& indices, arma::mat& products);