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