[mlpack-svn] r13472 - mlpack/trunk/src/mlpack/core/arma_extend

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

Author: rcurtin
Date: 2012-08-29 11:43:48 -0400 (Wed, 29 Aug 2012)
New Revision: 13472

Modified:
   mlpack/trunk/src/mlpack/core/arma_extend/fn_inplace_reshape.hpp
Log:
Document the impending doom which will certainly be caused if you use this
function carelessly.


Modified: mlpack/trunk/src/mlpack/core/arma_extend/fn_inplace_reshape.hpp
===================================================================
--- mlpack/trunk/src/mlpack/core/arma_extend/fn_inplace_reshape.hpp	2012-08-29 15:31:19 UTC (rev 13471)
+++ mlpack/trunk/src/mlpack/core/arma_extend/fn_inplace_reshape.hpp	2012-08-29 15:43:48 UTC (rev 13472)
@@ -19,6 +19,13 @@
 
 
 
+/**
+ * This does not handle column vectors or row vectors entirely correctly.  You
+ * should be able to do multiplication or other basic operations with the
+ * resulting matrix, but it may have other problems.  So if you are using this
+ * on vectors (arma::Col<> or arma::Row<>), be careful, and be warned that
+ * bizarre behavior may occur.
+ */
 template<typename eT>
 inline
 Mat<eT>&