[mlpack-git] master, mlpack-1.0.x: Remove documentation for MoveDistributionType. (b439137)
gitdub at big.cc.gt.atl.ga.us
gitdub at big.cc.gt.atl.ga.us
Thu Mar 5 21:50:38 EST 2015
Repository : https://github.com/mlpack/mlpack
On branches: master,mlpack-1.0.x
Link : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40
>---------------------------------------------------------------
commit b4391370765783c620872e858b62a32f5522b31b
Author: Ryan Curtin <ryan at ratml.org>
Date: Wed Jul 2 20:51:10 2014 +0000
Remove documentation for MoveDistributionType.
>---------------------------------------------------------------
b4391370765783c620872e858b62a32f5522b31b
src/mlpack/core/optimizers/sa/sa.hpp | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/src/mlpack/core/optimizers/sa/sa.hpp b/src/mlpack/core/optimizers/sa/sa.hpp
index 1f028fd..14a1640 100644
--- a/src/mlpack/core/optimizers/sa/sa.hpp
+++ b/src/mlpack/core/optimizers/sa/sa.hpp
@@ -1,4 +1,4 @@
-/*
+/**
* @file sa.hpp
* @author Zhihao Lou
*
@@ -32,20 +32,21 @@ namespace optimization {
* The system is considered "frozen" when its score failed to change more then
* tolerance for consecutive maxToleranceSweep sweeps.
*
- * For SA to work, a function must implement the following methods:
+ * For SA to work, the FunctionType parameter must implement the following
+ * two methods:
+ *
* double Evaluate(const arma::mat& coordinates);
* arma::mat& GetInitialPoint();
*
- * In additional, a move generation distribution with overloaded operator():
- * double operator () (const double param);
- * which returns a random value from the distribution given parameter param,
- * and a cooling schedule with method:
- * doulbe nextTemperature(const double currentTemperature, const double currentValue);
+ * and the CoolingScheduleType parameter must implement the following method:
+ *
+ * double NextTemperature(const double currentTemperature,
+ * const double currentValue);
+ *
* which returns the next temperature given current temperature and the value
* of the function being optimized.
*
* @tparam FunctionType objective function type to be minimized.
- * @tparam MoveDistributionType distribution type for move generation
* @tparam CoolingScheduleType type for cooling schedule
*/
template<typename FunctionType, typename CoolingScheduleType>
@@ -56,7 +57,6 @@ class SA
* Construct the SA optimizer with the given function and paramters.
*
* @param function Function to be minimized.
- * @param moveDistribution Distribution for move generation
* @param coolingSchedule Cooling schedule
* @param initT Initial temperature.
* @param initMoves Iterations without changing temperature.
More information about the mlpack-git
mailing list