api/nlopt.h

   1 #ifndef NLOPT_H
   2 #define NLOPT_H
   3
   4 #ifdef __cplusplus
   5 extern "C"
   6 {
   7 #endif /* __cplusplus */
   8
   9 typedef double (*nlopt_func)(int n, const double *x,
  10                              double *gradient, /* NULL if not needed */
  11                              void *func_data);
  12
  13 typedef enum {
  14      /* Naming conventions:
  15
  16         NLOPT_{G/L}{D/N}_*
  17             = global/local derivative/no-derivative optimization,
  18               respectively
  19
  20         *_RAND algorithms involve some randomization.
  21
  22         *_NOSCAL algorithms are *not* scaled to a unit hypercube
  23                  (i.e. they are sensitive to the units of x)
  24         */
  25
  26      NLOPT_GN_DIRECT = 0,
  27      NLOPT_GN_DIRECT_L,
  28      NLOPT_GN_DIRECT_L_RAND,
  29      NLOPT_GN_DIRECT_NOSCAL,
  30      NLOPT_GN_DIRECT_L_NOSCAL,
  31      NLOPT_GN_DIRECT_L_RAND_NOSCAL,
  32
  33      NLOPT_GN_ORIG_DIRECT,
  34      NLOPT_GN_ORIG_DIRECT_L,
  35
  36      NLOPT_LN_SUBPLEX,
  37
  38      NLOPT_GD_STOGO,
  39      NLOPT_GD_STOGO_RAND,
  40
  41      NLOPT_LD_LBFGS,
  42
  43      NLOPT_LN_PRAXIS,
  44
  45      NLOPT_LD_VAR1,
  46      NLOPT_LD_VAR2,
  47
  48      NLOPT_LD_TNEWTON,
  49      NLOPT_LD_TNEWTON_RESTART,
  50      NLOPT_LD_TNEWTON_PRECOND,
  51      NLOPT_LD_TNEWTON_PRECOND_RESTART,
  52
  53      NLOPT_NUM_ALGORITHMS /* not an algorithm, just the number of them */
  54 } nlopt_algorithm;
  55
  56 extern const char *nlopt_algorithm_name(nlopt_algorithm a);
  57
  58 typedef enum {
  59      NLOPT_FAILURE = -1, /* generic failure code */
  60      NLOPT_INVALID_ARGS = -2,
  61      NLOPT_OUT_OF_MEMORY = -3,
  62
  63      NLOPT_SUCCESS = 1, /* generic success code */
  64      NLOPT_MINF_MAX_REACHED = 2,
  65      NLOPT_FTOL_REACHED = 3,
  66      NLOPT_XTOL_REACHED = 4,
  67      NLOPT_MAXEVAL_REACHED = 5,
  68      NLOPT_MAXTIME_REACHED = 6
  69 } nlopt_result;
  70
  71 extern nlopt_result nlopt_minimize(
  72      nlopt_algorithm algorithm,
  73      int n, nlopt_func f, void *f_data,
  74      const double *lb, const double *ub, /* bounds */
  75      double *x, /* in: initial guess, out: minimizer */
  76      double *minf, /* out: minimum */
  77      double minf_max, double ftol_rel, double ftol_abs,
  78      double xtol_rel, const double *xtol_abs,
  79      int maxeval, double maxtime);
  80
  81 extern void nlopt_srand(unsigned long seed);
  82 extern void nlopt_srand_time(void);
  83
  84 extern void nlopt_version(int *major, int *minor, int *bugfix);
  85
  86 extern void nlopt_get_local_search_algorithm(nlopt_algorithm *deriv,
  87                                              nlopt_algorithm *nonderiv,
  88                                              int *maxeval);
  89 extern void nlopt_set_local_search_algorithm(nlopt_algorithm deriv,
  90                                              nlopt_algorithm nonderiv,
  91                                              int maxeval);
  92
  93 #ifdef __cplusplus
  94 }  /* extern "C" */
  95 #endif /* __cplusplus */
  96
  97 #endif