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