Blame examples/nist.cc

Packit ea1746
// Ceres Solver - A fast non-linear least squares minimizer
Packit ea1746
// Copyright 2015 Google Inc. All rights reserved.
Packit ea1746
// http://ceres-solver.org/
Packit ea1746
//
Packit ea1746
// Redistribution and use in source and binary forms, with or without
Packit ea1746
// modification, are permitted provided that the following conditions are met:
Packit ea1746
//
Packit ea1746
// * Redistributions of source code must retain the above copyright notice,
Packit ea1746
//   this list of conditions and the following disclaimer.
Packit ea1746
// * Redistributions in binary form must reproduce the above copyright notice,
Packit ea1746
//   this list of conditions and the following disclaimer in the documentation
Packit ea1746
//   and/or other materials provided with the distribution.
Packit ea1746
// * Neither the name of Google Inc. nor the names of its contributors may be
Packit ea1746
//   used to endorse or promote products derived from this software without
Packit ea1746
//   specific prior written permission.
Packit ea1746
//
Packit ea1746
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Packit ea1746
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Packit ea1746
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit ea1746
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
Packit ea1746
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
Packit ea1746
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
Packit ea1746
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Packit ea1746
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
Packit ea1746
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
Packit ea1746
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Packit ea1746
// POSSIBILITY OF SUCH DAMAGE.
Packit ea1746
//
Packit ea1746
// Author: sameeragarwal@google.com (Sameer Agarwal)
Packit ea1746
//
Packit ea1746
// The National Institute of Standards and Technology has released a
Packit ea1746
// set of problems to test non-linear least squares solvers.
Packit ea1746
//
Packit ea1746
// More information about the background on these problems and
Packit ea1746
// suggested evaluation methodology can be found at:
Packit ea1746
//
Packit ea1746
//   http://www.itl.nist.gov/div898/strd/nls/nls_info.shtml
Packit ea1746
//
Packit ea1746
// The problem data themselves can be found at
Packit ea1746
//
Packit ea1746
//   http://www.itl.nist.gov/div898/strd/nls/nls_main.shtml
Packit ea1746
//
Packit ea1746
// The problems are divided into three levels of difficulty, Easy,
Packit ea1746
// Medium and Hard. For each problem there are two starting guesses,
Packit ea1746
// the first one far away from the global minimum and the second
Packit ea1746
// closer to it.
Packit ea1746
//
Packit ea1746
// A problem is considered successfully solved, if every components of
Packit ea1746
// the solution matches the globally optimal solution in at least 4
Packit ea1746
// digits or more.
Packit ea1746
//
Packit ea1746
// This dataset was used for an evaluation of Non-linear least squares
Packit ea1746
// solvers:
Packit ea1746
//
Packit ea1746
// P. F. Mondragon & B. Borchers, A Comparison of Nonlinear Regression
Packit ea1746
// Codes, Journal of Modern Applied Statistical Methods, 4(1):343-351,
Packit ea1746
// 2005.
Packit ea1746
//
Packit ea1746
// The results from Mondragon & Borchers can be summarized as
Packit ea1746
//               Excel  Gnuplot  GaussFit  HBN  MinPack
Packit ea1746
// Average LRE     2.3      4.3       4.0  6.8      4.4
Packit ea1746
//      Winner       1        5        12   29       12
Packit ea1746
//
Packit ea1746
// Where the row Winner counts, the number of problems for which the
Packit ea1746
// solver had the highest LRE.
Packit ea1746
Packit ea1746
// In this file, we implement the same evaluation methodology using
Packit ea1746
// Ceres. Currently using Levenberg-Marquardt with DENSE_QR, we get
Packit ea1746
//
Packit ea1746
//               Excel  Gnuplot  GaussFit  HBN  MinPack  Ceres
Packit ea1746
// Average LRE     2.3      4.3       4.0  6.8      4.4    9.4
Packit ea1746
//      Winner       0        0         5   11        2     41
Packit ea1746
Packit ea1746
#include <iostream>
Packit ea1746
#include <iterator>
Packit ea1746
#include <fstream>
Packit ea1746
#include "ceres/ceres.h"
Packit ea1746
#include "gflags/gflags.h"
Packit ea1746
#include "glog/logging.h"
Packit ea1746
#include "Eigen/Core"
Packit ea1746
Packit ea1746
DEFINE_string(nist_data_dir, "", "Directory containing the NIST non-linear"
Packit ea1746
              "regression examples");
Packit ea1746
DEFINE_string(minimizer, "trust_region",
Packit ea1746
              "Minimizer type to use, choices are: line_search & trust_region");
Packit ea1746
DEFINE_string(trust_region_strategy, "levenberg_marquardt",
Packit ea1746
              "Options are: levenberg_marquardt, dogleg");
Packit ea1746
DEFINE_string(dogleg, "traditional_dogleg",
Packit ea1746
              "Options are: traditional_dogleg, subspace_dogleg");
