[mlpack-svn] r13865 - mlpack/trunk/doc/guide

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: rcurtin
Date: 2012-11-14 16:28:30 -0500 (Wed, 14 Nov 2012)
New Revision: 13865

Modified:
   mlpack/trunk/doc/guide/build.hpp
   mlpack/trunk/doc/guide/sample.hpp
Log:
Fix a code error, fix build instructions to include package managers.


Modified: mlpack/trunk/doc/guide/build.hpp
===================================================================
--- mlpack/trunk/doc/guide/build.hpp	2012-11-14 20:42:29 UTC (rev 13864)
+++ mlpack/trunk/doc/guide/build.hpp	2012-11-14 21:28:30 UTC (rev 13865)
@@ -12,7 +12,7 @@
 Once the MLPACK source is unpacked, you should create a build directory.
 
 @code
-$ cd mlpack-1.0.0
+$ cd mlpack-1.0.3
 $ mkdir build
 @endcode
 
@@ -28,8 +28,30 @@
  - pthreads
  - Armadillo >= 2.4.0
  - LibXML2
- - Boost (math_c99, program_options, unit_test_framework)
+ - Boost (math_c99, program_options, unit_test_framework, random)
 
+In Ubuntu and Debian, you can get all of these dependencies through apt:
+
+ at code
+# apt-get install libboost-math-dev libboost-program-options-dev
+  libboost-random-dev libboost-test-dev libxml2-dev libarmadillo-dev
+ at endcode
+
+If you are using an Ubuntu version older than 12.04 ("Precise Pangolin") or
+Debian older than Wheezy, you will have to compile Armadillo from source.  See
+the README.txt distributed with Armadillo for more information.
+
+On Fedora, Red Hat, or CentOS, these same dependencies can be obtained via yum:
+
+ at code
+# yum install boost-devel boost-random boost-test boost-program-options
+  boost-math libxml2-devel armadillo-devel
+ at endcode
+
+On Red Hat Enterprise Linux 6 and older (as well as CentOS 6), the Armadillo
+version available is too old and must be compiled by hand.  The same applies for
+Fedora 16 and older.
+
 @section config Configuring CMake
 
 Running CMake is the equivalent to running `./configure` with autotools.  If you

Modified: mlpack/trunk/doc/guide/sample.hpp
===================================================================
--- mlpack/trunk/doc/guide/sample.hpp	2012-11-14 20:42:29 UTC (rev 13864)
+++ mlpack/trunk/doc/guide/sample.hpp	2012-11-14 21:28:30 UTC (rev 13865)
@@ -41,7 +41,8 @@
 the index of the neighbor and the distance of it to stdout.
 
 @code
- at include <mlpack/core.hpp>
+#include <mlpack/core.hpp>
+#include <mlpack/methods/neighbor_search/neighbor_search.hpp>
 
 using namespace mlpack;
 using namespace mlpack::neighbor; // NeighborSearch and NearestNeighborSort