api/nlopt.h

   1 /* Copyright (c) 2007-2008 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 */
  27
  28 #ifdef __cplusplus
  29 extern "C"
  30 {
  31 #endif /* __cplusplus */
  32
  33 typedef double (*nlopt_func)(int n, const double *x,
  34                              double *gradient, /* NULL if not needed */
  35                              void *func_data);
  36
  37 typedef enum {
  38      /* Naming conventions:
  39
  40         NLOPT_{G/L}{D/N}_*
  41             = global/local derivative/no-derivative optimization,
  42               respectively
  43
  44         *_RAND algorithms involve some randomization.
  45
  46         *_NOSCAL algorithms are *not* scaled to a unit hypercube
  47                  (i.e. they are sensitive to the units of x)
  48         */
  49
  50      NLOPT_GN_DIRECT = 0,
  51      NLOPT_GN_DIRECT_L,
  52      NLOPT_GN_DIRECT_L_RAND,
  53      NLOPT_GN_DIRECT_NOSCAL,
  54      NLOPT_GN_DIRECT_L_NOSCAL,
  55      NLOPT_GN_DIRECT_L_RAND_NOSCAL,
  56
  57      NLOPT_GN_ORIG_DIRECT,
  58      NLOPT_GN_ORIG_DIRECT_L,
  59
  60      NLOPT_LN_SUBPLEX,
  61
  62      NLOPT_GD_STOGO,
  63      NLOPT_GD_STOGO_RAND,
  64
  65      NLOPT_LD_LBFGS_NOCEDAL,
  66
  67      NLOPT_LD_LBFGS,
  68
  69      NLOPT_LN_PRAXIS,
  70
  71      NLOPT_LD_VAR1,
  72      NLOPT_LD_VAR2,
  73
  74      NLOPT_LD_TNEWTON,
  75      NLOPT_LD_TNEWTON_RESTART,
  76      NLOPT_LD_TNEWTON_PRECOND,
  77      NLOPT_LD_TNEWTON_PRECOND_RESTART,
  78
  79      NLOPT_GN_CRS2_LM,
  80
  81      NLOPT_GN_MLSL,
  82      NLOPT_GD_MLSL,
  83      NLOPT_GN_MLSL_LDS,
  84      NLOPT_GD_MLSL_LDS,
  85
  86      NLOPT_LD_MMA,
  87
  88      NLOPT_LN_COBYLA,
  89
  90      NLOPT_LN_NEWUOA,
  91      NLOPT_LN_NEWUOA_BOUND,
  92
  93      NLOPT_NUM_ALGORITHMS /* not an algorithm, just the number of them */
  94 } nlopt_algorithm;
  95
  96 extern const char *nlopt_algorithm_name(nlopt_algorithm a);
  97
  98 typedef enum {
  99      NLOPT_FAILURE = -1, /* generic failure code */
 100      NLOPT_INVALID_ARGS = -2,
 101      NLOPT_OUT_OF_MEMORY = -3,
 102
 103      NLOPT_SUCCESS = 1, /* generic success code */
 104      NLOPT_MINF_MAX_REACHED = 2,
 105      NLOPT_FTOL_REACHED = 3,
 106      NLOPT_XTOL_REACHED = 4,
 107      NLOPT_MAXEVAL_REACHED = 5,
 108      NLOPT_MAXTIME_REACHED = 6
 109 } nlopt_result;
 110
 111 extern nlopt_result nlopt_minimize(
 112      nlopt_algorithm algorithm,
 113      int n, nlopt_func f, void *f_data,
 114      const double *lb, const double *ub, /* bounds */
 115      double *x, /* in: initial guess, out: minimizer */
 116      double *minf, /* out: minimum */
 117      double minf_max, double ftol_rel, double ftol_abs,
 118      double xtol_rel, const double *xtol_abs,
 119      int maxeval, double maxtime);
 120
 121 extern nlopt_result nlopt_minimize_constrained(
 122      nlopt_algorithm algorithm,
 123      int n, nlopt_func f, void *f_data,
 124      int m, nlopt_func fc, void *fc_data, ptrdiff_t fc_datum_size,
 125      const double *lb, const double *ub, /* bounds */
 126      double *x, /* in: initial guess, out: minimizer */
 127      double *minf, /* out: minimum */
 128      double minf_max, double ftol_rel, double ftol_abs,
 129      double xtol_rel, const double *xtol_abs,
 130      int maxeval, double maxtime);
 131
 132 extern void nlopt_srand(unsigned long seed);
 133 extern void nlopt_srand_time(void);
 134
 135 extern void nlopt_version(int *major, int *minor, int *bugfix);
 136
 137 extern void nlopt_get_local_search_algorithm(nlopt_algorithm *deriv,
 138                                              nlopt_algorithm *nonderiv,
 139                                              int *maxeval);
 140 extern void nlopt_set_local_search_algorithm(nlopt_algorithm deriv,
 141                                              nlopt_algorithm nonderiv,
 142                                              int maxeval);
 143
 144 #ifdef __cplusplus
 145 }  /* extern "C" */
 146 #endif /* __cplusplus */
 147
 148 #endif