Upgrade ensmallen to 2.11.3 (#24)

coatless · web-flow · commit 73bafed7e753 · 2020-02-19T20:15:04.000-06:00
* Upgrade to ensmallen 2.11.3

* Update NEWS with upstream entries.

* Bump version

* Add ChangeLog entry

* Update submission comments
diff --git a/ChangeLog b/ChangeLog
@@ -1,4 +1,13 @@
-2019-01-14  James Balamuta  <balamut2@illinois.edu>
+2020-02-19  James Balamuta  <balamut2@illinois.edu>
+
+	* DESCRIPTION (Version): Release 2.11.3
+
+	* NEWS.md: Update for Ensmallen release 2.11.3
+
+	* inst/include/ensmallen_bits: Upgraded to Ensmallen 2.11.3
+	* inst/include/ensmallen.hpp: ditto
+
+2020-01-14  James Balamuta  <balamut2@illinois.edu>
 
 	* inst/include/RcppEnsmallen.h: Removed header ordering checks
 
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: RcppEnsmallen
 Title: Header-Only C++ Mathematical Optimization Library for 'Armadillo'
-Version: 0.2.11.1.1
+Version: 0.2.11.3.1
 Authors@R: c(
     person("James Joseph", "Balamuta", email = "balamut2@illinois.edu", 
            role = c("aut", "cre", "cph"), 
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,19 @@
+# RcppEnsmallen 0.2.11.3.1
+
+- Upgraded to ensmallen 2.13.1: "The Poster Session Is Full" (2020-02-19)
+  - Prevent spurious compiler warnings
+    ([#161](https://github.com/mlpack/ensmallen/pull/161)).
+  - Fix minor memory leaks
+    ([#167](https://github.com/mlpack/ensmallen/pull/167)).
+  - Revamp CMake configuration
+    ([#152](https://github.com/mlpack/ensmallen/pull/152)).
+  - Allow callback instantiation for SGD based optimizer 
+    ([#138](https://github.com/mlpack/ensmallen/pull/155)).
+  - Minor test stability fixes on i386
+    ([#156](https://github.com/mlpack/ensmallen/pull/156)).
+  - Fix Lookahead MaxIterations() check.
+    ([#159](https://github.com/mlpack/ensmallen/pull/159)).
+
 # RcppEnsmallen 0.2.11.1.1
 
 - Upgraded to ensmallen 2.11.1: "The Poster Session Is Full" (2019-12-28)
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,7 +1,7 @@
 ## Test environments
 
-* local OS X install, R 3.6.1
-* ubuntu 14.04 (on travis-ci), R 3.6.1
+* local macOS install, R 3.6.2
+* ubuntu 16.04 (with GitHub Actions), R 3.6.2
 * win-builder (devel and release)
 
 ## R CMD check results
diff --git a/inst/include/ensmallen_bits/ada_bound/ada_bound.hpp b/inst/include/ensmallen_bits/ada_bound/ada_bound.hpp
@@ -113,8 +113,9 @@ class AdaBoundType
            MatType& iterate,
            CallbackTypes&&... callbacks)
   {
-    return optimizer.template Optimize<DecomposableFunctionType, MatType, GradType,
-        CallbackTypes...>(function, iterate, callbacks...);
+    return optimizer.template Optimize<DecomposableFunctionType, MatType,
+        GradType, CallbackTypes...>(function, iterate,
+        std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/ada_delta/ada_delta.hpp b/inst/include/ensmallen_bits/ada_delta/ada_delta.hpp
@@ -105,7 +105,8 @@ class AdaDelta
            CallbackTypes&&... callbacks)
   {
     return optimizer.Optimize<SeparableFunctionType, MatType, GradType,
-        CallbackTypes...>(function, iterate, callbacks...);
+        CallbackTypes...>(function, iterate,
+        std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/ada_grad/ada_grad.hpp b/inst/include/ensmallen_bits/ada_grad/ada_grad.hpp
@@ -101,7 +101,8 @@ class AdaGrad
            CallbackTypes&&... callbacks)
   {
     return optimizer.Optimize<SeparableFunctionType, MatType, GradType,
-        CallbackTypes...>(function, iterate, callbacks...);
+        CallbackTypes...>(function, iterate,
+        std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/adam/adam.hpp b/inst/include/ensmallen_bits/adam/adam.hpp
@@ -128,7 +128,7 @@ class AdamType
   {
     return optimizer.template Optimize<
         SeparableFunctionType, MatType, GradType, CallbackTypes...>(
-        function, iterate, callbacks...);
+        function, iterate, std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/bigbatch_sgd/bigbatch_sgd.hpp b/inst/include/ensmallen_bits/bigbatch_sgd/bigbatch_sgd.hpp
@@ -101,6 +101,12 @@ class BigBatchSGD
               const double tolerance = 1e-5,
               const bool shuffle = true,
               const bool exactObjective = false);
+
+  /**
+   * Clean any memory associated with the BigBatchSGD object.
+   */
+  ~BigBatchSGD();
+
   /**
    * Optimize the given function using big-batch SGD.  The given starting point
    * will be modified to store the finishing point of the algorithm, and the
diff --git a/inst/include/ensmallen_bits/bigbatch_sgd/bigbatch_sgd_impl.hpp b/inst/include/ensmallen_bits/bigbatch_sgd/bigbatch_sgd_impl.hpp
@@ -38,6 +38,12 @@ BigBatchSGD<UpdatePolicyType>::BigBatchSGD(
     updatePolicy(UpdatePolicyType())
 { /* Nothing to do. */ }
 
+template<typename UpdatePolicyType>
+BigBatchSGD<UpdatePolicyType>::~BigBatchSGD()
+{
+  instUpdatePolicy.Clean();
+}
+
 //! Optimize the function (minimize).
 template<typename UpdatePolicyType>
 template<typename SeparableFunctionType,
diff --git a/inst/include/ensmallen_bits/callbacks/callbacks.hpp b/inst/include/ensmallen_bits/callbacks/callbacks.hpp
@@ -257,6 +257,7 @@ class Callback
   {
     // This will return immediately once a callback returns true.
     bool result = false;
+    (void)(objective);  // prevent spurious compiler warnings
     (void)std::initializer_list<bool>{ result =
         result || Callback::EvaluateFunction(callbacks, optimizer, function,
         coordinates, objective)... };
@@ -332,6 +333,8 @@ class Callback
   {
     // This will return immediately once a callback returns true.
     bool result = false;
+    (void)(constraint);  // prevent spurious compiler warnings
+    (void)(constraintValue);
     (void)std::initializer_list<bool>{ result =
         result || Callback::EvaluateConstraintFunction(callbacks, optimizer,
             function, coordinates, constraint, constraintValue)... };
@@ -478,6 +481,7 @@ class Callback
   {
     // This will return immediately once a callback returns true.
     bool result = false;
+    (void)(constraint);  // prevent spurious compiler warnings
     (void)std::initializer_list<bool>{ result =
         result || Callback::GradientConstraintFunction(callbacks, optimizer,
         function, coordinates, constraint, gradient)... };
@@ -509,6 +513,7 @@ class Callback
   {
     // This will return immediately once a callback returns true.
     bool result = false;
+    (void)(objective);  // prevent spurious compiler warnings
     (void)std::initializer_list<bool>{ result =
         result || Callback::EvaluateFunction(callbacks, optimizer, function,
         coordinates, objective)... };
@@ -584,6 +589,8 @@ class Callback
   {
     // This will return immediately once a callback returns true.
     bool result = false;
+    (void)(epoch);  // prevent spurious compiler warnings
+    (void)(objective);
     (void)std::initializer_list<bool>{ result =
         result || Callback::BeginEpochFunction(callbacks, optimizer, function,
         coordinates, epoch, objective)... };
@@ -672,6 +679,8 @@ class Callback
   {
     // This will return immediately once a callback returns true.
     bool result = false;
+    (void)(epoch);  // prevent spurious compiler warnings
+    (void)(objective);
     (void)std::initializer_list<bool>{ result =
         result || Callback::EndEpochFunction(callbacks, optimizer, function,
         coordinates, epoch, objective)... };
diff --git a/inst/include/ensmallen_bits/callbacks/print_loss.hpp b/inst/include/ensmallen_bits/callbacks/print_loss.hpp
diff --git a/inst/include/ensmallen_bits/callbacks/progress_bar.hpp b/inst/include/ensmallen_bits/callbacks/progress_bar.hpp
diff --git a/inst/include/ensmallen_bits/callbacks/store_best_coordinates.hpp b/inst/include/ensmallen_bits/callbacks/store_best_coordinates.hpp
diff --git a/inst/include/ensmallen_bits/callbacks/timer_stop.hpp b/inst/include/ensmallen_bits/callbacks/timer_stop.hpp
diff --git a/inst/include/ensmallen_bits/ens_version.hpp b/inst/include/ensmallen_bits/ens_version.hpp
@@ -16,7 +16,7 @@
 // The minor version is two digits so regular numerical comparisons of versions
 // work right.  The first minor version of a release is always 10.
 #define ENS_VERSION_MINOR 11
-#define ENS_VERSION_PATCH 1
+#define ENS_VERSION_PATCH 3
 // If this is a release candidate, it will be reflected in the version name
 // (i.e. the version name will be "RC1", "RC2", etc.).  Otherwise the version
 // name will typically be a seemingly arbitrary set of words that does not
diff --git a/inst/include/ensmallen_bits/ftml/ftml.hpp b/inst/include/ensmallen_bits/ftml/ftml.hpp
@@ -105,7 +105,8 @@ class FTML
            CallbackTypes&&... callbacks)
   {
     return optimizer.Optimize<SeparableFunctionType, MatType, GradType,
-        CallbackTypes...>(function, iterate, callbacks...);
+        CallbackTypes...>(function, iterate,
+        std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/lookahead/lookahead.hpp b/inst/include/ensmallen_bits/lookahead/lookahead.hpp
@@ -108,6 +108,11 @@ class Lookahead
             const bool resetPolicy = false,
             const bool exactObjective = false);
 
+  /**
+   * Clean any memory associated with the Lookahead object.
+   */
+  ~Lookahead();
+
   /**
    * Optimize the given function using Lookahead. The given starting point will
    * be modified to store the finishing point of the algorithm, and the final
@@ -188,6 +193,31 @@ class Lookahead
   bool& ExactObjective() { return exactObjective; }
 
  private:
+  /**
+   * Set the maximum number of iterations if the given optimizer implements
+   * MaxIterations().
+   *
+   * @param optimizer Optimizer to check for MaxIterations().
+   * @param k The number of iterations.
+   */
+  template<typename OptimizerType>
+  static typename std::enable_if<traits::HasMaxIterationsSignature<
+      OptimizerType>::value, void>::type
+  SetMaxIterations(OptimizerType& optimizer, const size_t k)
+  {
+    optimizer.MaxIterations() = k;
+  }
+
+  template<typename OptimizerType>
+  static typename std::enable_if<!traits::HasMaxIterationsSignature<
+      OptimizerType>::value, void>::type
+  SetMaxIterations(const OptimizerType& /* optimizer */, const size_t /* k */)
+  {
+    Warn << "The base optimizer does not have a definition of "
+        << "MaxIterations(), the base optimizer will have its configuration "
+        << "unchanged.";
+  }
+
   //! The base optimizer for the forward step.
   BaseOptimizerType baseOptimizer;
 
diff --git a/inst/include/ensmallen_bits/lookahead/lookahead_impl.hpp b/inst/include/ensmallen_bits/lookahead/lookahead_impl.hpp
@@ -60,6 +60,12 @@ inline Lookahead<BaseOptimizerType, DecayPolicyType>::Lookahead(
     isInitialized(false)
 { /* Nothing to do. */ }
 
+template<typename BaseOptimizerType, typename DecayPolicyType>
+inline Lookahead<BaseOptimizerType, DecayPolicyType>::~Lookahead()
+{
+  instDecayPolicy.Clean();
+}
+
 //! Optimize the function (minimize).
 template<typename BaseOptimizerType, typename DecayPolicyType>
 template<typename SeparableFunctionType,
@@ -98,16 +104,7 @@ Lookahead<BaseOptimizerType, DecayPolicyType>::Optimize(
 
   // Check if the optimizer implements HasMaxIterations() and override the
   // parameter with k.
-  if (traits::HasMaxIterationsSignature<BaseOptimizerType>::value)
-  {
-    baseOptimizer.MaxIterations() = k;
-  }
-  else
-  {
-    Warn << "The base optimizer does not have a definition of "
-        << "MaxIterations(), the base optimizer will have its configuration "
-        << "unchanged.";
-  }
+  SetMaxIterations(baseOptimizer, k);
 
   // Check if the optimizer implements ResetPolicy() and override the reset
   // policy.
diff --git a/inst/include/ensmallen_bits/padam/padam.hpp b/inst/include/ensmallen_bits/padam/padam.hpp
@@ -113,7 +113,7 @@ class Padam
   {
     return optimizer.template Optimize<
         SeparableFunctionType, MatType, GradType, CallbackTypes...>(
-        function, iterate, callbacks...);
+        function, iterate, std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/problems/aug_lagrangian_test_functions_impl.hpp b/inst/include/ensmallen_bits/problems/aug_lagrangian_test_functions_impl.hpp
@@ -129,14 +129,15 @@ inline typename MatType::elem_type GockenbachFunction::EvaluateConstraint(
   switch (index)
   {
     case 0: // g(x) = (x_3 - x_2 - x_1 - 1) = 0
-      constraint = (coordinates[2] - coordinates[1] - coordinates[0] - 1);
+      constraint = (coordinates[2] - coordinates[1] - coordinates[0] -
+          typename MatType::elem_type(1));
       break;
 
     case 1: // h(x) = (x_3 - x_1^2) >= 0
       // To deal with the inequality, the constraint will simply evaluate to 0
       // when h(x) >= 0.
-      constraint = std::min(0.0,
-          (coordinates[2] - std::pow(coordinates[0], 2)));
+      constraint = std::min(typename MatType::elem_type(0), (coordinates[2] -
+          std::pow(coordinates[0], typename MatType::elem_type(2))));
       break;
   }
 
diff --git a/inst/include/ensmallen_bits/problems/schaffer_function_n2.hpp b/inst/include/ensmallen_bits/problems/schaffer_function_n2.hpp
@@ -41,7 +41,7 @@ namespace test {
 class SchafferFunctionN2
 {
  public:
-  //! Initialize the SchafferFunctionN4.
+  //! Initialize the SchafferFunctionN2.
   SchafferFunctionN2();
 
   /**
diff --git a/inst/include/ensmallen_bits/pso/pso.hpp b/inst/include/ensmallen_bits/pso/pso.hpp
@@ -110,6 +110,14 @@ class PSOType
           initPolicy(initPolicy)
   { /* Nothing to do. */ }
 
+  /**
+   * Clean memory associated with the PSO object.
+   */
+  ~PSOType()
+  {
+    instUpdatePolicy.Clean();
+  }
+
   /**
    * Construct the particle swarm optimizer with the given function and
    * parameters. The defaults here are not necessarily good for the given
diff --git a/inst/include/ensmallen_bits/pso/pso_impl.hpp b/inst/include/ensmallen_bits/pso/pso_impl.hpp
@@ -18,7 +18,9 @@
 #include <queue>
 
 namespace ens {
-/* After the velocity of each particle is updated at the end of each iteration
+
+/**
+ * After the velocity of each particle is updated at the end of each iteration
  * in PSO, the position of particle i (in iteration j) is updated as:
  *
  * \f[
diff --git a/inst/include/ensmallen_bits/qhadam/qhadam.hpp b/inst/include/ensmallen_bits/qhadam/qhadam.hpp
@@ -107,7 +107,8 @@ class QHAdam
            CallbackTypes&&... callbacks)
   {
     return optimizer.Optimize<SeparableFunctionType, MatType, GradType,
-        CallbackTypes...>(function, iterate, callbacks...);
+        CallbackTypes...>(function, iterate,
+        std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/rmsprop/rmsprop.hpp b/inst/include/ensmallen_bits/rmsprop/rmsprop.hpp
@@ -116,7 +116,8 @@ class RMSProp
            CallbackTypes&&... callbacks)
   {
     return optimizer.Optimize<SeparableFunctionType, MatType, GradType,
-        CallbackTypes...>(function, iterate, callbacks...);
+        CallbackTypes...>(function, iterate,
+        std::forward<CallbackTypes>(callbacks)...);
   }
 
   //! Forward the MatType as GradType.
diff --git a/inst/include/ensmallen_bits/sdp/lrsdp_function.hpp b/inst/include/ensmallen_bits/sdp/lrsdp_function.hpp
@@ -58,6 +58,11 @@ class LRSDPFunction
                 const size_t numDenseConstraints,
                 const arma::Mat<typename SDPType::ElemType>& initialPoint);
 
+  /**
+   * Clean any memory associated with the LRSDPFunction.
+   */
+  ~LRSDPFunction();
+
   /**
    * Evaluate the objective function of the LRSDP (no constraints) at the given
    * coordinates.
diff --git a/inst/include/ensmallen_bits/sdp/lrsdp_function_impl.hpp b/inst/include/ensmallen_bits/sdp/lrsdp_function_impl.hpp
@@ -49,6 +49,12 @@ LRSDPFunction<SDPType>::LRSDPFunction(
   }
 }
 
+template<typename SDPType>
+LRSDPFunction<SDPType>::~LRSDPFunction()
+{
+  rrt.Clean();
+}
+
 template<typename SDPType>
 template<typename MatType>
 typename MatType::elem_type LRSDPFunction<SDPType>::Evaluate(
diff --git a/inst/include/ensmallen_bits/sgd/sgd.hpp b/inst/include/ensmallen_bits/sgd/sgd.hpp
@@ -101,6 +101,11 @@ class SGD
       const bool resetPolicy = true,
       const bool exactObjective = false);
 
+  /**
+   * Clean any memory associated with the SGD object.
+   */
+  ~SGD();
+
   /**
    * Optimize the given function using stochastic gradient descent.  The given
    * starting point will be modified to store the finishing point of the
diff --git a/inst/include/ensmallen_bits/sgd/sgd_impl.hpp b/inst/include/ensmallen_bits/sgd/sgd_impl.hpp
@@ -44,6 +44,14 @@ SGD<UpdatePolicyType, DecayPolicyType>::SGD(
     isInitialized(false)
 { /* Nothing to do. */ }
 
+template<typename UpdatePolicyType, typename DecayPolicyType>
+SGD<UpdatePolicyType, DecayPolicyType>::~SGD()
+{
+  // Clean decay and update policies, if they were initialized.
+  instDecayPolicy.Clean();
+  instUpdatePolicy.Clean();
+}
+
 //! Optimize the function (minimize).
 template<typename UpdatePolicyType, typename DecayPolicyType>
 template<typename SeparableFunctionType,
diff --git a/inst/include/ensmallen_bits/smorms3/smorms3.hpp b/inst/include/ensmallen_bits/smorms3/smorms3.hpp
diff --git a/inst/include/ensmallen_bits/spalera_sgd/spalera_sgd.hpp b/inst/include/ensmallen_bits/spalera_sgd/spalera_sgd.hpp
diff --git a/inst/include/ensmallen_bits/spalera_sgd/spalera_sgd_impl.hpp b/inst/include/ensmallen_bits/spalera_sgd/spalera_sgd_impl.hpp
diff --git a/inst/include/ensmallen_bits/svrg/svrg.hpp b/inst/include/ensmallen_bits/svrg/svrg.hpp
diff --git a/inst/include/ensmallen_bits/svrg/svrg_impl.hpp b/inst/include/ensmallen_bits/svrg/svrg_impl.hpp
diff --git a/inst/include/ensmallen_bits/swats/swats.hpp b/inst/include/ensmallen_bits/swats/swats.hpp
diff --git a/inst/include/ensmallen_bits/wn_grad/wn_grad.hpp b/inst/include/ensmallen_bits/wn_grad/wn_grad.hpp

-Original file line number
+Diff line change
@@ @@ -1,4 +1,13 @@ @@
 -2019-01-14  James Balamuta  <[email protected]>
 +2020-02-19  James Balamuta  <[email protected]>
++
 +	* DESCRIPTION (Version): Release 2.11.3
++
 +	* NEWS.md: Update for Ensmallen release 2.11.3
++
 +	* inst/include/ensmallen_bits: Upgraded to Ensmallen 2.11.3
 +	* inst/include/ensmallen.hpp: ditto
++
 +2020-01-14  James Balamuta  <[email protected]>
 	* inst/include/RcppEnsmallen.h: Removed header ordering checks
Original file line number	Diff line number	Diff line change
`@@ -113,8 +113,9 @@ class AdaBoundType`
`113`	`113`	`MatType& iterate,`
`114`	`114`	`CallbackTypes&&... callbacks)`
`115`	`115`	`{`
`116`		`- return optimizer.template Optimize<DecomposableFunctionType, MatType, GradType,`
`117`		`- CallbackTypes...>(function, iterate, callbacks...);`
	`116`	`+ return optimizer.template Optimize<DecomposableFunctionType, MatType,`
	`117`	`+ GradType, CallbackTypes...>(function, iterate,`
	`118`	`+ std::forward<CallbackTypes>(callbacks)...);`
`118`	`119`	`}`
`119`	`120`
`120`	`121`	`//! Forward the MatType as GradType.`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,8 @@ class AdaDelta`
`105`	`105`	`CallbackTypes&&... callbacks)`
`106`	`106`	`{`
`107`	`107`	`return optimizer.Optimize<SeparableFunctionType, MatType, GradType,`
`108`		`- CallbackTypes...>(function, iterate, callbacks...);`
	`108`	`+ CallbackTypes...>(function, iterate,`
	`109`	`+ std::forward<CallbackTypes>(callbacks)...);`
`109`	`110`	`}`
`110`	`111`
`111`	`112`	`//! Forward the MatType as GradType.`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,8 @@ class AdaGrad`
`101`	`101`	`CallbackTypes&&... callbacks)`
`102`	`102`	`{`
`103`	`103`	`return optimizer.Optimize<SeparableFunctionType, MatType, GradType,`
`104`		`- CallbackTypes...>(function, iterate, callbacks...);`
	`104`	`+ CallbackTypes...>(function, iterate,`
	`105`	`+ std::forward<CallbackTypes>(callbacks)...);`
`105`	`106`	`}`
`106`	`107`
`107`	`108`	`//! Forward the MatType as GradType.`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ class AdamType`
`128`	`128`	`{`
`129`	`129`	`return optimizer.template Optimize<`
`130`	`130`	`SeparableFunctionType, MatType, GradType, CallbackTypes...>(`
`131`		`- function, iterate, callbacks...);`
	`131`	`+ function, iterate, std::forward<CallbackTypes>(callbacks)...);`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`//! Forward the MatType as GradType.`