Upgrade ensmallen to 2.16.1 (#42)

Co-authored-by: coatless <[email protected]>

Author: github-actions[bot]

ChangeLog

@@ -1,3 +1,10 @@
+2021-03-05  James Balamuta  <[email protected]>
+
+	* DESCRIPTION (Version): Release 2.16.1
+	* NEWS.md: Update for Ensmallen release 2.16.1
+	* inst/include/ensmallen_bits: Upgraded to Ensmallen 2.16.1
+	* inst/include/ensmallen.hpp: ditto
+
 2021-02-19  James Balamuta  <[email protected]>
 
 	* DESCRIPTION (Version): Release 2.16.0

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: RcppEnsmallen
 Title: Header-Only C++ Mathematical Optimization Library for 'Armadillo'
-Version: 0.2.16.0.1
+Version: 0.2.16.1.1
 Authors@R: c(
     person("James Joseph", "Balamuta", email = "[email protected]", 
            role = c("aut", "cre", "cph"), 

NEWS.md

@@ -1,3 +1,13 @@
+# RcppEnsmallen 0.2.16.1.1
+
+- Upgraded to ensmallen 2.16.1: "Severely Dented Can Of Polyurethane" (2021-03-04)
+  - Fix test compilation issue when `ENS_USE_OPENMP` is set
+    ([#255](https://github.com/mlpack/ensmallen/pull/255)).
+  - Fix CNE initial population generation to use normal distribution
+    ([#258](https://github.com/mlpack/ensmallen/pull/258)).
+  - Fix compilation warnings
+    ([#259](https://github.com/mlpack/ensmallen/pull/259)).
+
 # RcppEnsmallen 0.2.16.0.1 (GitHub-Only Release)
 
 - Upgraded to ensmallen 2.16.0: "Severely Dented Can Of Polyurethane" (2021-02-19)

inst/include/ensmallen_bits/callbacks/report.hpp

@@ -149,6 +149,26 @@ class Report
     output << coordinates.n_cols << std::endl;
     output << std::endl;
 
+    // If we did not take any steps, at least fill what the initial objective
+    // was.
+    const bool tookStep = (objectives.size() > 0);
+    if (objectives.size() == 0 && evaluateCalls > 0)
+    {
+      objectives.push_back(objective);
+      timings.push_back(optimizationTimer.toc());
+    }
+    else if (evaluateCalls == 0)
+    {
+      // It's not entirely clear how to compute the objective (since the
+      // function could implement many different ways of evaluating the
+      // objective), so issue an error and return.
+      output << "Objective never computed.  Did the optimization fail?"
+          << std::endl;
+      PrettyPrintElement("Time (in seconds):", 30);
+      output << optimizationTimer.toc() << std::endl;
+      return;
+    }
+
     output << "Loss:" << std::endl;
     PrettyPrintElement("Initial", 30);
     output << objectives[0] << std::endl;
@@ -166,7 +186,10 @@ class Report
       output << optimizerStream.str();
 
     PrettyPrintElement("Iterations:", 30);
-    output << objectives.size() << std::endl;
+    if (tookStep)
+      output << objectives.size() << std::endl;
+    else
+      output << "0 (No steps taken! Did the optimization fail?)" << std::endl;
 
     if (epochCalls > 0)
     {
@@ -183,7 +206,7 @@ class Report
       output << stepsizes.back() << std::endl;
     }
 
-    if (hasGradient)
+    if (hasGradient && gradientsNorm.size() > 0)
     {
       PrettyPrintElement("Coordinates max. norm:", 30);
       output << *std::max_element(std::begin(gradientsNorm),

inst/include/ensmallen_bits/cne/cne_impl.hpp

@@ -93,7 +93,7 @@ typename MatType::elem_type CNE::Optimize(ArbitraryFunctionType& function,
   std::vector<BaseMatType> population;
   for (size_t i = 0 ; i < populationSize; ++i)
   {
-    population.push_back(arma::randu<BaseMatType>(iterate.n_rows,
+    population.push_back(arma::randn<BaseMatType>(iterate.n_rows,
         iterate.n_cols) + iterate);
   }
 

inst/include/ensmallen_bits/ens_version.hpp

@@ -16,16 +16,16 @@
 // 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 16
-#define ENS_VERSION_PATCH 0
+#define ENS_VERSION_PATCH 1
 // 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
 // contain the capitalized string "RC".
 #define ENS_VERSION_NAME "Severely Dented Can Of Polyurethane"
 // Incorporate the date the version was released.
 #define ENS_VERSION_YEAR "2021"
-#define ENS_VERSION_MONTH "02"
-#define ENS_VERSION_DAY "11"
+#define ENS_VERSION_MONTH "03"
+#define ENS_VERSION_DAY "02"
 
 namespace ens {
 

inst/include/ensmallen_bits/problems/ackley_function.hpp

@@ -68,7 +68,7 @@ class AckleyFunction
   MatType GetFinalPoint() const { return MatType("0.0; 0.0"); }
 
   //! Get the final objective.
-  const double GetFinalObjective() const { return 0.0; }
+  double GetFinalObjective() const { return 0.0; }
 
   /**
    * Evaluate a function for a particular batch-size.

inst/include/ensmallen_bits/problems/beale_function.hpp

@@ -61,7 +61,7 @@ class BealeFunction
   MatType GetFinalPoint() const { return MatType("3.0; 0.5"); }
 
   //! Get the final objective.
-  const double GetFinalObjective() const { return 0.0; }
+  double GetFinalObjective() const { return 0.0; }
 
   /**
    * Evaluate a function for a particular batch-size.

inst/include/ensmallen_bits/problems/booth_function.hpp

@@ -61,7 +61,7 @@ class BoothFunction
   MatType GetFinalPoint() const { return MatType("1.0; 3.0"); }
 
   //! Get the final objective.
-  const double GetFinalObjective() const { return 0.0; }
+  double GetFinalObjective() const { return 0.0; }
 
   /**
    * Evaluate a function for a particular batch-size.

inst/include/ensmallen_bits/problems/bukin_function.hpp

@@ -66,7 +66,7 @@ class BukinFunction
   MatType GetFinalPoint() const { return MatType("-10.0; 1.0"); }
 
   //! Get the final objective.
-  const double GetFinalObjective() const { return 0.0; }
+  double GetFinalObjective() const { return 0.0; }
 
   /**
    * Evaluate a function for a particular batch-size.