Packit ea1746
DEFINE_string(linear_solver, "dense_qr", "Options are: "
Packit ea1746
              "sparse_cholesky, dense_qr, dense_normal_cholesky and"
Packit ea1746
              "cgnr");
Packit ea1746
DEFINE_string(preconditioner, "jacobi", "Options are: "
Packit ea1746
              "identity, jacobi");
Packit ea1746
DEFINE_string(line_search, "wolfe",
Packit ea1746
              "Line search algorithm to use, choices are: armijo and wolfe.");
Packit ea1746
DEFINE_string(line_search_direction, "lbfgs",
Packit ea1746
              "Line search direction algorithm to use, choices: lbfgs, bfgs");
Packit ea1746
DEFINE_int32(max_line_search_iterations, 20,
Packit ea1746
             "Maximum number of iterations for each line search.");
Packit ea1746
DEFINE_int32(max_line_search_restarts, 10,
Packit ea1746
             "Maximum number of restarts of line search direction algorithm.");
Packit ea1746
DEFINE_string(line_search_interpolation, "cubic",
Packit ea1746
              "Degree of polynomial aproximation in line search, "
Packit ea1746
              "choices are: bisection, quadratic & cubic.");
Packit ea1746
DEFINE_int32(lbfgs_rank, 20,
Packit ea1746
             "Rank of L-BFGS inverse Hessian approximation in line search.");
Packit ea1746
DEFINE_bool(approximate_eigenvalue_bfgs_scaling, false,
Packit ea1746
            "Use approximate eigenvalue scaling in (L)BFGS line search.");
Packit ea1746
DEFINE_double(sufficient_decrease, 1.0e-4,
Packit ea1746
              "Line search Armijo sufficient (function) decrease factor.");
Packit ea1746
DEFINE_double(sufficient_curvature_decrease, 0.9,
Packit ea1746
              "Line search Wolfe sufficient curvature decrease factor.");
Packit ea1746
DEFINE_int32(num_iterations, 10000, "Number of iterations");
Packit ea1746
DEFINE_bool(nonmonotonic_steps, false, "Trust region algorithm can use"
Packit ea1746
            " nonmonotic steps");
Packit ea1746
DEFINE_double(initial_trust_region_radius, 1e4, "Initial trust region radius");
Packit ea1746
DEFINE_bool(use_numeric_diff, false,
Packit ea1746
            "Use numeric differentiation instead of automatic "
Packit ea1746
            "differentiation.");
Packit ea1746
DEFINE_string(numeric_diff_method, "ridders", "When using numeric "
Packit ea1746
              "differentiation, selects algorithm. Options are: central, "
Packit ea1746
              "forward, ridders.");
Packit ea1746
DEFINE_double(ridders_step_size, 1e-9, "Initial step size for Ridders "
Packit ea1746
              "numeric differentiation.");
Packit ea1746
DEFINE_int32(ridders_extrapolations, 3, "Maximal number of Ridders "
Packit ea1746
             "extrapolations.");
