octave/nlopt_optimize-oct.cc

   1 /* Copyright (c) 2007-2010 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 <math.h>
  27 #include <stdio.h>
  28
  29 #include "nlopt.h"
  30 #include "nlopt_optimize_usage.h"
  31
  32 static int struct_val_default(Octave_map &m, const std::string& k,
  33                                  int dflt)
  34 {
  35   if (m.contains(k)) {
  36     if (m.contents(k).length() == 1 && (m.contents(k))(0).is_real_scalar())
  37       return (m.contents(k))(0).int_value();
  38   }
  39   return dflt;
  40 }
  41
  42 static double struct_val_default(Octave_map &m, const std::string& k,
  43                                  double dflt)
  44 {
  45   if (m.contains(k)) {
  46     if (m.contents(k).length() == 1 && (m.contents(k))(0).is_real_scalar())
  47       return (m.contents(k))(0).double_value();
  48   }
  49   return dflt;
  50 }
  51
  52 static Matrix struct_val_default(Octave_map &m, const std::string& k,
  53                                  Matrix &dflt)
  54 {
  55   if (m.contains(k)) {
  56     if ((m.contents(k)).length() == 1) {
  57       if ((m.contents(k))(0).is_real_scalar())
  58         return Matrix(1, dflt.length(), (m.contents(k))(0).double_value());
  59       else if ((m.contents(k))(0).is_real_matrix())
  60         return (m.contents(k))(0).matrix_value();
  61     }
  62   }
  63   return dflt;
  64 }
  65
  66 typedef struct {
  67   octave_function *f;
  68   int neval, verbose;
  69 } user_function_data;
  70
  71 static double user_function(unsigned n, const double *x,
  72                             double *gradient, /* NULL if not needed */
  73                             void *data_)
  74 {
  75   user_function_data *data = (user_function_data *) data_;
  76   octave_value_list args(1, 0);
  77   Matrix xm(1,n);
  78   for (unsigned i = 0; i < n; ++i)
  79     xm(i) = x[i];
  80   args(0) = xm;
  81   octave_value_list res = data->f->do_multi_index_op(gradient ? 2 : 1, args);
  82   if (res.length() < (gradient ? 2 : 1))
  83     gripe_user_supplied_eval("nlopt_optimize");
  84   else if (!res(0).is_real_scalar()
  85            || (gradient && !res(1).is_real_matrix()
  86                && !(n == 1 && res(1).is_real_scalar())))
  87     gripe_user_returned_invalid("nlopt_optimize");
  88   else {
  89     if (gradient) {
  90       if (n == 1 && res(1).is_real_scalar())
  91         gradient[0] = res(1).double_value();
  92       else {
  93         Matrix grad = res(1).matrix_value();
  94         for (unsigned i = 0; i < n; ++i)
  95           gradient[i] = grad(i);
  96       }
  97     }
  98     data->neval++;
  99     if (data->verbose) printf("nlopt_optimize eval #%d: %g\n",
 100                               data->neval, res(0).double_value());
 101     return res(0).double_value();
 102   }
 103   return 0;
 104 }
 105
 106 static double user_function1(unsigned n, const double *x,
 107                             double *gradient, /* NULL if not needed */
 108                             void *data_)
 109 {
 110   octave_function *f = (octave_function *) data_;
 111   octave_value_list args(1, 0);
 112   Matrix xm(1,n);
 113   for (unsigned i = 0; i < n; ++i)
 114     xm(i) = x[i];
 115   args(0) = xm;
 116   octave_value_list res = f->do_multi_index_op(gradient ? 2 : 1, args);
 117   if (res.length() < (gradient ? 2 : 1))
 118     gripe_user_supplied_eval("nlopt_optimize");
 119   else if (!res(0).is_real_scalar()
 120            || (gradient && !res(1).is_real_matrix()
 121                && !(n == 1 && res(1).is_real_scalar())))
 122     gripe_user_returned_invalid("nlopt_optimize");
 123   else {
 124     if (gradient) {
 125       if (n == 1 && res(1).is_real_scalar())
 126         gradient[0] = res(1).double_value();
 127       else {
 128         Matrix grad = res(1).matrix_value();
 129         for (unsigned i = 0; i < n; ++i)
 130           gradient[i] = grad(i);
 131       }
 132     }
 133     return res(0).double_value();
 134   }
 135   return 0;
 136 }
 137
 138 #define CHECK1(cond, msg) if (!(cond)) { fprintf(stderr, msg "\n\n"); nlopt_destroy(opt); nlopt_destroy(local_opt); return NULL; }
 139
 140 nlopt_opt make_opt(Octave_map &opts, int n)
 141 {
 142   nlopt_opt opt = NULL, local_opt = NULL;
 143
 144   nlopt_algorithm algorithm =
 145     nlopt_algorithm(struct_val_default(opts, "algorithm",
 146                                        NLOPT_NUM_ALGORITHMS));
 147   CHECK1(((int)algorithm) >= 0 && algorithm < NLOPT_NUM_ALGORITHMS,
 148         "invalid opt.algorithm");
 149
 150   opt = nlopt_create(algorithm, n);
 151   CHECK1(opt, "nlopt: out of memory");
 152
 153   Matrix m_inf(1, n, -HUGE_VAL);
 154   Matrix lb = struct_val_default(opts, "lower_bounds", m_inf);
 155   CHECK1(n == lb.length(), "wrong length of opt.lower_bounds");
 156   CHECK1(nlopt_set_lower_bounds(opt, lb.data()) > 0, "nlopt: out of memory");
 157
 158   Matrix p_inf(1, n, +HUGE_VAL);
 159   Matrix ub = struct_val_default(opts, "upper_bounds", p_inf);
 160   CHECK1(n == ub.length(), "wrong length of opt.upper_bounds");
 161   CHECK1(nlopt_set_upper_bounds(opt, ub.data()) > 0, "nlopt: out of memory");
 162
 163   nlopt_set_stopval(opt, struct_val_default(opts, "stopval", -HUGE_VAL));
 164   nlopt_set_ftol_rel(opt, struct_val_default(opts, "ftol_rel", 0.0));
 165   nlopt_set_ftol_abs(opt, struct_val_default(opts, "ftol_abs", 0.0));
 166   nlopt_set_xtol_rel(opt, struct_val_default(opts, "xtol_rel", 0.0));
 167
 168   {
 169     Matrix zeros(1, n, 0.0);
 170     Matrix xtol_abs = struct_val_default(opts, "xtol_abs", zeros);
 171     CHECK1(n == xtol_abs.length(), "stop.xtol_abs must have same length as x");
 172     CHECK1(nlopt_set_xtol_abs(opt, xtol_abs.data())>0, "nlopt: out of memory");
 173   }
 174
 175   nlopt_set_maxeval(opt, struct_val_default(opts, "maxeval", 0) < 0 ?
 176                     0 : struct_val_default(opts, "maxeval", 0));
 177   nlopt_set_maxtime(opt, struct_val_default(opts, "maxtime", 0.0));
 178
 179   nlopt_set_population(opt, struct_val_default(opts, "population", 0));
 180   nlopt_set_subspace_dim(opt, struct_val_default(opts, "subspace_dim", 0));
 181
 182   if (opts.contains("initial_step")) {
 183     Matrix zeros(1, n, 0.0);
 184     Matrix initial_step = struct_val_default(opts, "initial_step", zeros);
 185     CHECK1(n == initial_step.length(),
 186           "stop.initial_step must have same length as x");
 187     CHECK1(nlopt_set_initial_step(opt, initial_step.data()) > 0,
 188           "nlopt: out of memory");
 189   }
 190
 191   if (opts.contains("local_optimizer")) {
 192     CHECK1(opts.contents("local_optimizer").length() == 1
 193           && (opts.contents("local_optimizer"))(0).is_map(),
 194           "opt.local_optimizer must be a structure");
 195     Octave_map local_opts = (opts.contents("local_optimizer"))(0).map_value();
 196     CHECK1((local_opt = make_opt(local_opts, n)),
 197           "error initializing local optimizer");
 198     nlopt_set_local_optimizer(opt, local_opt);
 199     nlopt_destroy(local_opt); local_opt = NULL;
 200   }
 201
 202   return opt;
 203 }
 204
 205 #define CHECK(cond, msg) if (!(cond)) { fprintf(stderr, msg "\n\n"); nlopt_destroy(opt); return retval; }
 206
 207 DEFUN_DLD(nlopt_optimize, args, nargout, NLOPT_OPTIMIZE_USAGE)
 208 {
 209   octave_value_list retval;
 210   double A;
 211   nlopt_opt opt = NULL;
 212
 213   CHECK(args.length() == 2 && nargout <= 3, "wrong number of args");
 214
 215   CHECK(args(0).is_map(), "opt must be structure")
 216   Octave_map opts = args(0).map_value();
 217
 218   CHECK(args(1).is_real_matrix() || args(1).is_real_scalar(),
 219         "x must be real vector");
 220   Matrix x = args(1).is_real_scalar() ?
 221     Matrix(1, 1, args(1).double_value()) : args(1).matrix_value();
 222   int n = x.length();
 223
 224   CHECK((opt = make_opt(opts, n)), "error initializing nlopt options");
 225
 226   user_function_data d;
 227   d.neval = 0;
 228   d.verbose = struct_val_default(opts, "verbose", 0);
 229   if (opts.contains("min_objective")) {
 230     CHECK(opts.contents("min_objective").length() == 1
 231           && (opts.contents("min_objective"))(0).is_function_handle(),
 232           "opt.min_objective must be a function");
 233       d.f = (opts.contents("min_objective"))(0).function_value();
 234       nlopt_set_min_objective(opt, user_function, &d);
 235   }
 236   else if (opts.contains("max_objective")) {
 237     CHECK(opts.contents("max_objective").length() == 1
 238           && (opts.contents("max_objective"))(0).is_function_handle(),
 239           "opt.max_objective must be a function");
 240       d.f = (opts.contents("max_objective"))(0).function_value();
 241       nlopt_set_max_objective(opt, user_function, &d);
 242   }
 243   else {
 244     CHECK(0,"either opt.min_objective or opt.max_objective must exist");
 245   }
 246
 247   if (opts.contains("fc") && opts.contents("fc").length() == 1) {
 248     CHECK((opts.contents("fc"))(0).is_cell(), "opt.fc must be cell array");
 249     Cell fc = (opts.contents("fc"))(0).cell_value();
 250     Matrix zeros(1, fc.length(), 0.0);
 251     Matrix fc_tol = struct_val_default(opts, "fc_tol", zeros);
 252     CHECK(fc_tol.length() == fc.length(),
 253           "opt.fc must have same length as opt.fc_tol");
 254     for (int i = 0; i < fc.length(); ++i) {
 255       CHECK(fc(i).is_function() || fc(i).is_function_handle(),
 256             "opt.fc must be a cell array of function handles");
 257       CHECK(nlopt_add_inequality_constraint(opt, user_function1,
 258                                             fc(i).function_value(),
 259                                             fc_tol(i)) > 0,
 260             "nlopt error adding inequality constraint");
 261     }
 262   }
 263
 264   if (opts.contains("h") && opts.contents("h").length() == 1) {
 265     CHECK((opts.contents("h"))(0).is_cell(), "opt.h must be cell array");
 266     Cell h = (opts.contents("h"))(0).cell_value();
 267     Matrix zeros(1, h.length(), 0.0);
 268     Matrix h_tol = struct_val_default(opts, "h_tol", zeros);
 269     CHECK(h_tol.length() == h.length(),
 270           "opt.h must have same length as opt.h_tol");
 271     for (int i = 0; i < h.length(); ++i) {
 272       CHECK(h(i).is_function() || h(i).is_function_handle(),
 273             "opt.h must be a cell array of function handles");
 274       CHECK(nlopt_add_equality_constraint(opt, user_function1,
 275                                             h(i).function_value(),
 276                                             h_tol(i)) > 0,
 277             "nlopt error adding equality constraint");
 278     }
 279   }
 280
 281
 282   double opt_f;
 283   nlopt_result ret = nlopt_optimize(opt, x.fortran_vec(), &opt_f);
 284
 285   retval(0) = x;
 286   if (nargout > 1)
 287     retval(1) = opt_f;
 288   if (nargout > 2)
 289     retval(2) = int(ret);
 290
 291   nlopt_destroy(opt);
 292
 293   return retval;
 294 }