octave/nlopt_optimize-oct.cc

   1 /* Copyright (c) 2007-2014 Massachusetts Institute of Technology
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining
   4  * a copy of this software and associated documentation files (the
   5  * "Software"), to deal in the Software without restriction, including
   6  * without limitation the rights to use, copy, modify, merge, publish,
   7  * distribute, sublicense, and/or sell copies of the Software, and to
   8  * permit persons to whom the Software is furnished to do so, subject to
   9  * the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be
  12  * included in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  18  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  19  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  20  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #include <octave/oct.h>
  24 #include <octave/oct-map.h>
  25 #include <octave/ov.h>
  26 #include <octave/parse.h>
  27 #include <math.h>
  28 #include <stdio.h>
  29
  30 #include "nlopt.h"
  31 #include "nlopt_optimize_usage.h"
  32
  33 static int struct_val_default(octave_map &m, const std::string& k,
  34                                  int dflt)
  35 {
  36   if (m.contains(k)) {
  37     if (m.contents(k).length() == 1 && (m.contents(k))(0).is_real_scalar())
  38       return (m.contents(k))(0).int_value();
  39   }
  40   return dflt;
  41 }
  42
  43 static double struct_val_default(octave_map &m, const std::string& k,
  44                                  double dflt)
  45 {
  46   if (m.contains(k)) {
  47     if (m.contents(k).length() == 1 && (m.contents(k))(0).is_real_scalar())
  48       return (m.contents(k))(0).double_value();
  49   }
  50   return dflt;
  51 }
  52
  53 static Matrix struct_val_default(octave_map &m, const std::string& k,
  54                                  Matrix &dflt)
  55 {
  56   if (m.contains(k)) {
  57     if ((m.contents(k)).length() == 1) {
  58       if ((m.contents(k))(0).is_real_scalar())
  59         return Matrix(1, dflt.length(), (m.contents(k))(0).double_value());
  60       else if ((m.contents(k))(0).is_real_matrix())
  61         return (m.contents(k))(0).matrix_value();
  62     }
  63   }
  64   return dflt;
  65 }
  66
  67 typedef struct {
  68   octave_function *f;
  69   int neval, verbose;
  70   nlopt_opt opt;
  71 } user_function_data;
  72
  73 static double user_function(unsigned n, const double *x,
  74                             double *gradient, /* NULL if not needed */
  75                             void *data_)
  76 {
  77   user_function_data *data = (user_function_data *) data_;
  78   octave_value_list args(1, 0);
  79   Matrix xm(1,n);
  80   for (unsigned i = 0; i < n; ++i)
  81     xm(i) = x[i];
  82   args(0) = xm;
  83   octave_value_list res
  84 #if (OCTAVE_MAJOR_VERSION == 4 && OCTAVE_MINOR_VERSION > 2)
  85     = octave::feval(data->f, args, gradient ? 2 : 1);
  86 #else
  87     = data->f->do_multi_index_op(gradient ? 2 : 1, args);
  88 #endif
  89   if (res.length() < (gradient ? 2 : 1))
  90     gripe_user_supplied_eval("nlopt_optimize");
  91   else if (!res(0).is_real_scalar()
  92            || (gradient && !res(1).is_real_matrix()
  93                && !(n == 1 && res(1).is_real_scalar())))
  94     gripe_user_returned_invalid("nlopt_optimize");
  95   else {
  96     if (gradient) {
  97       if (n == 1 && res(1).is_real_scalar())
  98         gradient[0] = res(1).double_value();
  99       else {
 100         Matrix grad = res(1).matrix_value();
 101         for (unsigned i = 0; i < n; ++i)
 102           gradient[i] = grad(i);
 103       }
 104     }
 105     data->neval++;
 106     if (data->verbose) printf("nlopt_optimize eval #%d: %g\n",
 107                               data->neval, res(0).double_value());
 108     double f = res(0).double_value();
 109     if (f != f /* isnan(f) */) nlopt_force_stop(data->opt);
 110     return f;
 111   }
 112   return 0;
 113 }
 114
 115 static double user_function1(unsigned n, const double *x,
 116                             double *gradient, /* NULL if not needed */
 117                             void *data_)
 118 {
 119   octave_function *f = (octave_function *) data_;
 120   octave_value_list args(1, 0);
 121   Matrix xm(1,n);
 122   for (unsigned i = 0; i < n; ++i)
 123     xm(i) = x[i];
 124   args(0) = xm;
 125   octave_value_list res
 126 #if (OCTAVE_MAJOR_VERSION == 4 && OCTAVE_MINOR_VERSION > 2)
 127     = octave::feval(f, args, gradient ? 2 : 1);
 128 #else
 129     = f->do_multi_index_op(gradient ? 2 : 1, args);
 130 #endif
 131   if (res.length() < (gradient ? 2 : 1))
 132     gripe_user_supplied_eval("nlopt_optimize");
 133   else if (!res(0).is_real_scalar()
 134            || (gradient && !res(1).is_real_matrix()
 135                && !(n == 1 && res(1).is_real_scalar())))
 136     gripe_user_returned_invalid("nlopt_optimize");
 137   else {
 138     if (gradient) {
 139       if (n == 1 && res(1).is_real_scalar())
 140         gradient[0] = res(1).double_value();
 141       else {
 142         Matrix grad = res(1).matrix_value();
 143         for (unsigned i = 0; i < n; ++i)
 144           gradient[i] = grad(i);
 145       }
 146     }
 147     return res(0).double_value();
 148   }
 149   return 0;
 150 }
 151
 152 #define CHECK1(cond, msg) if (!(cond)) { fprintf(stderr, msg "\n\n"); nlopt_destroy(opt); nlopt_destroy(local_opt); return NULL; }
 153
 154 nlopt_opt make_opt(octave_map &opts, int n)
 155 {
 156   nlopt_opt opt = NULL, local_opt = NULL;
 157
 158   nlopt_algorithm algorithm =
 159     nlopt_algorithm(struct_val_default(opts, "algorithm",
 160                                        NLOPT_NUM_ALGORITHMS));
 161   CHECK1(((int)algorithm) >= 0 && algorithm < NLOPT_NUM_ALGORITHMS,
 162         "invalid opt.algorithm");
 163
 164   opt = nlopt_create(algorithm, n);
 165   CHECK1(opt, "nlopt: out of memory");
 166
 167   Matrix m_inf(1, n, -HUGE_VAL);
 168   Matrix lb = struct_val_default(opts, "lower_bounds", m_inf);
 169   CHECK1(n == lb.length(), "wrong length of opt.lower_bounds");
 170   CHECK1(nlopt_set_lower_bounds(opt, lb.data()) > 0, "nlopt: out of memory");
 171
 172   Matrix p_inf(1, n, +HUGE_VAL);
 173   Matrix ub = struct_val_default(opts, "upper_bounds", p_inf);
 174   CHECK1(n == ub.length(), "wrong length of opt.upper_bounds");
 175   CHECK1(nlopt_set_upper_bounds(opt, ub.data()) > 0, "nlopt: out of memory");
 176
 177   nlopt_set_stopval(opt, struct_val_default(opts, "stopval", -HUGE_VAL));
 178   nlopt_set_ftol_rel(opt, struct_val_default(opts, "ftol_rel", 0.0));
 179   nlopt_set_ftol_abs(opt, struct_val_default(opts, "ftol_abs", 0.0));
 180   nlopt_set_xtol_rel(opt, struct_val_default(opts, "xtol_rel", 0.0));
 181
 182   {
 183     Matrix zeros(1, n, 0.0);
 184     Matrix xtol_abs = struct_val_default(opts, "xtol_abs", zeros);
 185     CHECK1(n == xtol_abs.length(), "stop.xtol_abs must have same length as x");
 186     CHECK1(nlopt_set_xtol_abs(opt, xtol_abs.data())>0, "nlopt: out of memory");
 187   }
 188
 189   nlopt_set_maxeval(opt, struct_val_default(opts, "maxeval", 0) < 0 ?
 190                     0 : struct_val_default(opts, "maxeval", 0));
 191   nlopt_set_maxtime(opt, struct_val_default(opts, "maxtime", 0.0));
 192
 193   nlopt_set_population(opt, struct_val_default(opts, "population", 0));
 194   nlopt_set_vector_storage(opt, struct_val_default(opts, "vector_storage", 0));
 195
 196   if (opts.contains("initial_step")) {
 197     Matrix zeros(1, n, 0.0);
 198     Matrix initial_step = struct_val_default(opts, "initial_step", zeros);
 199     CHECK1(n == initial_step.length(),
 200           "stop.initial_step must have same length as x");
 201     CHECK1(nlopt_set_initial_step(opt, initial_step.data()) > 0,
 202           "nlopt: out of memory");
 203   }
 204
 205   if (opts.contains("local_optimizer")) {
 206     CHECK1(opts.contents("local_optimizer").length() == 1
 207           && (opts.contents("local_optimizer"))(0).is_map(),
 208           "opt.local_optimizer must be a structure");
 209     octave_map local_opts = (opts.contents("local_optimizer"))(0).map_value();
 210     CHECK1((local_opt = make_opt(local_opts, n)),
 211           "error initializing local optimizer");
 212     nlopt_set_local_optimizer(opt, local_opt);
 213     nlopt_destroy(local_opt); local_opt = NULL;
 214   }
 215
 216   return opt;
 217 }
 218
 219 #define CHECK(cond, msg) if (!(cond)) { fprintf(stderr, msg "\n\n"); nlopt_destroy(opt); return retval; }
 220
 221 DEFUN_DLD(nlopt_optimize, args, nargout, NLOPT_OPTIMIZE_USAGE)
 222 {
 223   octave_value_list retval;
 224   double A;
 225   nlopt_opt opt = NULL;
 226
 227   CHECK(args.length() == 2 && nargout <= 3, "wrong number of args");
 228
 229   CHECK(args(0).is_map(), "opt must be structure")
 230   octave_map opts = args(0).map_value();
 231
 232   CHECK(args(1).is_real_matrix() || args(1).is_real_scalar(),
 233         "x must be real vector");
 234   Matrix x = args(1).is_real_scalar() ?
 235     Matrix(1, 1, args(1).double_value()) : args(1).matrix_value();
 236   int n = x.length();
 237
 238   CHECK((opt = make_opt(opts, n)), "error initializing nlopt options");
 239
 240   user_function_data d;
 241   d.neval = 0;
 242   d.verbose = struct_val_default(opts, "verbose", 0);
 243   d.opt = opt;
 244   if (opts.contains("min_objective")) {
 245     CHECK(opts.contents("min_objective").length() == 1
 246           && (opts.contents("min_objective"))(0).is_function_handle(),
 247           "opt.min_objective must be a function");
 248       d.f = (opts.contents("min_objective"))(0).function_value();
 249       nlopt_set_min_objective(opt, user_function, &d);
 250   }
 251   else if (opts.contains("max_objective")) {
 252     CHECK(opts.contents("max_objective").length() == 1
 253           && (opts.contents("max_objective"))(0).is_function_handle(),
 254           "opt.max_objective must be a function");
 255       d.f = (opts.contents("max_objective"))(0).function_value();
 256       nlopt_set_max_objective(opt, user_function, &d);
 257   }
 258   else {
 259     CHECK(0,"either opt.min_objective or opt.max_objective must exist");
 260   }
 261
 262   if (opts.contains("fc") && opts.contents("fc").length() == 1) {
 263     CHECK((opts.contents("fc"))(0).is_cell(), "opt.fc must be cell array");
 264     Cell fc = (opts.contents("fc"))(0).cell_value();
 265     Matrix zeros(1, fc.length(), 0.0);
 266     Matrix fc_tol = struct_val_default(opts, "fc_tol", zeros);
 267     CHECK(fc_tol.length() == fc.length(),
 268           "opt.fc must have same length as opt.fc_tol");
 269     for (int i = 0; i < fc.length(); ++i) {
 270       CHECK(fc(i).is_function() || fc(i).is_function_handle(),
 271             "opt.fc must be a cell array of function handles");
 272       CHECK(nlopt_add_inequality_constraint(opt, user_function1,
 273                                             fc(i).function_value(),
 274                                             fc_tol(i)) > 0,
 275             "nlopt error adding inequality constraint");
 276     }
 277   }
 278
 279   if (opts.contains("h") && opts.contents("h").length() == 1) {
 280     CHECK((opts.contents("h"))(0).is_cell(), "opt.h must be cell array");
 281     Cell h = (opts.contents("h"))(0).cell_value();
 282     Matrix zeros(1, h.length(), 0.0);
 283     Matrix h_tol = struct_val_default(opts, "h_tol", zeros);
 284     CHECK(h_tol.length() == h.length(),
 285           "opt.h must have same length as opt.h_tol");
 286     for (int i = 0; i < h.length(); ++i) {
 287       CHECK(h(i).is_function() || h(i).is_function_handle(),
 288             "opt.h must be a cell array of function handles");
 289       CHECK(nlopt_add_equality_constraint(opt, user_function1,
 290                                             h(i).function_value(),
 291                                             h_tol(i)) > 0,
 292             "nlopt error adding equality constraint");
 293     }
 294   }
 295
 296
 297   double opt_f;
 298   nlopt_result ret = nlopt_optimize(opt, x.fortran_vec(), &opt_f);
 299
 300   retval(0) = x;
 301   if (nargout > 1)
 302     retval(1) = opt_f;
 303   if (nargout > 2)
 304     retval(2) = int(ret);
 305
 306   nlopt_destroy(opt);
 307
 308   return retval;
 309 }