[mlpack-git] master: Fix -Wreorder and provide better documentation. (3bd24c8)
gitdub at big.cc.gt.atl.ga.us
gitdub at big.cc.gt.atl.ga.us
Mon Nov 30 11:24:01 EST 2015
Repository : https://github.com/mlpack/mlpack
On branch : master
Link : https://github.com/mlpack/mlpack/compare/995e0c0c2f41e45c4d34a54df4bdd743bc920f85...10b9d45b806a3e879b0564d78ccb183ebc7051ba
>---------------------------------------------------------------
commit 3bd24c8c08e765f57fc97cdfcb9827b58a36cb6f
Author: Ryan Curtin <ryan at ratml.org>
Date: Mon Nov 30 08:21:10 2015 -0800
Fix -Wreorder and provide better documentation.
>---------------------------------------------------------------
3bd24c8c08e765f57fc97cdfcb9827b58a36cb6f
src/mlpack/core/math/columns_to_blocks.hpp | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/src/mlpack/core/math/columns_to_blocks.hpp b/src/mlpack/core/math/columns_to_blocks.hpp
index 00448eb..f2f6503 100644
--- a/src/mlpack/core/math/columns_to_blocks.hpp
+++ b/src/mlpack/core/math/columns_to_blocks.hpp
@@ -92,6 +92,11 @@ namespace math {
* // -1.0000 -0.1429 -1.0000 1.0000 -1.0000
* // -1.0000 -1.0000 -1.0000 -1.0000 -1.0000
* @endcode
+ *
+ * The ColumnsToBlocks class can also, depending on the parameters, scale the
+ * input to a given range (useful for exporting to PGM, for instance), and also
+ * set the buffer size and value. See the Scale(), MinRange(), MaxRange(),
+ * BufSize(), and BufValue() methods for more details.
*/
class ColumnsToBlocks
{
@@ -107,6 +112,11 @@ class ColumnsToBlocks
* the input matrix will be taken when Transform() is called and that will be
* used as the block width and height.
*
+ * Note that the ColumnsToBlocks object can also scale the inputs to a given
+ * range; see Scale(), MinRange(), and MaxRange(), and the buffer (margin)
+ * size can also be set with BufSize(), and the value used for the buffer can
+ * be set with BufValue().
+ *
* @param rows Number of blocks in each column of the output matrix.
* @param cols Number of blocks in each row of the output matrix.
* @param blockHeight Height of each block.
@@ -194,10 +204,10 @@ class ColumnsToBlocks
size_t bufSize;
//! The value of the buffer around each block.
double bufValue;
- //! The maximum of the range to be scaled to (if scaling is enabled).
- double maxRange;
//! The minimum of the range to be scaled to (if scaling is enabled).
double minRange;
+ //! The maximum of the range to be scaled to (if scaling is enabled).
+ double maxRange;
//! Whether or not scaling is enabled.
bool scale;
//! The number of blocks in each row.
More information about the mlpack-git
mailing list