Packit ea1746
Packit ea1746
namespace ceres {
Packit ea1746
namespace examples {
Packit ea1746
Packit ea1746
using Eigen::Dynamic;
Packit ea1746
using Eigen::RowMajor;
Packit ea1746
typedef Eigen::Matrix<double, Dynamic, 1> Vector;
Packit ea1746
typedef Eigen::Matrix<double, Dynamic, Dynamic, RowMajor> Matrix;
Packit ea1746
Packit ea1746
using std::atof;
Packit ea1746
using std::atoi;
Packit ea1746
using std::cout;
Packit ea1746
using std::ifstream;
Packit ea1746
using std::string;
Packit ea1746
using std::vector;
Packit ea1746
Packit ea1746
void SplitStringUsingChar(const string& full,
Packit ea1746
                          const char delim,
Packit ea1746
                          vector<string>* result) {
Packit ea1746
  std::back_insert_iterator< vector<string> > it(*result);
Packit ea1746
Packit ea1746
  const char* p = full.data();
Packit ea1746
  const char* end = p + full.size();
Packit ea1746
  while (p != end) {
Packit ea1746
    if (*p == delim) {
Packit ea1746
      ++p;
Packit ea1746
    } else {
Packit ea1746
      const char* start = p;
Packit ea1746
      while (++p != end && *p != delim) {
Packit ea1746
        // Skip to the next occurence of the delimiter.
Packit ea1746
      }
Packit ea1746
      *it++ = string(start, p - start);
Packit ea1746
    }
Packit ea1746
  }
Packit ea1746
}
Packit ea1746
Packit ea1746
bool GetAndSplitLine(ifstream& ifs, vector<string>* pieces) {
Packit ea1746
  pieces->clear();
Packit ea1746
  char buf[256];
Packit ea1746
  ifs.getline(buf, 256);
Packit ea1746
  SplitStringUsingChar(string(buf), ' ', pieces);
Packit ea1746
  return true;
Packit ea1746
}
Packit ea1746
Packit ea1746
void SkipLines(ifstream& ifs, int num_lines) {
Packit ea1746
  char buf[256];
Packit ea1746
  for (int i = 0; i < num_lines; ++i) {
Packit ea1746
    ifs.getline(buf, 256);
Packit ea1746
  }
Packit ea1746
}
Packit ea1746
Packit ea1746
class NISTProblem {
Packit ea1746
 public:
Packit ea1746
  explicit NISTProblem(const string& filename) {
Packit ea1746
    ifstream ifs(filename.c_str(), ifstream::in);
Packit ea1746
    CHECK(ifs) << "Unable to open : " << filename;
Packit ea1746
Packit ea1746
    vector<string> pieces;
Packit ea1746
    SkipLines(ifs, 24);
Packit ea1746
    GetAndSplitLine(ifs, &pieces);
Packit ea1746
    const int kNumResponses = atoi(pieces[1].c_str());
Packit ea1746
Packit ea1746
    GetAndSplitLine(ifs, &pieces);
Packit ea1746
    const int kNumPredictors = atoi(pieces[0].c_str());
Packit ea1746
Packit ea1746
    GetAndSplitLine(ifs, &pieces);
Packit ea1746
    const int kNumObservations = atoi(pieces[0].c_str());
Packit ea1746
Packit ea1746
    SkipLines(ifs, 4);
Packit ea1746
    GetAndSplitLine(ifs, &pieces);
Packit ea1746
    const int kNumParameters = atoi(pieces[0].c_str());
Packit ea1746
    SkipLines(ifs, 8);
Packit ea1746
Packit ea1746
    // Get the first line of initial and final parameter values to
Packit ea1746
    // determine the number of tries.
Packit ea1746
    GetAndSplitLine(ifs, &pieces);
Packit ea1746
    const int kNumTries = pieces.size() - 4;
Packit ea1746
Packit ea1746
    predictor_.resize(kNumObservations, kNumPredictors);
Packit ea1746
    response_.resize(kNumObservations, kNumResponses);
Packit ea1746
    initial_parameters_.resize(kNumTries, kNumParameters);
Packit ea1746
    final_parameters_.resize(1, kNumParameters);
Packit ea1746
Packit ea1746
    // Parse the line for parameter b1.
Packit ea1746
    int parameter_id = 0;
Packit ea1746
    for (int i = 0; i < kNumTries; ++i) {
Packit ea1746
      initial_parameters_(i, parameter_id) = atof(pieces[i + 2].c_str());
Packit ea1746
    }
Packit ea1746
    final_parameters_(0, parameter_id) = atof(pieces[2 + kNumTries].c_str());
Packit ea1746
Packit ea1746
    // Parse the remaining parameter lines.
Packit ea1746
    for (int parameter_id = 1; parameter_id < kNumParameters; ++parameter_id) {
Packit ea1746
     GetAndSplitLine(ifs, &pieces);
Packit ea1746
     // b2, b3, ....
Packit ea1746
     for (int i = 0; i < kNumTries; ++i) {
Packit ea1746
       initial_parameters_(i, parameter_id) = atof(pieces[i + 2].c_str());
Packit ea1746
     }
Packit ea1746
     final_parameters_(0, parameter_id) = atof(pieces[2 + kNumTries].c_str());
Packit ea1746
    }
Packit ea1746
Packit ea1746
    // Certfied cost
Packit ea1746
    SkipLines(ifs, 1);
Packit ea1746
    GetAndSplitLine(ifs, &pieces);
Packit ea1746
    certified_cost_ = atof(pieces[4].c_str()) / 2.0;
Packit ea1746
Packit ea1746
    // Read the observations.
Packit ea1746
    SkipLines(ifs, 18 - kNumParameters);
Packit ea1746
    for (int i = 0; i < kNumObservations; ++i) {
Packit ea1746
      GetAndSplitLine(ifs, &pieces);
Packit ea1746
      // Response.
Packit ea1746
      for (int j = 0; j < kNumResponses; ++j) {
Packit ea1746
        response_(i, j) =  atof(pieces[j].c_str());
Packit ea1746
      }
Packit ea1746
Packit ea1746
      // Predictor variables.
Packit ea1746
      for (int j = 0; j < kNumPredictors; ++j) {
Packit ea1746
        predictor_(i, j) =  atof(pieces[j + kNumResponses].c_str());
Packit ea1746
      }
Packit ea1746
    }
Packit ea1746
  }
Packit ea1746
Packit ea1746
  Matrix initial_parameters(int start) const { return initial_parameters_.row(start); }  // NOLINT
Packit ea1746
  Matrix final_parameters() const  { return final_parameters_; }
Packit ea1746
  Matrix predictor()        const { return predictor_;         }
Packit ea1746
  Matrix response()         const { return response_;          }
Packit ea1746
  int predictor_size()      const { return predictor_.cols();  }
Packit ea1746
  int num_observations()    const { return predictor_.rows();  }
Packit ea1746
  int response_size()       const { return response_.cols();   }
Packit ea1746
  int num_parameters()      const { return initial_parameters_.cols(); }
Packit ea1746
  int num_starts()          const { return initial_parameters_.rows(); }
Packit ea1746
  double certified_cost()   const { return certified_cost_; }
Packit ea1746
Packit ea1746
 private:
Packit ea1746
  Matrix predictor_;
Packit ea1746
  Matrix response_;
Packit ea1746
  Matrix initial_parameters_;
Packit ea1746
  Matrix final_parameters_;
Packit ea1746
  double certified_cost_;
Packit ea1746
};
Packit ea1746
Packit ea1746
#define NIST_BEGIN(CostFunctionName) \
Packit ea1746
  struct CostFunctionName { \
Packit ea1746
    CostFunctionName(const double* const x, \
Packit ea1746
                     const double* const y) \
Packit ea1746
        : x_(*x), y_(*y) {} \
Packit ea1746
    double x_; \
Packit ea1746
    double y_; \
Packit ea1746
    template <typename T> \
Packit ea1746
    bool operator()(const T* const b, T* residual) const { \
Packit ea1746
    const T y(y_); \
Packit ea1746
    const T x(x_); \
Packit ea1746
      residual[0] = y - (
Packit ea1746
Packit ea1746
#define NIST_END ); return true; }};
Packit ea1746
Packit ea1746
// y = b1 * (b2+x)**(-1/b3)  +  e
Packit ea1746
NIST_BEGIN(Bennet5)
Packit ea1746
  b[0] * pow(b[1] + x, -1.0 / b[2])
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1*(1-exp[-b2*x])  +  e
Packit ea1746
NIST_BEGIN(BoxBOD)
Packit ea1746
  b[0] * (1.0 - exp(-b[1] * x))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = exp[-b1*x]/(b2+b3*x)  +  e
Packit ea1746
NIST_BEGIN(Chwirut)
Packit ea1746
  exp(-b[0] * x) / (b[1] + b[2] * x)
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y  = b1*x**b2  +  e
Packit ea1746
NIST_BEGIN(DanWood)
Packit ea1746
  b[0] * pow(x, b[1])
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1*exp( -b2*x ) + b3*exp( -(x-b4)**2 / b5**2 )
Packit ea1746
//     + b6*exp( -(x-b7)**2 / b8**2 ) + e
Packit ea1746
NIST_BEGIN(Gauss)
Packit ea1746
  b[0] * exp(-b[1] * x) +
Packit ea1746
  b[2] * exp(-pow((x - b[3])/b[4], 2)) +
Packit ea1746
  b[5] * exp(-pow((x - b[6])/b[7], 2))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1*exp(-b2*x) + b3*exp(-b4*x) + b5*exp(-b6*x)  +  e
Packit ea1746
NIST_BEGIN(Lanczos)
Packit ea1746
  b[0] * exp(-b[1] * x) + b[2] * exp(-b[3] * x) + b[4] * exp(-b[5] * x)
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = (b1+b2*x+b3*x**2+b4*x**3) /
Packit ea1746
//     (1+b5*x+b6*x**2+b7*x**3)  +  e
Packit ea1746
NIST_BEGIN(Hahn1)
Packit ea1746
  (b[0] + b[1] * x + b[2] * x * x + b[3] * x * x * x) /
Packit ea1746
  (1.0 + b[4] * x + b[5] * x * x + b[6] * x * x * x)
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = (b1 + b2*x + b3*x**2) /
Packit ea1746
//    (1 + b4*x + b5*x**2)  +  e
Packit ea1746
NIST_BEGIN(Kirby2)
Packit ea1746
  (b[0] + b[1] * x + b[2] * x * x) /
Packit ea1746
  (1.0 + b[3] * x + b[4] * x * x)
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1*(x**2+x*b2) / (x**2+x*b3+b4)  +  e
Packit ea1746
NIST_BEGIN(MGH09)
Packit ea1746
  b[0] * (x * x + x * b[1]) / (x * x + x * b[2] + b[3])
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 * exp[b2/(x+b3)]  +  e
Packit ea1746
NIST_BEGIN(MGH10)
Packit ea1746
  b[0] * exp(b[1] / (x + b[2]))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 + b2*exp[-x*b4] + b3*exp[-x*b5]
Packit ea1746
NIST_BEGIN(MGH17)
Packit ea1746
  b[0] + b[1] * exp(-x * b[3]) + b[2] * exp(-x * b[4])
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1*(1-exp[-b2*x])  +  e
Packit ea1746
NIST_BEGIN(Misra1a)
Packit ea1746
  b[0] * (1.0 - exp(-b[1] * x))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 * (1-(1+b2*x/2)**(-2))  +  e
Packit ea1746
NIST_BEGIN(Misra1b)
Packit ea1746
  b[0] * (1.0 - 1.0/ ((1.0 + b[1] * x / 2.0) * (1.0 + b[1] * x / 2.0)))  // NOLINT
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 * (1-(1+2*b2*x)**(-.5))  +  e
Packit ea1746
NIST_BEGIN(Misra1c)
Packit ea1746
  b[0] * (1.0 - pow(1.0 + 2.0 * b[1] * x, -0.5))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1*b2*x*((1+b2*x)**(-1))  +  e
Packit ea1746
NIST_BEGIN(Misra1d)
Packit ea1746
  b[0] * b[1] * x / (1.0 + b[1] * x)
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
const double kPi = 3.141592653589793238462643383279;
Packit ea1746
// pi = 3.141592653589793238462643383279E0
Packit ea1746
// y =  b1 - b2*x - arctan[b3/(x-b4)]/pi  +  e
Packit ea1746
NIST_BEGIN(Roszman1)
Packit ea1746
  b[0] - b[1] * x - atan2(b[2], (x - b[3])) / kPi
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 / (1+exp[b2-b3*x])  +  e
Packit ea1746
NIST_BEGIN(Rat42)
Packit ea1746
  b[0] / (1.0 + exp(b[1] - b[2] * x))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 / ((1+exp[b2-b3*x])**(1/b4))  +  e
Packit ea1746
NIST_BEGIN(Rat43)
Packit ea1746
  b[0] / pow(1.0 + exp(b[1] - b[2] * x), 1.0 / b[3])
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = (b1 + b2*x + b3*x**2 + b4*x**3) /
Packit ea1746
//    (1 + b5*x + b6*x**2 + b7*x**3)  +  e
Packit ea1746
NIST_BEGIN(Thurber)
Packit ea1746
  (b[0] + b[1] * x + b[2] * x * x  + b[3] * x * x * x) /
Packit ea1746
  (1.0 + b[4] * x + b[5] * x * x + b[6] * x * x * x)
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = b1 + b2*cos( 2*pi*x/12 ) + b3*sin( 2*pi*x/12 )
Packit ea1746
//        + b5*cos( 2*pi*x/b4 ) + b6*sin( 2*pi*x/b4 )
Packit ea1746
//        + b8*cos( 2*pi*x/b7 ) + b9*sin( 2*pi*x/b7 )  + e
Packit ea1746
NIST_BEGIN(ENSO)
Packit ea1746
  b[0] + b[1] * cos(2.0 * kPi * x / 12.0) +
Packit ea1746
         b[2] * sin(2.0 * kPi * x / 12.0) +
Packit ea1746
         b[4] * cos(2.0 * kPi * x / b[3]) +
Packit ea1746
         b[5] * sin(2.0 * kPi * x / b[3]) +
Packit ea1746
         b[7] * cos(2.0 * kPi * x / b[6]) +
Packit ea1746
         b[8] * sin(2.0 * kPi * x / b[6])
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
// y = (b1/b2) * exp[-0.5*((x-b3)/b2)**2]  +  e
Packit ea1746
NIST_BEGIN(Eckerle4)
Packit ea1746
  b[0] / b[1] * exp(-0.5 * pow((x - b[2])/b[1], 2))
Packit ea1746
NIST_END
Packit ea1746
Packit ea1746
struct Nelson {
Packit ea1746
 public:
Packit ea1746
  Nelson(const double* const x, const double* const y)
Packit ea1746
      : x1_(x[0]), x2_(x[1]), y_(y[0]) {}
Packit ea1746
Packit ea1746
  template <typename T>
Packit ea1746
  bool operator()(const T* const b, T* residual) const {
Packit ea1746
    // log[y] = b1 - b2*x1 * exp[-b3*x2]  +  e
Packit ea1746
    residual[0] = log(y_) - (b[0] - b[1] * x1_ * exp(-b[2] * x2_));
Packit ea1746
    return true;
Packit ea1746
  }
Packit ea1746
Packit ea1746
 private:
Packit ea1746
  double x1_;
Packit ea1746
  double x2_;
Packit ea1746
  double y_;
Packit ea1746
};
Packit ea1746
Packit ea1746
static void SetNumericDiffOptions(ceres::NumericDiffOptions* options) {
Packit ea1746
  options->max_num_ridders_extrapolations = FLAGS_ridders_extrapolations;
Packit ea1746
  options->ridders_relative_initial_step_size = FLAGS_ridders_step_size;
Packit ea1746
}
Packit ea1746
Packit ea1746
string JoinPath(const string& dirname, const string& basename) {
Packit ea1746
#ifdef _WIN32
Packit ea1746
    static const char separator = '\\';
Packit ea1746
#else
Packit ea1746
    static const char separator = '/';
Packit ea1746
#endif  // _WIN32
Packit ea1746
Packit ea1746
  if ((!basename.empty() && basename[0] == separator) || dirname.empty()) {
Packit ea1746
    return basename;
Packit ea1746
  } else if (dirname[dirname.size() - 1] == separator) {
Packit ea1746
    return dirname + basename;
Packit ea1746
  } else {
Packit ea1746
    return dirname + string(&separator, 1) + basename;
Packit ea1746
  }
Packit ea1746
}
Packit ea1746
Packit ea1746
template <typename Model, int num_residuals, int num_parameters>
Packit ea1746
int RegressionDriver(const string& filename,
Packit ea1746
                     const ceres::Solver::Options& options) {
Packit ea1746
  NISTProblem nist_problem(JoinPath(FLAGS_nist_data_dir, filename));
Packit ea1746
  CHECK_EQ(num_residuals, nist_problem.response_size());
Packit ea1746
  CHECK_EQ(num_parameters, nist_problem.num_parameters());
Packit ea1746
Packit ea1746
  Matrix predictor = nist_problem.predictor();
Packit ea1746
  Matrix response = nist_problem.response();
Packit ea1746
  Matrix final_parameters = nist_problem.final_parameters();
Packit ea1746
Packit ea1746
  printf("%s\n", filename.c_str());
Packit ea1746
Packit ea1746
  // Each NIST problem comes with multiple starting points, so we
Packit ea1746
  // construct the problem from scratch for each case and solve it.
Packit ea1746
  int num_success = 0;
Packit ea1746
  for (int start = 0; start < nist_problem.num_starts(); ++start) {
Packit ea1746
    Matrix initial_parameters = nist_problem.initial_parameters(start);
Packit ea1746
Packit ea1746
    ceres::Problem problem;
Packit ea1746
    for (int i = 0; i < nist_problem.num_observations(); ++i) {
Packit ea1746
      Model* model = new Model(
Packit ea1746
          predictor.data() + nist_problem.predictor_size() * i,
Packit ea1746
          response.data() + nist_problem.response_size() * i);
Packit ea1746
      ceres::CostFunction* cost_function = NULL;
Packit ea1746
      if (FLAGS_use_numeric_diff) {
Packit ea1746
        ceres::NumericDiffOptions options;
Packit ea1746
        SetNumericDiffOptions(&options);
Packit ea1746
        if (FLAGS_numeric_diff_method == "central") {
Packit ea1746
          cost_function = new NumericDiffCostFunction
Packit ea1746
                                                      ceres::CENTRAL,
Packit ea1746
                                                      num_residuals,
Packit ea1746
                                                      num_parameters>(
Packit ea1746
              model, ceres::TAKE_OWNERSHIP, num_residuals, options);
Packit ea1746
        } else if (FLAGS_numeric_diff_method == "forward") {
Packit ea1746
          cost_function = new NumericDiffCostFunction
Packit ea1746
                                                      ceres::FORWARD,
Packit ea1746
                                                      num_residuals,
Packit ea1746
                                                      num_parameters>(
Packit ea1746
              model, ceres::TAKE_OWNERSHIP, num_residuals, options);
Packit ea1746
        } else if (FLAGS_numeric_diff_method == "ridders") {
Packit ea1746
          cost_function = new NumericDiffCostFunction
Packit ea1746
                                                      ceres::RIDDERS,
Packit ea1746
                                                      num_residuals,
Packit ea1746
                                                      num_parameters>(
Packit ea1746
              model, ceres::TAKE_OWNERSHIP, num_residuals, options);
Packit ea1746
        } else {
Packit ea1746
          LOG(ERROR) << "Invalid numeric diff method specified";
Packit ea1746
          return 0;
Packit ea1746
        }
Packit ea1746
      } else {
Packit ea1746
         cost_function =
Packit ea1746
             new ceres::AutoDiffCostFunction
Packit ea1746
                                             num_residuals,
Packit ea1746
                                             num_parameters>(model);
Packit ea1746
      }
Packit ea1746
Packit ea1746
      problem.AddResidualBlock(cost_function,
Packit ea1746
                               NULL,
Packit ea1746
                               initial_parameters.data());
Packit ea1746
    }
Packit ea1746
Packit ea1746
    ceres::Solver::Summary summary;
Packit ea1746
    Solve(options, &problem, &summary);
Packit ea1746
Packit ea1746
    // Compute the LRE by comparing each component of the solution
Packit ea1746
    // with the ground truth, and taking the minimum.
Packit ea1746
    Matrix final_parameters = nist_problem.final_parameters();
Packit ea1746
    const double kMaxNumSignificantDigits = 11;
Packit ea1746
    double log_relative_error = kMaxNumSignificantDigits + 1;
Packit ea1746
    for (int i = 0; i < num_parameters; ++i) {
Packit ea1746
      const double tmp_lre =
Packit ea1746
          -std::log10(std::fabs(final_parameters(i) - initial_parameters(i)) /
Packit ea1746
                      std::fabs(final_parameters(i)));
Packit ea1746
      // The maximum LRE is capped at 11 - the precision at which the
Packit ea1746
      // ground truth is known.
Packit ea1746
      //
Packit ea1746
      // The minimum LRE is capped at 0 - no digits match between the
Packit ea1746
      // computed solution and the ground truth.
Packit ea1746
      log_relative_error =
Packit ea1746
          std::min(log_relative_error,
Packit ea1746
                   std::max(0.0, std::min(kMaxNumSignificantDigits, tmp_lre)));
Packit ea1746
    }
Packit ea1746
Packit ea1746
    const int kMinNumMatchingDigits = 4;
Packit ea1746
    if (log_relative_error > kMinNumMatchingDigits) {
Packit ea1746
      ++num_success;
Packit ea1746
    }
Packit ea1746
Packit ea1746
    printf("start: %d status: %s lre: %4.1f initial cost: %e final cost:%e "
Packit ea1746
           "certified cost: %e total iterations: %d\n",
Packit ea1746
           start + 1,
Packit ea1746
           log_relative_error < kMinNumMatchingDigits ? "FAILURE" : "SUCCESS",
Packit ea1746
           log_relative_error,
Packit ea1746
           summary.initial_cost,
Packit ea1746
           summary.final_cost,
Packit ea1746
           nist_problem.certified_cost(),
Packit ea1746
           (summary.num_successful_steps + summary.num_unsuccessful_steps));
Packit ea1746
  }
Packit ea1746
  return num_success;
Packit ea1746
}
Packit ea1746
Packit ea1746
void SetMinimizerOptions(ceres::Solver::Options* options) {
Packit ea1746
  CHECK(ceres::StringToMinimizerType(FLAGS_minimizer,
Packit ea1746
                                     &options->minimizer_type));
Packit ea1746
  CHECK(ceres::StringToLinearSolverType(FLAGS_linear_solver,
Packit ea1746
                                        &options->linear_solver_type));
Packit ea1746
  CHECK(ceres::StringToPreconditionerType(FLAGS_preconditioner,
Packit ea1746
                                          &options->preconditioner_type));
Packit ea1746
  CHECK(ceres::StringToTrustRegionStrategyType(
Packit ea1746
            FLAGS_trust_region_strategy,
Packit ea1746
            &options->trust_region_strategy_type));
Packit ea1746
  CHECK(ceres::StringToDoglegType(FLAGS_dogleg, &options->dogleg_type));
Packit ea1746
  CHECK(ceres::StringToLineSearchDirectionType(
Packit ea1746
      FLAGS_line_search_direction,
Packit ea1746
      &options->line_search_direction_type));
Packit ea1746
  CHECK(ceres::StringToLineSearchType(FLAGS_line_search,
Packit ea1746
                                      &options->line_search_type));
Packit ea1746
  CHECK(ceres::StringToLineSearchInterpolationType(
Packit ea1746
      FLAGS_line_search_interpolation,
Packit ea1746
      &options->line_search_interpolation_type));
Packit ea1746
Packit ea1746
  options->max_num_iterations = FLAGS_num_iterations;
Packit ea1746
  options->use_nonmonotonic_steps = FLAGS_nonmonotonic_steps;
Packit ea1746
  options->initial_trust_region_radius = FLAGS_initial_trust_region_radius;
Packit ea1746
  options->max_lbfgs_rank = FLAGS_lbfgs_rank;
Packit ea1746
  options->line_search_sufficient_function_decrease = FLAGS_sufficient_decrease;
Packit ea1746
  options->line_search_sufficient_curvature_decrease =
Packit ea1746
      FLAGS_sufficient_curvature_decrease;
Packit ea1746
  options->max_num_line_search_step_size_iterations =
Packit ea1746
      FLAGS_max_line_search_iterations;
Packit ea1746
  options->max_num_line_search_direction_restarts =
Packit ea1746
      FLAGS_max_line_search_restarts;
Packit ea1746
  options->use_approximate_eigenvalue_bfgs_scaling =
Packit ea1746
      FLAGS_approximate_eigenvalue_bfgs_scaling;
Packit ea1746
  options->function_tolerance = std::numeric_limits<double>::epsilon();
Packit ea1746
  options->gradient_tolerance = std::numeric_limits<double>::epsilon();
Packit ea1746
  options->parameter_tolerance = std::numeric_limits<double>::epsilon();
Packit ea1746
}
Packit ea1746
Packit ea1746
void SolveNISTProblems() {
Packit ea1746
  if (FLAGS_nist_data_dir.empty()) {
Packit ea1746
    LOG(FATAL) << "Must specify the directory containing the NIST problems";
Packit ea1746
  }
Packit ea1746
Packit ea1746
  ceres::Solver::Options options;
Packit ea1746
  SetMinimizerOptions(&options);
Packit ea1746
Packit ea1746
  cout << "Lower Difficulty\n";
Packit ea1746
  int easy_success = 0;
Packit ea1746
  easy_success += RegressionDriver<Misra1a,  1, 2>("Misra1a.dat",  options);
Packit ea1746
  easy_success += RegressionDriver<Chwirut,  1, 3>("Chwirut1.dat", options);
Packit ea1746
  easy_success += RegressionDriver<Chwirut,  1, 3>("Chwirut2.dat", options);
Packit ea1746
  easy_success += RegressionDriver<Lanczos,  1, 6>("Lanczos3.dat", options);
Packit ea1746
  easy_success += RegressionDriver<Gauss,    1, 8>("Gauss1.dat",   options);
Packit ea1746
  easy_success += RegressionDriver<Gauss,    1, 8>("Gauss2.dat",   options);
Packit ea1746
  easy_success += RegressionDriver<DanWood,  1, 2>("DanWood.dat",  options);
Packit ea1746
  easy_success += RegressionDriver<Misra1b,  1, 2>("Misra1b.dat",  options);
Packit ea1746
Packit ea1746
  cout << "\nMedium Difficulty\n";
Packit ea1746
  int medium_success = 0;
Packit ea1746
  medium_success += RegressionDriver<Kirby2,   1, 5>("Kirby2.dat",   options);
Packit ea1746
  medium_success += RegressionDriver<Hahn1,    1, 7>("Hahn1.dat",    options);
Packit ea1746
  medium_success += RegressionDriver<Nelson,   1, 3>("Nelson.dat",   options);
Packit ea1746
  medium_success += RegressionDriver<MGH17,    1, 5>("MGH17.dat",    options);
Packit ea1746
  medium_success += RegressionDriver<Lanczos,  1, 6>("Lanczos1.dat", options);
Packit ea1746
  medium_success += RegressionDriver<Lanczos,  1, 6>("Lanczos2.dat", options);
Packit ea1746
  medium_success += RegressionDriver<Gauss,    1, 8>("Gauss3.dat",   options);
Packit ea1746
  medium_success += RegressionDriver<Misra1c,  1, 2>("Misra1c.dat",  options);
Packit ea1746
  medium_success += RegressionDriver<Misra1d,  1, 2>("Misra1d.dat",  options);
Packit ea1746
  medium_success += RegressionDriver<Roszman1, 1, 4>("Roszman1.dat", options);
Packit ea1746
  medium_success += RegressionDriver<ENSO,     1, 9>("ENSO.dat",     options);
Packit ea1746
Packit ea1746
  cout << "\nHigher Difficulty\n";
Packit ea1746
  int hard_success = 0;
Packit ea1746
  hard_success += RegressionDriver<MGH09,    1, 4>("MGH09.dat",    options);
Packit ea1746
  hard_success += RegressionDriver<Thurber,  1, 7>("Thurber.dat",  options);
Packit ea1746
  hard_success += RegressionDriver<BoxBOD,   1, 2>("BoxBOD.dat",   options);
Packit ea1746
  hard_success += RegressionDriver<Rat42,    1, 3>("Rat42.dat",    options);
Packit ea1746
  hard_success += RegressionDriver<MGH10,    1, 3>("MGH10.dat",    options);
Packit ea1746
Packit ea1746
  hard_success += RegressionDriver<Eckerle4, 1, 3>("Eckerle4.dat", options);
Packit ea1746
  hard_success += RegressionDriver<Rat43,    1, 4>("Rat43.dat",    options);
Packit ea1746
  hard_success += RegressionDriver<Bennet5,  1, 3>("Bennett5.dat", options);
Packit ea1746
Packit ea1746
  cout << "\n";
Packit ea1746
  cout << "Easy    : " << easy_success << "/16\n";
Packit ea1746
  cout << "Medium  : " << medium_success << "/22\n";
Packit ea1746
  cout << "Hard    : " << hard_success << "/16\n";
Packit ea1746
  cout << "Total   : "
Packit ea1746
       << easy_success + medium_success + hard_success << "/54\n";
Packit ea1746
}
Packit ea1746
Packit ea1746
}  // namespace examples
Packit ea1746
}  // namespace ceres
Packit ea1746
Packit ea1746
int main(int argc, char** argv) {
Packit ea1746
  CERES_GFLAGS_NAMESPACE::ParseCommandLineFlags(&argc, &argv, true);
Packit ea1746
  google::InitGoogleLogging(argv[0]);
Packit ea1746
  ceres::examples::SolveNISTProblems();
Packit ea1746
  return 0;
Packit ea1746
}