test/testopt.c

   1 /* Copyright (c) 2007-2011 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 <stdio.h>
  25 #include <math.h>
  26 #include <string.h>
  27
  28 #include "nlopt_config.h"
  29
  30 #ifdef HAVE_UNISTD_H
  31 #  include <unistd.h>
  32 #endif
  33 #ifdef HAVE_GETOPT_H
  34 #  include <getopt.h>
  35 #else
  36 #  include "nlopt-getopt.h"
  37 #endif
  38
  39 #define USE_FEENABLEEXCEPT 0
  40 #if USE_FEENABLEEXCEPT
  41 #  include <fenv.h>
  42 extern "C" int feenableexcept (int EXCEPTS);
  43 #endif
  44
  45
  46 #include "nlopt.h"
  47 #include "nlopt-util.h"
  48 #include "testfuncs.h"
  49
  50 static nlopt_algorithm algorithm = NLOPT_GN_DIRECT_L;
  51 static double ftol_rel = 0, ftol_abs = 0, xtol_rel = 0, xtol_abs = 0, minf_max_delta = -HUGE_VAL;
  52 static int maxeval = 1000, iterations = 1, center_start = 0;
  53 static double maxtime = 0.0;
  54 static double xinit_tol = -1;
  55 static int force_constraints = 0;
  56 static int fix_bounds[100] = {0,0,0,0,0,0,0,0,0,0,
  57                               0,0,0,0,0,0,0,0,0,0,
  58                               0,0,0,0,0,0,0,0,0,0,
  59                               0,0,0,0,0,0,0,0,0,0,
  60                               0,0,0,0,0,0,0,0,0,0,
  61                               0,0,0,0,0,0,0,0,0,0,
  62                               0,0,0,0,0,0,0,0,0,0,
  63                               0,0,0,0,0,0,0,0,0,0,
  64                               0,0,0,0,0,0,0,0,0,0,
  65                               0,0,0,0,0,0,0,0,0,0};
  66
  67 static void listalgs(FILE *f)
  68 {
  69   int i;
  70   fprintf(f, "Available algorithms:\n");
  71   for (i = 0; i < NLOPT_NUM_ALGORITHMS; ++i)
  72     fprintf(f, "  %2d: %s\n", i, nlopt_algorithm_name((nlopt_algorithm) i));
  73 }
  74
  75 static void listfuncs(FILE *f)
  76 {
  77   int i;
  78   fprintf(f, "Available objective functions:\n");
  79   for (i = 0; i < NTESTFUNCS; ++i)
  80     fprintf(f, "  %2d: %s (%d dims)\n", i, testfuncs[i].name, testfuncs[i].n);
  81 }
  82
  83 typedef struct {
  84   const double *lb, *ub;
  85   nlopt_func f;
  86   void *f_data;
  87 } bounds_wrap_data;
  88
  89 static double bounds_wrap_func(int n, const double *x, double *grad, void *d_)
  90 {
  91   bounds_wrap_data *d = (bounds_wrap_data *) d_;
  92   int i;
  93   double b = 0;
  94   for (i = 0; i < n; ++i) {
  95     if (x[i] < d->lb[i]) {
  96       b = d->lb[i];
  97       break;
  98     }
  99     else if (x[i] > d->ub[i]) {
 100       b = d->ub[i];
 101       break;
 102     }
 103   }
 104   if (i < n)
 105     fprintf(stderr, "WARNING: bounds violated by x[%d] = %g = %g + %g\n",
 106             i, x[i], b, x[i] - b);
 107   return d->f(n, x, grad, d->f_data);
 108 }
 109
 110 static int test_function(int ifunc)
 111 {
 112   testfunc func;
 113   int i, iter;
 114   double *x, minf, minf_max, f0, *xtabs, *lb, *ub;
 115   nlopt_result ret;
 116   double start = nlopt_seconds();
 117   int total_count = 0, max_count = 0, min_count = 1<<30;
 118   double total_err = 0, max_err = 0;
 119   bounds_wrap_data bw;
 120
 121   if (ifunc < 0 || ifunc >= NTESTFUNCS) {
 122     fprintf(stderr, "testopt: invalid function %d\n", ifunc);
 123     listfuncs(stderr);
 124     return 0;
 125   }
 126   func = testfuncs[ifunc];
 127   x = (double *) malloc(sizeof(double) * func.n * 5);
 128   if (!x) { fprintf(stderr, "testopt: Out of memory!\n"); return 0; }
 129
 130   lb = x + func.n * 3;
 131   ub = lb + func.n;
 132   xtabs = x + func.n * 2;
 133   bw.lb = lb;
 134   bw.ub = ub;
 135   bw.f = func.f;
 136   bw.f_data = func.f_data;
 137
 138   for (i = 0; i < func.n; ++i) xtabs[i] = xtol_abs;
 139   minf_max = minf_max_delta > (-HUGE_VAL) ? minf_max_delta + func.minf : (-HUGE_VAL);
 140
 141   printf("-----------------------------------------------------------\n");
 142   printf("Optimizing %s (%d dims) using %s algorithm\n",
 143          func.name, func.n, nlopt_algorithm_name(algorithm));
 144   printf("lower bounds at lb = [");
 145   for (i = 0; i < func.n; ++i) printf(" %g", func.lb[i]);
 146   printf("]\n");
 147   printf("upper bounds at ub = [");
 148   for (i = 0; i < func.n; ++i) printf(" %g", func.ub[i]);
 149   printf("]\n");
 150   memcpy(lb, func.lb, func.n * sizeof(double));
 151   memcpy(ub, func.ub, func.n * sizeof(double));
 152   for (i = 0; i < func.n; ++i) if (fix_bounds[i]) {
 153       printf("fixing bounds for dim[%d] to xmin[%d]=%g\n",
 154              i, i, func.xmin[i]);
 155       lb[i] = ub[i] = func.xmin[i];
 156   }
 157   if (force_constraints) {
 158     for (i = 0; i < func.n; ++i) {
 159       if (nlopt_iurand(2) == 0)
 160         ub[i] = nlopt_urand(lb[i], func.xmin[i]);
 161       else
 162         lb[i] = nlopt_urand(func.xmin[i], ub[i]);
 163     }
 164     printf("adjusted lower bounds at lb = [");
 165     for (i = 0; i < func.n; ++i) printf(" %g", lb[i]);
 166     printf("]\n");
 167     printf("adjusted upper bounds at ub = [");
 168     for (i = 0; i < func.n; ++i) printf(" %g", ub[i]);
 169     printf("]\n");
 170   }
 171
 172   if (fabs(func.f(func.n, func.xmin, 0, func.f_data) - func.minf) > 1e-8) {
 173     fprintf(stderr, "BUG: function does not achieve given lower bound!\n");
 174     fprintf(stderr, "f(%g", func.xmin[0]);
 175     for (i = 1; i < func.n; ++i) fprintf(stderr, ", %g", func.xmin[i]);
 176     fprintf(stderr, ") = %0.16g instead of %0.16g, |diff| = %g\n",
 177             func.f(func.n, func.xmin, 0, func.f_data), func.minf,
 178             fabs(func.f(func.n, func.xmin, 0, func.f_data) - func.minf));
 179     free(x);
 180     return 0;
 181   }
 182
 183   for (iter = 0; iter < iterations; ++iter) {
 184     double val;
 185     testfuncs_counter = 0;
 186
 187     printf("Starting guess x = [");
 188     for (i = 0; i < func.n; ++i) {
 189       if (center_start)
 190         x[i] = (ub[i] + lb[i]) * 0.5;
 191       else if (xinit_tol < 0) { /* random starting point near center of box */
 192         double dx = (ub[i] - lb[i]) * 0.25;
 193         double xm = 0.5 * (ub[i] + lb[i]);
 194         x[i] = nlopt_urand(xm - dx, xm + dx);
 195       }
 196       else {
 197         x[i] = nlopt_urand(-xinit_tol, xinit_tol)
 198           + (1 + nlopt_urand(-xinit_tol, xinit_tol)) * func.xmin[i];
 199         if (x[i] > ub[i]) x[i] = ub[i];
 200         else if (x[i] < lb[i]) x[i] = lb[i];
 201       }
 202       printf(" %g", x[i]);
 203     }
 204     printf("]\n");
 205     f0 = func.f(func.n, x, x + func.n, func.f_data);
 206     printf("Starting function value = %g\n", f0);
 207
 208     if (iter == 0 && testfuncs_verbose && func.has_gradient) {
 209       printf("checking gradient:\n");
 210       for (i = 0; i < func.n; ++i) {
 211         double f;
 212         x[i] *= 1 + 1e-6;
 213         f = func.f(func.n, x, NULL, func.f_data);
 214         x[i] /= 1 + 1e-6;
 215         printf("  grad[%d] = %g vs. numerical derivative %g\n",
 216                i, x[i + func.n], (f - f0) / (x[i] * 1e-6));
 217       }
 218     }
 219
 220     testfuncs_counter = 0;
 221     ret = nlopt_minimize(algorithm,
 222                          func.n, bounds_wrap_func, &bw,
 223                          lb, ub,
 224                          x, &minf,
 225                          minf_max, ftol_rel, ftol_abs, xtol_rel, xtabs,
 226                          maxeval, maxtime);
 227     printf("finished after %g seconds.\n", nlopt_seconds() - start);
 228     printf("return code %d from nlopt_minimize\n", ret);
 229     if (ret < 0 && ret != NLOPT_ROUNDOFF_LIMITED
 230         && ret != NLOPT_FORCED_STOP) {
 231       fprintf(stderr, "testopt: error in nlopt_minimize\n");
 232       free(x);
 233       return 0;
 234     }
 235     printf("Found minimum f = %g after %d evaluations.\n",
 236            minf, testfuncs_counter);
 237     total_count += testfuncs_counter;
 238     if (testfuncs_counter > max_count) max_count = testfuncs_counter;
 239     if (testfuncs_counter < min_count) min_count = testfuncs_counter;
 240     printf("Minimum at x = [");
 241     for (i = 0; i < func.n; ++i) printf(" %g", x[i]);
 242     printf("]\n");
 243     if (func.minf == 0)
 244       printf("|f - minf| = %g\n", fabs(minf - func.minf));
 245     else
 246       printf("|f - minf| = %g, |f - minf| / |minf| = %e\n",
 247              fabs(minf - func.minf), fabs(minf - func.minf) / fabs(func.minf));
 248     total_err += fabs(minf - func.minf);
 249     if (fabs(minf - func.minf) > max_err)
 250       max_err = fabs(minf - func.minf);
 251     printf("vs. global minimum f = %g at x = [", func.minf);
 252     for (i = 0; i < func.n; ++i) printf(" %g", func.xmin[i]);
 253     printf("]\n");
 254
 255     val = func.f(func.n, x, NULL, func.f_data);
 256     if (fabs(val - minf) > 1e-12) {
 257       fprintf(stderr, "Mismatch %g between returned minf=%g and f(x) = %g\n",
 258               minf - val, minf, val);
 259       free(x);
 260       return 0;
 261     }
 262   }
 263   if (iterations > 1)
 264     printf("average #evaluations = %g (%d-%d)\naverage |f-minf| = %g, max |f-minf| = %g\n", total_count * 1.0 / iterations, min_count, max_count, total_err / iterations, max_err);
 265
 266   free(x);
 267   return 1;
 268 }
 269
 270 static void usage(FILE *f)
 271 {
 272   fprintf(f, "Usage: testopt [OPTIONS]\n"
 273           "Options:\n"
 274           "     -h : print this help\n"
 275           "     -L : list available algorithms and objective functions\n"
 276           "     -v : verbose mode\n"
 277           " -a <n> : use optimization algorithm <n>\n"
 278           " -o <n> : use objective function <n>\n"
 279           " -0 <x> : starting guess within <x> + (1+<x>) * optimum\n"
 280           " -b <dim0,dim1,...>: eliminate given dims by equating bounds\n"
 281           "     -c : starting guess at center of cell\n"
 282           "     -C : put optimum outside of bound constraints\n"
 283           " -e <n> : use at most <n> evals (default: %d, 0 to disable)\n"
 284           " -t <t> : use at most <t> seconds (default: disabled)\n"
 285           " -x <t> : relative tolerance <t> on x (default: disabled)\n"
 286           " -X <t> : absolute tolerance <t> on x (default: disabled)\n"
 287           " -f <t> : relative tolerance <t> on f (default: disabled)\n"
 288           " -F <t> : absolute tolerance <t> on f (default: disabled)\n"
 289           " -m <m> : stop when minf+<m> is reached (default: disabled)\n"
 290           " -i <n> : iterate optimization <n> times (default: 1)\n"
 291           " -r <s> : use random seed <s> for starting guesses\n"
 292           , maxeval);
 293 }
 294
 295 int main(int argc, char **argv)
 296 {
 297   int c;
 298
 299   nlopt_srand_time();
 300   testfuncs_verbose = 0;
 301
 302   if (argc <= 1)
 303     usage(stdout);
 304
 305 #if USE_FEENABLEEXCEPT
 306   feenableexcept(FE_INVALID);
 307 #endif
 308
 309   while ((c = getopt(argc, argv, "hLvCc0:r:a:o:i:e:t:x:X:f:F:m:b:")) != -1)
 310     switch (c) {
 311     case 'h':
 312       usage(stdout);
 313       return EXIT_SUCCESS;
 314     case 'L':
 315       listalgs(stdout);
 316       listfuncs(stdout);
 317       return EXIT_SUCCESS;
 318     case 'v':
 319       testfuncs_verbose = 1;
 320       break;
 321     case 'C':
 322       force_constraints = 1;
 323       break;
 324     case 'r':
 325       nlopt_srand((unsigned long) atoi(optarg));
 326       break;
 327     case 'a':
 328       c = atoi(optarg);
 329       if (c < 0 || c >= NLOPT_NUM_ALGORITHMS) {
 330         fprintf(stderr, "testopt: invalid algorithm %d\n", c);
 331         listalgs(stderr);
 332         return EXIT_FAILURE;
 333       }
 334       algorithm = (nlopt_algorithm) c;
 335       break;
 336     case 'o':
 337       if (!test_function(atoi(optarg)))
 338         return EXIT_FAILURE;
 339       break;
 340     case 'e':
 341       maxeval = atoi(optarg);
 342       break;
 343     case 'i':
 344       iterations = atoi(optarg);
 345       break;
 346     case 't':
 347       maxtime = atof(optarg);
 348       break;
 349     case 'x':
 350       xtol_rel = atof(optarg);
 351       break;
 352     case 'X':
 353       xtol_abs = atof(optarg);
 354       break;
 355     case 'f':
 356       ftol_rel = atof(optarg);
 357       break;
 358     case 'F':
 359       ftol_abs = atof(optarg);
 360       break;
 361     case 'm':
 362       minf_max_delta = atof(optarg);
 363       break;
 364     case 'c':
 365       center_start = 1;
 366       break;
 367     case '0':
 368       center_start = 0;
 369       xinit_tol = atof(optarg);
 370       break;
 371     case 'b': {
 372       const char *s = optarg;
 373       while (s && *s) {
 374         int b = atoi(s);
 375         if (b < 0 || b >= 100) {
 376           fprintf(stderr, "invalid -b argument");
 377           return EXIT_FAILURE;
 378         }
 379         fix_bounds[b] = 1;
 380         s = strchr(s, ','); if (s) ++s;
 381       }
 382       break;
 383     }
 384     default:
 385       fprintf(stderr, "harminv: invalid argument -%c\n", c);
 386       usage(stderr);
 387       return EXIT_FAILURE;
 388     }
 389
 390   return EXIT_SUCCESS;
 391 }