[mlpack] 10/37: Minor documentation update.

Barak A. Pearlmutter barak+git at pearlmutter.net
Mon Feb 15 19:35:46 UTC 2016


This is an automated email from the git hooks/post-receive script.

bap pushed a commit to tag mlpack-1.0.10
in repository mlpack.

commit 8a25515d5acbb885dbb388ca8e1005b4dcd828bd
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon Jul 28 14:31:35 2014 +0000

    Minor documentation update.
---
 doc/tutorials/emst/emst.txt | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/doc/tutorials/emst/emst.txt b/doc/tutorials/emst/emst.txt
index 44ecea6..20b1341 100644
--- a/doc/tutorials/emst/emst.txt
+++ b/doc/tutorials/emst/emst.txt
@@ -17,9 +17,10 @@ Among other applications, the EMST can be used to compute hierarchical clusterin
 of data.  A <em>single-linkage clustering</em> can be obtained from the EMST by deleting
 all edges longer than a given cluster length.  This technique is also referred to as a <em>Friends-of-Friends</em> clustering in the astronomy literature.
 
-MLPACK includes an implementation of <b>Dual-Tree Boruvka</b> on \f$kd\f$-trees,
-the empirically and theoretically fastest EMST algorithm.  For more details,
-see the following paper:
+MLPACK includes an implementation of <b>Dual-Tree Boruvka</b> which uses
+\f$kd\f$-trees by default; this is the empirically and theoretically fastest
+EMST algorithm.  In addition, the implementation supports the use of different
+trees via templates.  For more details, see the following paper:
 
 @code
 @inproceedings{march2010fast,
@@ -118,7 +119,10 @@ Note that it is also possible to compute the EMST using a naive (\f$O(N^2)\f$) a
 
 The 'DualTreeBoruvka' class contains our implementation of the Dual-Tree Boruvka algorithm.
 
-The class has two constructors: the first takes the data set, constructs the \f$kd\f$-tree, and computes the MST.  The second takes data set and an already constructed tree.
+The class has two constructors: the first takes the data set, constructs the
+tree (where the type of tree constructed is the TreeType template parameter),
+and computes the MST.  The second takes data set and an already constructed
+tree.
 
 The class provides one method that performs the MST computation:
 @code

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/mlpack.git



More information about the debian-science-commits mailing list