api/nlopt.h

   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 #ifndef NLOPT_H
  24 #define NLOPT_H
  25
  26 #include <stddef.h> /* for ptrdiff_t and size_t */
  27
  28 /* use stdcall convention under Windows, since this seems to
  29    be more standard there and is important for calling from .NET */
  30 #if defined(_WIN32) || defined(__WIN32__)
  31 #  if defined(__GNUC__)
  32 #    define NLOPT_STDCALL __attribute__((stdcall))
  33 #  elif defined(_MSC_VER) || defined(_ICC) || defined(_STDCALL_SUPPORTED)
  34 #    define NLOPT_STDCALL __stdcall
  35 #  else
  36 #    define NLOPT_STDCALL
  37 #  endif
  38 #else
  39 #  define NLOPT_STDCALL
  40 #endif
  41
  42 /* for Windows compilers, you should add a line
  43            #define NLOPT_DLL
  44    when using NLopt from a DLL, in order to do the proper
  45    Windows importing nonsense. */
  46 #if defined(NLOPT_DLL) && (defined(_WIN32) || defined(__WIN32__))
  47 /* annoying Windows syntax for calling functions in a DLL */
  48 #  define NLOPT_EXTERN(T) extern __declspec(dllimport) T NLOPT_STDCALL
  49 #else
  50 #  define NLOPT_EXTERN(T) extern T NLOPT_STDCALL
  51 #endif
  52
  53 #ifdef __cplusplus
  54 extern "C"
  55 {
  56 #endif /* __cplusplus */
  57
  58 typedef double (*nlopt_func)(unsigned n, const double *x,
  59                              double *gradient, /* NULL if not needed */
  60                              void *func_data);
  61
  62 typedef void (*nlopt_mfunc)(unsigned m, double *result,
  63                             unsigned n, const double *x,
  64                              double *gradient, /* NULL if not needed */
  65                              void *func_data);
  66
  67 typedef enum {
  68      /* Naming conventions:
  69
  70         NLOPT_{G/L}{D/N}_*
  71             = global/local derivative/no-derivative optimization,
  72               respectively
  73
  74         *_RAND algorithms involve some randomization.
  75
  76         *_NOSCAL algorithms are *not* scaled to a unit hypercube
  77                  (i.e. they are sensitive to the units of x)
  78         */
  79
  80      NLOPT_GN_DIRECT = 0,
  81      NLOPT_GN_DIRECT_L,
  82      NLOPT_GN_DIRECT_L_RAND,
  83      NLOPT_GN_DIRECT_NOSCAL,
  84      NLOPT_GN_DIRECT_L_NOSCAL,
  85      NLOPT_GN_DIRECT_L_RAND_NOSCAL,
  86
  87      NLOPT_GN_ORIG_DIRECT,
  88      NLOPT_GN_ORIG_DIRECT_L,
  89
  90      NLOPT_GD_STOGO,
  91      NLOPT_GD_STOGO_RAND,
  92
  93      NLOPT_LD_LBFGS_NOCEDAL,
  94
  95      NLOPT_LD_LBFGS,
  96
  97      NLOPT_LN_PRAXIS,
  98
  99      NLOPT_LD_VAR1,
 100      NLOPT_LD_VAR2,
 101
 102      NLOPT_LD_TNEWTON,
 103      NLOPT_LD_TNEWTON_RESTART,
 104      NLOPT_LD_TNEWTON_PRECOND,
 105      NLOPT_LD_TNEWTON_PRECOND_RESTART,
 106
 107      NLOPT_GN_CRS2_LM,
 108
 109      NLOPT_GN_MLSL,
 110      NLOPT_GD_MLSL,
 111      NLOPT_GN_MLSL_LDS,
 112      NLOPT_GD_MLSL_LDS,
 113
 114      NLOPT_LD_MMA,
 115
 116      NLOPT_LN_COBYLA,
 117
 118      NLOPT_LN_NEWUOA,
 119      NLOPT_LN_NEWUOA_BOUND,
 120
 121      NLOPT_LN_NELDERMEAD,
 122      NLOPT_LN_SBPLX,
 123
 124      NLOPT_LN_AUGLAG,
 125      NLOPT_LD_AUGLAG,
 126      NLOPT_LN_AUGLAG_EQ,
 127      NLOPT_LD_AUGLAG_EQ,
 128
 129      NLOPT_LN_BOBYQA,
 130
 131      NLOPT_GN_ISRES,
 132
 133      /* new variants that require local_optimizer to be set,
 134         not with older constants for backwards compatibility */
 135      NLOPT_AUGLAG,
 136      NLOPT_AUGLAG_EQ,
 137      NLOPT_G_MLSL,
 138      NLOPT_G_MLSL_LDS,
 139
 140      NLOPT_LD_SLSQP,
 141
 142      NLOPT_NUM_ALGORITHMS /* not an algorithm, just the number of them */
 143 } nlopt_algorithm;
 144
 145 extern const char *nlopt_algorithm_name(nlopt_algorithm a);
 146
 147 typedef enum {
 148      NLOPT_FAILURE = -1, /* generic failure code */
 149      NLOPT_INVALID_ARGS = -2,
 150      NLOPT_OUT_OF_MEMORY = -3,
 151      NLOPT_ROUNDOFF_LIMITED = -4,
 152      NLOPT_FORCED_STOP = -5,
 153      NLOPT_SUCCESS = 1, /* generic success code */
 154      NLOPT_STOPVAL_REACHED = 2,
 155      NLOPT_FTOL_REACHED = 3,
 156      NLOPT_XTOL_REACHED = 4,
 157      NLOPT_MAXEVAL_REACHED = 5,
 158      NLOPT_MAXTIME_REACHED = 6
 159 } nlopt_result;
 160
 161 #define NLOPT_MINF_MAX_REACHED NLOPT_STOPVAL_REACHED
 162
 163 NLOPT_EXTERN(void) nlopt_srand(unsigned long seed);
 164 NLOPT_EXTERN(void) nlopt_srand_time(void);
 165
 166 NLOPT_EXTERN(void) nlopt_version(int *major, int *minor, int *bugfix);
 167
 168 /*************************** OBJECT-ORIENTED API **************************/
 169 /* The style here is that we create an nlopt_opt "object" (an opaque pointer),
 170    then set various optimization parameters, and then execute the
 171    algorithm.  In this way, we can add more and more optimization parameters
 172    (including algorithm-specific ones) without breaking backwards
 173    compatibility, having functions with zillions of parameters, or
 174    relying non-reentrantly on global variables.*/
 175
 176 struct nlopt_opt_s; /* opaque structure, defined internally */
 177 typedef struct nlopt_opt_s *nlopt_opt;
 178
 179 /* the only immutable parameters of an optimization are the algorithm and
 180    the dimension n of the problem, since changing either of these could
 181    have side-effects on lots of other parameters */
 182 NLOPT_EXTERN(nlopt_opt) nlopt_create(nlopt_algorithm algorithm, unsigned n);
 183 NLOPT_EXTERN(void) nlopt_destroy(nlopt_opt opt);
 184 NLOPT_EXTERN(nlopt_opt) nlopt_copy(const nlopt_opt opt);
 185
 186 NLOPT_EXTERN(nlopt_result) nlopt_optimize(nlopt_opt opt, double *x,
 187                                          double *opt_f);
 188
 189 NLOPT_EXTERN(nlopt_result) nlopt_set_min_objective(nlopt_opt opt, nlopt_func f,
 190                                                   void *f_data);
 191 NLOPT_EXTERN(nlopt_result) nlopt_set_max_objective(nlopt_opt opt, nlopt_func f,
 192                                                   void *f_data);
 193
 194 NLOPT_EXTERN(nlopt_algorithm) nlopt_get_algorithm(const nlopt_opt opt);
 195 NLOPT_EXTERN(unsigned) nlopt_get_dimension(const nlopt_opt opt);
 196
 197 /* constraints: */
 198
 199 NLOPT_EXTERN(nlopt_result) nlopt_set_lower_bounds(nlopt_opt opt,
 200                                                  const double *lb);
 201 NLOPT_EXTERN(nlopt_result) nlopt_set_lower_bounds1(nlopt_opt opt, double lb);
 202 NLOPT_EXTERN(nlopt_result) nlopt_get_lower_bounds(const nlopt_opt opt,
 203                                                  double *lb);
 204 NLOPT_EXTERN(nlopt_result) nlopt_set_upper_bounds(nlopt_opt opt,
 205                                                  const double *ub);
 206 NLOPT_EXTERN(nlopt_result) nlopt_set_upper_bounds1(nlopt_opt opt, double ub);
 207 NLOPT_EXTERN(nlopt_result) nlopt_get_upper_bounds(const nlopt_opt opt,
 208                                                  double *ub);
 209
 210 NLOPT_EXTERN(nlopt_result) nlopt_remove_inequality_constraints(nlopt_opt opt);
 211 NLOPT_EXTERN(nlopt_result) nlopt_add_inequality_constraint(nlopt_opt opt,
 212                                                           nlopt_func fc,
 213                                                           void *fc_data,
 214                                                           double tol);
 215 NLOPT_EXTERN(nlopt_result) nlopt_add_inequality_mconstraint(nlopt_opt opt,
 216                                                             unsigned m,
 217                                                             nlopt_mfunc fc,
 218                                                             void *fc_data,
 219                                                             const double *tol);
 220
 221 NLOPT_EXTERN(nlopt_result) nlopt_remove_equality_constraints(nlopt_opt opt);
 222 NLOPT_EXTERN(nlopt_result) nlopt_add_equality_constraint(nlopt_opt opt,
 223                                                         nlopt_func h,
 224                                                         void *h_data,
 225                                                         double tol);
 226 NLOPT_EXTERN(nlopt_result) nlopt_add_equality_mconstraint(nlopt_opt opt,
 227                                                           unsigned m,
 228                                                           nlopt_mfunc h,
 229                                                           void *h_data,
 230                                                           const double *tol);
 231
 232 /* stopping criteria: */
 233
 234 NLOPT_EXTERN(nlopt_result) nlopt_set_stopval(nlopt_opt opt, double stopval);
 235 NLOPT_EXTERN(double) nlopt_get_stopval(const nlopt_opt opt);
 236
 237 NLOPT_EXTERN(nlopt_result) nlopt_set_ftol_rel(nlopt_opt opt, double tol);
 238 NLOPT_EXTERN(double) nlopt_get_ftol_rel(const nlopt_opt opt);
 239 NLOPT_EXTERN(nlopt_result) nlopt_set_ftol_abs(nlopt_opt opt, double tol);
 240 NLOPT_EXTERN(double) nlopt_get_ftol_abs(const nlopt_opt opt);
 241
 242 NLOPT_EXTERN(nlopt_result) nlopt_set_xtol_rel(nlopt_opt opt, double tol);
 243 NLOPT_EXTERN(double) nlopt_get_xtol_rel(const nlopt_opt opt);
 244 NLOPT_EXTERN(nlopt_result) nlopt_set_xtol_abs1(nlopt_opt opt, double tol);
 245 NLOPT_EXTERN(nlopt_result) nlopt_set_xtol_abs(nlopt_opt opt, const double *tol);
 246 NLOPT_EXTERN(nlopt_result) nlopt_get_xtol_abs(const nlopt_opt opt,
 247                                              double *tol);
 248
 249 NLOPT_EXTERN(nlopt_result) nlopt_set_maxeval(nlopt_opt opt, int maxeval);
 250 NLOPT_EXTERN(int) nlopt_get_maxeval(nlopt_opt opt);
 251
 252 NLOPT_EXTERN(nlopt_result) nlopt_set_maxtime(nlopt_opt opt, double maxtime);
 253 NLOPT_EXTERN(double) nlopt_get_maxtime(nlopt_opt opt);
 254
 255 NLOPT_EXTERN(nlopt_result) nlopt_force_stop(nlopt_opt opt);
 256 NLOPT_EXTERN(nlopt_result) nlopt_set_force_stop(nlopt_opt opt, int val);
 257 NLOPT_EXTERN(int) nlopt_get_force_stop(nlopt_opt opt);
 258
 259 /* more algorithm-specific parameters */
 260
 261 NLOPT_EXTERN(nlopt_result) nlopt_set_local_optimizer(nlopt_opt opt,
 262                                                     const nlopt_opt local_opt);
 263
 264 NLOPT_EXTERN(nlopt_result) nlopt_set_population(nlopt_opt opt, unsigned pop);
 265 NLOPT_EXTERN(unsigned) nlopt_get_population(const nlopt_opt opt);
 266
 267 NLOPT_EXTERN(nlopt_result) nlopt_set_default_initial_step(nlopt_opt opt,
 268                                                          const double *x);
 269 NLOPT_EXTERN(nlopt_result) nlopt_set_initial_step(nlopt_opt opt,
 270                                                  const double *dx);
 271 NLOPT_EXTERN(nlopt_result) nlopt_set_initial_step1(nlopt_opt opt, double dx);
 272 NLOPT_EXTERN(nlopt_result) nlopt_get_initial_step(const nlopt_opt opt,
 273                                                  const double *x, double *dx);
 274
 275 /* the following are functions mainly designed to be used internally
 276    by the Fortran and SWIG wrappers, allow us to tel nlopt_destroy and
 277    nlopt_copy to do something to the f_data pointers (e.g. free or
 278    duplicate them, respectively) */
 279 typedef void* (*nlopt_munge)(void *p);
 280 NLOPT_EXTERN(void) nlopt_set_munge(nlopt_opt opt,
 281                                   nlopt_munge munge_on_destroy,
 282                                   nlopt_munge munge_on_copy);
 283
 284 /*************************** DEPRECATED API **************************/
 285 /* The new "object-oriented" API is preferred, since it allows us to
 286    gracefully add new features and algorithm-specific options in a
 287    re-entrant way, and we can automatically assume reasonable defaults
 288    for unspecified parameters. */
 289
 290 /* Where possible (e.g. for gcc >= 3.1), enable a compiler warning
 291    for code that uses a deprecated function */
 292 #if defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__==3 && __GNUC_MINOR__ > 0))
 293 #  define NLOPT_DEPRECATED __attribute__((deprecated))
 294 #else
 295 #  define NLOPT_DEPRECATED
 296 #endif
 297
 298 typedef double (*nlopt_func_old)(int n, const double *x,
 299                                  double *gradient, /* NULL if not needed */
 300                                  void *func_data);
 301
 302 NLOPT_EXTERN(nlopt_result) nlopt_minimize(
 303      nlopt_algorithm algorithm,
 304      int n, nlopt_func_old f, void *f_data,
 305      const double *lb, const double *ub, /* bounds */
 306      double *x, /* in: initial guess, out: minimizer */
 307      double *minf, /* out: minimum */
 308      double minf_max, double ftol_rel, double ftol_abs,
 309      double xtol_rel, const double *xtol_abs,
 310      int maxeval, double maxtime) NLOPT_DEPRECATED;
 311
 312 NLOPT_EXTERN(nlopt_result) nlopt_minimize_constrained(
 313      nlopt_algorithm algorithm,
 314      int n, nlopt_func_old f, void *f_data,
 315      int m, nlopt_func_old fc, void *fc_data, ptrdiff_t fc_datum_size,
 316      const double *lb, const double *ub, /* bounds */
 317      double *x, /* in: initial guess, out: minimizer */
 318      double *minf, /* out: minimum */
 319      double minf_max, double ftol_rel, double ftol_abs,
 320      double xtol_rel, const double *xtol_abs,
 321      int maxeval, double maxtime) NLOPT_DEPRECATED;
 322
 323 NLOPT_EXTERN(nlopt_result) nlopt_minimize_econstrained(
 324      nlopt_algorithm algorithm,
 325      int n, nlopt_func_old f, void *f_data,
 326      int m, nlopt_func_old fc, void *fc_data, ptrdiff_t fc_datum_size,
 327      int p, nlopt_func_old h, void *h_data, ptrdiff_t h_datum_size,
 328      const double *lb, const double *ub, /* bounds */
 329      double *x, /* in: initial guess, out: minimizer */
 330      double *minf, /* out: minimum */
 331      double minf_max, double ftol_rel, double ftol_abs,
 332      double xtol_rel, const double *xtol_abs,
 333      double htol_rel, double htol_abs,
 334      int maxeval, double maxtime) NLOPT_DEPRECATED;
 335
 336 NLOPT_EXTERN(void) nlopt_get_local_search_algorithm(nlopt_algorithm *deriv,
 337                                              nlopt_algorithm *nonderiv,
 338                                              int *maxeval) NLOPT_DEPRECATED;
 339 NLOPT_EXTERN(void) nlopt_set_local_search_algorithm(nlopt_algorithm deriv,
 340                                              nlopt_algorithm nonderiv,
 341                                              int maxeval) NLOPT_DEPRECATED;
 342
 343 NLOPT_EXTERN(int) nlopt_get_stochastic_population(void) NLOPT_DEPRECATED;
 344 NLOPT_EXTERN(void) nlopt_set_stochastic_population(int pop) NLOPT_DEPRECATED;
 345
 346 /*********************************************************************/
 347
 348 #ifdef __cplusplus
 349 }  /* extern "C" */
 350 #endif /* __cplusplus */
 351
 352 #endif