[mlpack-git] master: Reference the MetricType documentation where possible. (dd38d5c)
gitdub at big.cc.gt.atl.ga.us
gitdub at big.cc.gt.atl.ga.us
Sat Aug 29 11:47:25 EDT 2015
Repository : https://github.com/mlpack/mlpack
On branch : master
Link : https://github.com/mlpack/mlpack/compare/ad4cc1bfc9b3e9897ef5340940afaa2227b03223...07f205fe90f9e6df5080c509fd36684758eb71cd
>---------------------------------------------------------------
commit dd38d5cbfc5e8db1078e7e3b029dd9922cdc3a95
Author: Ryan Curtin <ryan at ratml.org>
Date: Fri Aug 28 11:42:35 2015 -0400
Reference the MetricType documentation where possible.
>---------------------------------------------------------------
dd38d5cbfc5e8db1078e7e3b029dd9922cdc3a95
doc/policies/trees.hpp | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/doc/policies/trees.hpp b/doc/policies/trees.hpp
index b8e0fd2..176fc74 100644
--- a/doc/policies/trees.hpp
+++ b/doc/policies/trees.hpp
@@ -104,7 +104,8 @@ parameters, and trees are no exception. In order to ease usage of high-level
mlpack algorithms, each \c TreeType itself must be a template class taking three
parameters:
- - \c MetricType -- the underlying metric that the tree will be built on
+ - \c MetricType -- the underlying metric that the tree will be built on (see
+\ref metrics "the MetricType policy documentation")
- \c StatisticType -- holds any auxiliary information that individual
algorithms may need
- \c MatType -- the type of the matrix used to represent the data
@@ -398,8 +399,8 @@ This section is divided into five parts:
\ref treetype_template_param "An earlier section" discussed the three different
template parameters that are required by the \c TreeType policy.
-The \c MetricType policy provides one method that will be useful for tree
-building and other operations:
+The \ref metrics "MetricType policy" provides one method that will be useful for
+tree building and other operations:
@code
// This function is required by the MetricType policy.
More information about the mlpack-git
mailing list