api/optimize.c

   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 <stdlib.h>
  24 #include <math.h>
  25 #include <float.h>
  26
  27 #include "nlopt-internal.h"
  28
  29 /*********************************************************************/
  30
  31 #ifndef HAVE_ISNAN
  32 static int my_isnan(double x) { return x != x; }
  33 #  define isnan my_isnan
  34 #endif
  35
  36 /*********************************************************************/
  37
  38 #include "praxis.h"
  39 #include "direct.h"
  40
  41 #ifdef WITH_CXX
  42 #  include "stogo.h"
  43 #endif
  44
  45 #include "cdirect.h"
  46
  47 #include "luksan.h"
  48
  49 #include "crs.h"
  50
  51 #include "mlsl.h"
  52 #include "mma.h"
  53 #include "cobyla.h"
  54 #include "newuoa.h"
  55 #include "neldermead.h"
  56 #include "auglag.h"
  57 #include "bobyqa.h"
  58 #include "isres.h"
  59 #include "esch.h"
  60 #include "slsqp.h"
  61
  62 /*********************************************************************/
  63
  64 static double f_bound(int n, const double *x, void *data_)
  65 {
  66      int i;
  67      nlopt_opt data = (nlopt_opt) data_;
  68      double f;
  69
  70      /* some methods do not support bound constraints, but support
  71         discontinuous objectives so we can just return Inf for invalid x */
  72      for (i = 0; i < n; ++i)
  73           if (x[i] < data->lb[i] || x[i] > data->ub[i])
  74                return HUGE_VAL;
  75
  76      f = data->f((unsigned) n, x, NULL, data->f_data);
  77      return (isnan(f) || nlopt_isinf(f) ? HUGE_VAL : f);
  78 }
  79
  80 static double f_noderiv(int n, const double *x, void *data_)
  81 {
  82      nlopt_opt data = (nlopt_opt) data_;
  83      return data->f((unsigned) n, x, NULL, data->f_data);
  84 }
  85
  86 static double f_direct(int n, const double *x, int *undefined, void *data_)
  87 {
  88      nlopt_opt data = (nlopt_opt) data_;
  89      double *work = (double*) data->work;
  90      double f;
  91      unsigned i, j;
  92      f = data->f((unsigned) n, x, NULL, data->f_data);
  93      *undefined = isnan(f) || nlopt_isinf(f);
  94      if (nlopt_get_force_stop(data)) return f;
  95      for (i = 0; i < data->m && !*undefined; ++i) {
  96           nlopt_eval_constraint(work, NULL, data->fc+i, (unsigned) n, x);
  97           if (nlopt_get_force_stop(data)) return f;
  98           for (j = 0; j < data->fc[i].m; ++j)
  99                if (work[j] > 0)
 100                     *undefined = 1;
 101      }
 102      return f;
 103 }
 104
 105 /*********************************************************************/
 106
 107 /* get min(dx) for algorithms requiring a scalar initial step size */
 108 static nlopt_result initial_step(nlopt_opt opt, const double *x, double *step)
 109 {
 110      unsigned freedx = 0, i;
 111
 112      if (!opt->dx) {
 113           freedx = 1;
 114           if (nlopt_set_default_initial_step(opt, x) != NLOPT_SUCCESS)
 115                return NLOPT_OUT_OF_MEMORY;
 116      }
 117
 118      *step = HUGE_VAL;
 119      for (i = 0; i < opt->n; ++i)
 120           if (*step > fabs(opt->dx[i]))
 121                *step = fabs(opt->dx[i]);
 122
 123      if (freedx) { free(opt->dx); opt->dx = NULL; }
 124      return NLOPT_SUCCESS;
 125 }
 126
 127 /*********************************************************************/
 128
 129 /* return true if [lb,ub] is finite in every dimension (n dimensions) */
 130 static int finite_domain(unsigned n, const double *lb, const double *ub)
 131 {
 132      unsigned i;
 133      for (i = 0; i < n; ++i)
 134           if (nlopt_isinf(ub[i] - lb[i])) return 0;
 135      return 1;
 136 }
 137
 138 /*********************************************************************/
 139 /* wrapper functions, only for derivative-free methods, that
 140    eliminate dimensions with lb == ub.   (The gradient-based methods
 141    should handle this case directly, since they operate on much
 142    larger vectors where I am loathe to make copies unnecessarily.) */
 143
 144 typedef struct {
 145      nlopt_func f;
 146      nlopt_mfunc mf;
 147      void *f_data;
 148      unsigned n; /* true dimension */
 149      double *x; /* scratch vector of length n */
 150      double *grad; /* optional scratch vector of length n */
 151      const double *lb, *ub; /* bounds, of length n */
 152 } elimdim_data;
 153
 154 static void *elimdim_makedata(nlopt_func f, nlopt_mfunc mf, void *f_data,
 155                               unsigned n, double *x, const double *lb,
 156                               const double *ub, double *grad)
 157 {
 158      elimdim_data *d = (elimdim_data *) malloc(sizeof(elimdim_data));
 159      if (!d) return NULL;
 160      d->f = f; d->mf = mf; d->f_data = f_data; d->n = n; d->x = x;
 161      d->lb = lb; d->ub = ub;
 162      d->grad = grad;
 163      return d;
 164 }
 165
 166 static double elimdim_func(unsigned n0, const double *x0, double *grad, void *d_)
 167 {
 168      elimdim_data *d = (elimdim_data *) d_;
 169      double *x = d->x;
 170      const double *lb = d->lb, *ub = d->ub;
 171      double val;
 172      unsigned n = d->n, i, j;
 173
 174      (void) n0; /* unused */
 175      for (i = j = 0; i < n; ++i) {
 176           if (lb[i] == ub[i])
 177                x[i] = lb[i];
 178           else /* assert: j < n0 */
 179                x[i] = x0[j++];
 180      }
 181      val = d->f(n, x, grad ? d->grad : NULL, d->f_data);
 182      if (grad) {
 183           /* assert: d->grad != NULL */
 184           for (i = j = 0; i < n; ++i)
 185                if (lb[i] != ub[i])
 186                     grad[j++] = d->grad[i];
 187      }
 188      return val;
 189 }
 190
 191
 192 static void elimdim_mfunc(unsigned m, double *result,
 193                           unsigned n0, const double *x0, double *grad, void *d_)
 194 {
 195      elimdim_data *d = (elimdim_data *) d_;
 196      double *x = d->x;
 197      const double *lb = d->lb, *ub = d->ub;
 198      unsigned n = d->n, i, j;
 199
 200      (void) n0; /* unused */
 201      (void) grad; /* assert: grad == NULL */
 202      for (i = j = 0; i < n; ++i) {
 203           if (lb[i] == ub[i])
 204                x[i] = lb[i];
 205           else /* assert: j < n0 */
 206                x[i] = x0[j++];
 207      }
 208      d->mf(m, result, n, x, NULL, d->f_data);
 209 }
 210
 211 /* compute the eliminated dimension: number of dims with lb[i] != ub[i] */
 212 static unsigned elimdim_dimension(unsigned n, const double *lb, const double *ub)
 213 {
 214      unsigned n0 = 0, i;
 215      for (i = 0; i < n; ++i) n0 += lb[i] != ub[i] ? 1U : 0;
 216      return n0;
 217 }
 218
 219 /* modify v to "shrunk" version, with dimensions for lb[i] == ub[i] elim'ed */
 220 static void elimdim_shrink(unsigned n, double *v,
 221                            const double *lb, const double *ub)
 222 {
 223      unsigned i, j;
 224      if (v)
 225           for (i = j = 0; i < n; ++i)
 226                if (lb[i] != ub[i])
 227                     v[j++] = v[i];
 228 }
 229
 230 /* inverse of elimdim_shrink */
 231 static void elimdim_expand(unsigned n, double *v,
 232                            const double *lb, const double *ub)
 233 {
 234      unsigned i, j;
 235      if (v && n > 0) {
 236           j = elimdim_dimension(n, lb, ub) - 1;
 237           for (i = n - 1; i > 0; --i) {
 238                if (lb[i] != ub[i])
 239                     v[i] = v[j--];
 240                else
 241                     v[i] = lb[i];
 242           }
 243           if (lb[0] == ub[0])
 244                v[0] = lb[0];
 245      }
 246 }
 247
 248 /* given opt, create a new opt with equal-constraint dimensions eliminated */
 249 static nlopt_opt elimdim_create(nlopt_opt opt)
 250 {
 251      nlopt_opt opt0 = nlopt_copy(opt);
 252      double *x, *grad = NULL;
 253      unsigned i;
 254
 255      if (!opt0) return NULL;
 256      x = (double *) malloc(sizeof(double) * opt->n);
 257      if (opt->n && !x) { nlopt_destroy(opt0); return NULL; }
 258
 259      if (opt->algorithm == NLOPT_GD_STOGO
 260          || opt->algorithm == NLOPT_GD_STOGO_RAND) {
 261           grad = (double *) malloc(sizeof(double) * opt->n);
 262           if (opt->n && !grad) goto bad;
 263      }
 264
 265      opt0->n = elimdim_dimension(opt->n, opt->lb, opt->ub);
 266      elimdim_shrink(opt->n, opt0->lb, opt->lb, opt->ub);
 267      elimdim_shrink(opt->n, opt0->ub, opt->lb, opt->ub);
 268      elimdim_shrink(opt->n, opt0->xtol_abs, opt->lb, opt->ub);
 269      elimdim_shrink(opt->n, opt0->dx, opt->lb, opt->ub);
 270
 271      opt0->munge_on_destroy = opt0->munge_on_copy = NULL;
 272
 273      opt0->f = elimdim_func;
 274      opt0->f_data = elimdim_makedata(opt->f, NULL, opt->f_data,
 275                                      opt->n, x, opt->lb, opt->ub, grad);
 276      if (!opt0->f_data) goto bad;
 277
 278      for (i = 0; i < opt->m; ++i) {
 279           opt0->fc[i].f = elimdim_func;
 280           opt0->fc[i].mf = elimdim_mfunc;
 281           opt0->fc[i].f_data = elimdim_makedata(opt->fc[i].f, opt->fc[i].mf,
 282                                                 opt->fc[i].f_data,
 283                                                 opt->n, x, opt->lb, opt->ub,
 284                                                 NULL);
 285           if (!opt0->fc[i].f_data) goto bad;
 286      }
 287
 288      for (i = 0; i < opt->p; ++i) {
 289           opt0->h[i].f = elimdim_func;
 290           opt0->h[i].mf = elimdim_mfunc;
 291           opt0->h[i].f_data = elimdim_makedata(opt->h[i].f, opt->h[i].mf,
 292                                                opt->h[i].f_data,
 293                                                opt->n, x, opt->lb, opt->ub,
 294                                                NULL);
 295           if (!opt0->h[i].f_data) goto bad;
 296      }
 297
 298      return opt0;
 299 bad:
 300      free(grad);
 301      free(x);
 302      nlopt_destroy(opt0);
 303      return NULL;
 304 }
 305
 306 /* like nlopt_destroy, but also frees elimdim_data */
 307 static void elimdim_destroy(nlopt_opt opt)
 308 {
 309      unsigned i;
 310      if (!opt) return;
 311
 312      free(((elimdim_data*) opt->f_data)->x);
 313      free(((elimdim_data*) opt->f_data)->grad);
 314      free(opt->f_data); opt->f_data = NULL;
 315
 316      for (i = 0; i < opt->m; ++i) {
 317           free(opt->fc[i].f_data);
 318           opt->fc[i].f_data = NULL;
 319      }
 320      for (i = 0; i < opt->p; ++i) {
 321           free(opt->h[i].f_data);
 322           opt->h[i].f_data = NULL;
 323      }
 324
 325      nlopt_destroy(opt);
 326 }
 327
 328 /* return whether to use elimdim wrapping. */
 329 static int elimdim_wrapcheck(nlopt_opt opt)
 330 {
 331      if (!opt) return 0;
 332      if (elimdim_dimension(opt->n, opt->lb, opt->ub) == opt->n) return 0;
 333      switch (opt->algorithm) {
 334          case NLOPT_GN_DIRECT:
 335          case NLOPT_GN_DIRECT_L:
 336          case NLOPT_GN_DIRECT_L_RAND:
 337          case NLOPT_GN_DIRECT_NOSCAL:
 338          case NLOPT_GN_DIRECT_L_NOSCAL:
 339          case NLOPT_GN_DIRECT_L_RAND_NOSCAL:
 340          case NLOPT_GN_ORIG_DIRECT:
 341          case NLOPT_GN_ORIG_DIRECT_L:
 342          case NLOPT_GN_CRS2_LM:
 343          case NLOPT_LN_PRAXIS:
 344          case NLOPT_LN_COBYLA:
 345          case NLOPT_LN_NEWUOA:
 346          case NLOPT_LN_NEWUOA_BOUND:
 347          case NLOPT_LN_BOBYQA:
 348          case NLOPT_LN_NELDERMEAD:
 349          case NLOPT_LN_SBPLX:
 350          case NLOPT_GN_ISRES:
 351          case NLOPT_GN_ESCH:
 352          case NLOPT_GD_STOGO:
 353          case NLOPT_GD_STOGO_RAND:
 354               return 1;
 355
 356          default: return 0;
 357      }
 358 }
 359
 360 /*********************************************************************/
 361
 362 #define POP(defaultpop) (opt->stochastic_population > 0 ?               \
 363                          opt->stochastic_population :                   \
 364                          (nlopt_stochastic_population > 0 ?             \
 365                           nlopt_stochastic_population : (defaultpop)))
 366
 367 /* unlike nlopt_optimize() below, only handles minimization case */
 368 static nlopt_result nlopt_optimize_(nlopt_opt opt, double *x, double *minf)
 369 {
 370      const double *lb, *ub;
 371      nlopt_algorithm algorithm;
 372      nlopt_func f; void *f_data;
 373      unsigned n, i;
 374      int ni;
 375      nlopt_stopping stop;
 376
 377      if (!opt || !x || !minf || !opt->f
 378          || opt->maximize) return NLOPT_INVALID_ARGS;
 379
 380      /* reset stopping flag */
 381      nlopt_set_force_stop(opt, 0);
 382      opt->force_stop_child = NULL;
 383
 384      /* copy a few params to local vars for convenience */
 385      n = opt->n;
 386      ni = (int) n; /* most of the subroutines take "int" arg */
 387      lb = opt->lb; ub = opt->ub;
 388      algorithm = opt->algorithm;
 389      f = opt->f; f_data = opt->f_data;
 390
 391      if (n == 0) { /* trivial case: no degrees of freedom */
 392           *minf = opt->f(n, x, NULL, opt->f_data);
 393           return NLOPT_SUCCESS;
 394      }
 395
 396      *minf = HUGE_VAL;
 397
 398      /* make sure rand generator is inited */
 399      nlopt_srand_time_default(); /* default is non-deterministic */
 400
 401      /* check bound constraints */
 402      for (i = 0; i < n; ++i)
 403           if (lb[i] > ub[i] || x[i] < lb[i] || x[i] > ub[i])
 404                return NLOPT_INVALID_ARGS;
 405
 406      stop.n = n;
 407      stop.minf_max = opt->stopval;
 408      stop.ftol_rel = opt->ftol_rel;
 409      stop.ftol_abs = opt->ftol_abs;
 410      stop.xtol_rel = opt->xtol_rel;
 411      stop.xtol_abs = opt->xtol_abs;
 412      stop.nevals = 0;
 413      stop.maxeval = opt->maxeval;
 414      stop.maxtime = opt->maxtime;
 415      stop.start = nlopt_seconds();
 416      stop.force_stop = &(opt->force_stop);
 417
 418      switch (algorithm) {
 419          case NLOPT_GN_DIRECT:
 420          case NLOPT_GN_DIRECT_L:
 421          case NLOPT_GN_DIRECT_L_RAND:
 422               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 423               return cdirect(ni, f, f_data,
 424                              lb, ub, x, minf, &stop, 0.0,
 425                              (algorithm != NLOPT_GN_DIRECT)
 426                              + 3 * (algorithm == NLOPT_GN_DIRECT_L_RAND
 427                                     ? 2 : (algorithm != NLOPT_GN_DIRECT))
 428                              + 9 * (algorithm == NLOPT_GN_DIRECT_L_RAND
 429                                     ? 1 : (algorithm != NLOPT_GN_DIRECT)));
 430
 431          case NLOPT_GN_DIRECT_NOSCAL:
 432          case NLOPT_GN_DIRECT_L_NOSCAL:
 433          case NLOPT_GN_DIRECT_L_RAND_NOSCAL:
 434               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 435               return cdirect_unscaled(ni, f, f_data, lb, ub, x, minf,
 436                                       &stop, 0.0,
 437                                       (algorithm != NLOPT_GN_DIRECT)
 438                                       + 3 * (algorithm == NLOPT_GN_DIRECT_L_RAND ? 2 : (algorithm != NLOPT_GN_DIRECT))
 439                                       + 9 * (algorithm == NLOPT_GN_DIRECT_L_RAND ? 1 : (algorithm != NLOPT_GN_DIRECT)));
 440
 441          case NLOPT_GN_ORIG_DIRECT:
 442          case NLOPT_GN_ORIG_DIRECT_L: {
 443               direct_return_code dret;
 444               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 445               opt->work = malloc(sizeof(double) *
 446                                  nlopt_max_constraint_dim(opt->m,
 447                                                           opt->fc));
 448               if (!opt->work) return NLOPT_OUT_OF_MEMORY;
 449               dret = direct_optimize(f_direct, opt, ni, lb, ub, x, minf,
 450                                      stop.maxeval, -1,
 451                                      stop.start, stop.maxtime,
 452                                      0.0, 0.0,
 453                                      pow(stop.xtol_rel, (double) n), -1.0,
 454                                      stop.force_stop,
 455                                      stop.minf_max, 0.0,
 456                                      NULL,
 457                                      algorithm == NLOPT_GN_ORIG_DIRECT
 458                                      ? DIRECT_ORIGINAL
 459                                      : DIRECT_GABLONSKY);
 460               free(opt->work); opt->work = NULL;
 461               switch (dret) {
 462                   case DIRECT_INVALID_BOUNDS:
 463                   case DIRECT_MAXFEVAL_TOOBIG:
 464                   case DIRECT_INVALID_ARGS:
 465                        return NLOPT_INVALID_ARGS;
 466                   case DIRECT_INIT_FAILED:
 467                   case DIRECT_SAMPLEPOINTS_FAILED:
 468                   case DIRECT_SAMPLE_FAILED:
 469                        return NLOPT_FAILURE;
 470                   case DIRECT_MAXFEVAL_EXCEEDED:
 471                   case DIRECT_MAXITER_EXCEEDED:
 472                        return NLOPT_MAXEVAL_REACHED;
 473                   case DIRECT_MAXTIME_EXCEEDED:
 474                        return NLOPT_MAXTIME_REACHED;
 475                   case DIRECT_GLOBAL_FOUND:
 476                        return NLOPT_MINF_MAX_REACHED;
 477                   case DIRECT_VOLTOL:
 478                   case DIRECT_SIGMATOL:
 479                        return NLOPT_XTOL_REACHED;
 480                   case DIRECT_OUT_OF_MEMORY:
 481                        return NLOPT_OUT_OF_MEMORY;
 482                   case DIRECT_FORCED_STOP:
 483                        return NLOPT_FORCED_STOP;
 484               }
 485               break;
 486          }
 487
 488          case NLOPT_GD_STOGO:
 489          case NLOPT_GD_STOGO_RAND:
 490 #ifdef WITH_CXX
 491               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 492               if (!stogo_minimize(ni, f, f_data, x, minf, lb, ub, &stop,
 493                                   algorithm == NLOPT_GD_STOGO
 494                                   ? 0 : (int) POP(2*n)))
 495                    return NLOPT_FAILURE;
 496               break;
 497 #else
 498               return NLOPT_INVALID_ARGS;
 499 #endif
 500
 501 #if 0
 502               /* lacking a free/open-source license, we no longer use
 503                  Rowan's code, and instead use by "sbplx" re-implementation */
 504          case NLOPT_LN_SUBPLEX: {
 505               int iret, freedx = 0;
 506               if (!opt->dx) {
 507                    freedx = 1;
 508                    if (nlopt_set_default_initial_step(opt, x) != NLOPT_SUCCESS)
 509                         return NLOPT_OUT_OF_MEMORY;
 510               }
 511               iret = nlopt_subplex(f_bound, minf, x, n, opt, &stop, opt->dx);
 512               if (freedx) { free(opt->dx); opt->dx = NULL; }
 513               switch (iret) {
 514                   case -2: return NLOPT_INVALID_ARGS;
 515                   case -20: return NLOPT_FORCED_STOP;
 516                   case -10: return NLOPT_MAXTIME_REACHED;
 517                   case -1: return NLOPT_MAXEVAL_REACHED;
 518                   case 0: return NLOPT_XTOL_REACHED;
 519                   case 1: return NLOPT_SUCCESS;
 520                   case 2: return NLOPT_MINF_MAX_REACHED;
 521                   case 20: return NLOPT_FTOL_REACHED;
 522                   case -200: return NLOPT_OUT_OF_MEMORY;
 523                   default: return NLOPT_FAILURE; /* unknown return code */
 524               }
 525               break;
 526          }
 527 #endif
 528
 529          case NLOPT_LN_PRAXIS: {
 530               double step;
 531               if (initial_step(opt, x, &step) != NLOPT_SUCCESS)
 532                    return NLOPT_OUT_OF_MEMORY;
 533               return praxis_(0.0, DBL_EPSILON,
 534                              step, ni, x, f_bound, opt, &stop, minf);
 535          }
 536
 537          case NLOPT_LD_LBFGS:
 538               return luksan_plis(ni, f, f_data, lb, ub, x, minf,
 539                                  &stop, opt->vector_storage);
 540
 541          case NLOPT_LD_VAR1:
 542          case NLOPT_LD_VAR2:
 543               return luksan_plip(ni, f, f_data, lb, ub, x, minf,
 544                                  &stop, opt->vector_storage,
 545                                  algorithm == NLOPT_LD_VAR1 ? 1 : 2);
 546
 547          case NLOPT_LD_TNEWTON:
 548          case NLOPT_LD_TNEWTON_RESTART:
 549          case NLOPT_LD_TNEWTON_PRECOND:
 550          case NLOPT_LD_TNEWTON_PRECOND_RESTART:
 551               return luksan_pnet(ni, f, f_data, lb, ub, x, minf,
 552                                  &stop, opt->vector_storage,
 553                                  1 + (algorithm - NLOPT_LD_TNEWTON) % 2,
 554                                  1 + (algorithm - NLOPT_LD_TNEWTON) / 2);
 555
 556          case NLOPT_GN_CRS2_LM:
 557               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 558               return crs_minimize(ni, f, f_data, lb, ub, x, minf, &stop,
 559                                   (int) POP(0), 0);
 560
 561          case NLOPT_G_MLSL:
 562          case NLOPT_G_MLSL_LDS:
 563          case NLOPT_GN_MLSL:
 564          case NLOPT_GD_MLSL:
 565          case NLOPT_GN_MLSL_LDS:
 566          case NLOPT_GD_MLSL_LDS: {
 567               nlopt_opt local_opt = opt->local_opt;
 568               nlopt_result ret;
 569               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 570               if (!local_opt && (algorithm == NLOPT_G_MLSL
 571                                  || algorithm == NLOPT_G_MLSL_LDS))
 572                    return NLOPT_INVALID_ARGS;
 573               if (!local_opt) { /* default */
 574                    nlopt_algorithm local_alg = (algorithm == NLOPT_GN_MLSL ||
 575                                                 algorithm == NLOPT_GN_MLSL_LDS)
 576                         ? nlopt_local_search_alg_nonderiv
 577                         : nlopt_local_search_alg_deriv;
 578                    /* don't call MLSL recursively! */
 579                    if (local_alg >= NLOPT_GN_MLSL
 580                        && local_alg <= NLOPT_GD_MLSL_LDS)
 581                         local_alg = (algorithm == NLOPT_GN_MLSL ||
 582                                      algorithm == NLOPT_GN_MLSL_LDS)
 583                              ? NLOPT_LN_COBYLA : NLOPT_LD_MMA;
 584                    local_opt = nlopt_create(local_alg, n);
 585                    if (!local_opt) return NLOPT_FAILURE;
 586                    nlopt_set_ftol_rel(local_opt, opt->ftol_rel);
 587                    nlopt_set_ftol_abs(local_opt, opt->ftol_abs);
 588                    nlopt_set_xtol_rel(local_opt, opt->xtol_rel);
 589                    nlopt_set_xtol_abs(local_opt, opt->xtol_abs);
 590                    nlopt_set_maxeval(local_opt, nlopt_local_search_maxeval);
 591               }
 592               if (opt->dx) nlopt_set_initial_step(local_opt, opt->dx);
 593               for (i = 0; i < n && stop.xtol_abs[i] > 0; ++i) ;
 594               if (local_opt->ftol_rel <= 0 && local_opt->ftol_abs <= 0 &&
 595                   local_opt->xtol_rel <= 0 && i < n) {
 596                    /* it is not sensible to call MLSL without *some*
 597                       nonzero tolerance for the local search */
 598                    nlopt_set_ftol_rel(local_opt, 1e-15);
 599                    nlopt_set_xtol_rel(local_opt, 1e-7);
 600               }
 601               opt->force_stop_child = local_opt;
 602               ret = mlsl_minimize(ni, f, f_data, lb, ub, x, minf, &stop,
 603                                   local_opt, (int) POP(0),
 604                                   algorithm >= NLOPT_GN_MLSL_LDS &&
 605                                   algorithm != NLOPT_G_MLSL);
 606               opt->force_stop_child = NULL;
 607               if (!opt->local_opt) nlopt_destroy(local_opt);
 608               return ret;
 609          }
 610
 611          case NLOPT_LD_MMA: case NLOPT_LD_CCSAQ: {
 612               nlopt_opt dual_opt;
 613               nlopt_result ret;
 614 #define LO(param, def) (opt->local_opt ? opt->local_opt->param : (def))
 615               dual_opt = nlopt_create(LO(algorithm,
 616                                          nlopt_local_search_alg_deriv),
 617                                       nlopt_count_constraints(opt->m,
 618                                                               opt->fc));
 619               if (!dual_opt) return NLOPT_FAILURE;
 620               nlopt_set_ftol_rel(dual_opt, LO(ftol_rel, 1e-14));
 621               nlopt_set_ftol_abs(dual_opt, LO(ftol_abs, 0.0));
 622               nlopt_set_maxeval(dual_opt, LO(maxeval, 100000));
 623 #undef LO
 624
 625               if (algorithm == NLOPT_LD_MMA)
 626                    ret = mma_minimize(n, f, f_data, opt->m, opt->fc,
 627                                       lb, ub, x, minf, &stop, dual_opt);
 628               else
 629                    ret = ccsa_quadratic_minimize(
 630                         n, f, f_data, opt->m, opt->fc, opt->pre,
 631                         lb, ub, x, minf, &stop, dual_opt);
 632               nlopt_destroy(dual_opt);
 633               return ret;
 634          }
 635
 636          case NLOPT_LN_COBYLA: {
 637               nlopt_result ret;
 638               int freedx = 0;
 639               if (!opt->dx) {
 640                    freedx = 1;
 641                    if (nlopt_set_default_initial_step(opt, x) != NLOPT_SUCCESS)
 642                         return NLOPT_OUT_OF_MEMORY;
 643               }
 644               return cobyla_minimize(n, f, f_data,
 645                                      opt->m, opt->fc,
 646                                      opt->p, opt->h,
 647                                      lb, ub, x, minf, &stop,
 648                                      opt->dx);
 649               if (freedx) { free(opt->dx); opt->dx = NULL; }
 650               return ret;
 651          }
 652
 653          case NLOPT_LN_NEWUOA: {
 654               double step;
 655               if (initial_step(opt, x, &step) != NLOPT_SUCCESS)
 656                    return NLOPT_OUT_OF_MEMORY;
 657               return newuoa(ni, 2*n+1, x, 0, 0, step,
 658                             &stop, minf, f_noderiv, opt);
 659          }
 660
 661          case NLOPT_LN_NEWUOA_BOUND: {
 662               double step;
 663               if (initial_step(opt, x, &step) != NLOPT_SUCCESS)
 664                    return NLOPT_OUT_OF_MEMORY;
 665               return newuoa(ni, 2*n+1, x, lb, ub, step,
 666                             &stop, minf, f_noderiv, opt);
 667          }
 668
 669          case NLOPT_LN_BOBYQA: {
 670               nlopt_result ret;
 671               int freedx = 0;
 672               if (!opt->dx) {
 673                    freedx = 1;
 674                    if (nlopt_set_default_initial_step(opt, x) != NLOPT_SUCCESS)
 675                         return NLOPT_OUT_OF_MEMORY;
 676               }
 677               ret = bobyqa(ni, 2*n+1, x, lb, ub, opt->dx,
 678                            &stop, minf, opt->f, opt->f_data);
 679               if (freedx) { free(opt->dx); opt->dx = NULL; }
 680               return ret;
 681          }
 682
 683          case NLOPT_LN_NELDERMEAD:
 684          case NLOPT_LN_SBPLX:
 685          {
 686               nlopt_result ret;
 687               int freedx = 0;
 688               if (!opt->dx) {
 689                    freedx = 1;
 690                    if (nlopt_set_default_initial_step(opt, x) != NLOPT_SUCCESS)
 691                         return NLOPT_OUT_OF_MEMORY;
 692               }
 693               if (algorithm == NLOPT_LN_NELDERMEAD)
 694                    ret= nldrmd_minimize(ni,f,f_data,lb,ub,x,minf,opt->dx,&stop);
 695               else
 696                    ret= sbplx_minimize(ni,f,f_data,lb,ub,x,minf,opt->dx,&stop);
 697               if (freedx) { free(opt->dx); opt->dx = NULL; }
 698               return ret;
 699          }
 700
 701          case NLOPT_AUGLAG:
 702          case NLOPT_AUGLAG_EQ:
 703          case NLOPT_LN_AUGLAG:
 704          case NLOPT_LN_AUGLAG_EQ:
 705          case NLOPT_LD_AUGLAG:
 706          case NLOPT_LD_AUGLAG_EQ: {
 707               nlopt_opt local_opt = opt->local_opt;
 708               nlopt_result ret;
 709               if ((algorithm == NLOPT_AUGLAG || algorithm == NLOPT_AUGLAG_EQ)
 710                   && !local_opt)
 711                    return NLOPT_INVALID_ARGS;
 712               if (!local_opt) { /* default */
 713                    local_opt = nlopt_create(
 714                         algorithm == NLOPT_LN_AUGLAG ||
 715                         algorithm == NLOPT_LN_AUGLAG_EQ
 716                         ? nlopt_local_search_alg_nonderiv
 717                         : nlopt_local_search_alg_deriv, n);
 718                    if (!local_opt) return NLOPT_FAILURE;
 719                    nlopt_set_ftol_rel(local_opt, opt->ftol_rel);
 720                    nlopt_set_ftol_abs(local_opt, opt->ftol_abs);
 721                    nlopt_set_xtol_rel(local_opt, opt->xtol_rel);
 722                    nlopt_set_xtol_abs(local_opt, opt->xtol_abs);
 723                    nlopt_set_maxeval(local_opt, nlopt_local_search_maxeval);
 724               }
 725               if (opt->dx) nlopt_set_initial_step(local_opt, opt->dx);
 726               opt->force_stop_child = local_opt;
 727               ret = auglag_minimize(ni, f, f_data,
 728                                     opt->m, opt->fc,
 729                                     opt->p, opt->h,
 730                                     lb, ub, x, minf, &stop,
 731                                     local_opt,
 732                                     algorithm == NLOPT_AUGLAG_EQ
 733                                     || algorithm == NLOPT_LN_AUGLAG_EQ
 734                                     || algorithm == NLOPT_LD_AUGLAG_EQ);
 735               opt->force_stop_child = NULL;
 736               if (!opt->local_opt) nlopt_destroy(local_opt);
 737               return ret;
 738          }
 739
 740          case NLOPT_GN_ISRES:
 741               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 742               return isres_minimize(ni, f, f_data,
 743                                     (int) (opt->m), opt->fc,
 744                                     (int) (opt->p), opt->h,
 745                                     lb, ub, x, minf, &stop,
 746                                     (int) POP(0));
 747
 748         case NLOPT_GN_ESCH:
 749               if (!finite_domain(n, lb, ub)) return NLOPT_INVALID_ARGS;
 750               return chevolutionarystrategy(n, f, f_data,
 751                                             lb, ub, x, minf, &stop,
 752                                             (unsigned) POP(0),
 753                                             (unsigned) (POP(0)*1.5));
 754
 755          case NLOPT_LD_SLSQP:
 756               return nlopt_slsqp(n, f, f_data,
 757                                  opt->m, opt->fc,
 758                                  opt->p, opt->h,
 759                                  lb, ub, x, minf, &stop);
 760
 761          default:
 762               return NLOPT_INVALID_ARGS;
 763      }
 764
 765      return NLOPT_SUCCESS; /* never reached */
 766 }
 767
 768 /*********************************************************************/
 769
 770 typedef struct {
 771      nlopt_func f;
 772      nlopt_precond pre;
 773      void *f_data;
 774 } f_max_data;
 775
 776 /* wrapper for maximizing: just flip the sign of f and grad */
 777 static double f_max(unsigned n, const double *x, double *grad, void *data)
 778 {
 779      f_max_data *d = (f_max_data *) data;
 780      double val = d->f(n, x, grad, d->f_data);
 781      if (grad) {
 782           unsigned i;
 783           for (i = 0; i < n; ++i)
 784                grad[i] = -grad[i];
 785      }
 786      return -val;
 787 }
 788
 789 static void pre_max(unsigned n, const double *x, const double *v,
 790                     double *vpre, void *data)
 791 {
 792      f_max_data *d = (f_max_data *) data;
 793      unsigned i;
 794      d->pre(n, x, v, vpre, d->f_data);
 795      for (i = 0; i < n; ++i) vpre[i] = -vpre[i];
 796 }
 797
 798 nlopt_result
 799 NLOPT_STDCALL nlopt_optimize(nlopt_opt opt, double *x, double *opt_f)
 800 {
 801      nlopt_func f; void *f_data; nlopt_precond pre;
 802      f_max_data fmd;
 803      int maximize;
 804      nlopt_result ret;
 805
 806      if (!opt || !opt_f || !opt->f) return NLOPT_INVALID_ARGS;
 807      f = opt->f; f_data = opt->f_data; pre = opt->pre;
 808
 809      /* for maximizing, just minimize the f_max wrapper, which
 810         flips the sign of everything */
 811      if ((maximize = opt->maximize)) {
 812           fmd.f = f; fmd.f_data = f_data; fmd.pre = pre;
 813           opt->f = f_max; opt->f_data = &fmd;
 814           if (opt->pre) opt->pre = pre_max;
 815           opt->stopval = -opt->stopval;
 816           opt->maximize = 0;
 817      }
 818
 819      { /* possibly eliminate lb == ub dimensions for some algorithms */
 820           nlopt_opt elim_opt = opt;
 821           if (elimdim_wrapcheck(opt)) {
 822                elim_opt = elimdim_create(opt);
 823                if (!elim_opt) { ret = NLOPT_OUT_OF_MEMORY; goto done; }
 824                elimdim_shrink(opt->n, x, opt->lb, opt->ub);
 825           }
 826
 827           ret = nlopt_optimize_(elim_opt, x, opt_f);
 828
 829           if (elim_opt != opt) {
 830                elimdim_destroy(elim_opt);
 831                elimdim_expand(opt->n, x, opt->lb, opt->ub);
 832           }
 833      }
 834
 835 done:
 836      if (maximize) { /* restore original signs */
 837           opt->maximize = maximize;
 838           opt->stopval = -opt->stopval;
 839           opt->f = f; opt->f_data = f_data; opt->pre = pre;
 840           *opt_f = -*opt_f;
 841      }
 842
 843      return ret;
 844 }
 845
 846 /*********************************************************************/
 847
 848 nlopt_result nlopt_optimize_limited(nlopt_opt opt, double *x, double *minf,
 849                                     int maxeval, double maxtime)
 850 {
 851      int save_maxeval;
 852      double save_maxtime;
 853      nlopt_result ret;
 854
 855      if (!opt) return NLOPT_INVALID_ARGS;
 856
 857      save_maxeval = nlopt_get_maxeval(opt);
 858      save_maxtime = nlopt_get_maxtime(opt);
 859
 860      /* override opt limits if maxeval and/or maxtime are more stringent */
 861      if (save_maxeval <= 0 || (maxeval > 0 && maxeval < save_maxeval))
 862           nlopt_set_maxeval(opt, maxeval);
 863      if (save_maxtime <= 0 || (maxtime > 0 && maxtime < save_maxtime))
 864           nlopt_set_maxtime(opt, maxtime);
 865
 866      ret = nlopt_optimize(opt, x, minf);
 867
 868      nlopt_set_maxeval(opt, save_maxeval);
 869      nlopt_set_maxtime(opt, save_maxtime);
 870
 871      return ret;
 872 }
 873
 874 /*********************************************************************/