util/nlopt-util.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_UTIL_H
  24 #define NLOPT_UTIL_H
  25
  26 #include <stdlib.h>
  27 #include <math.h>
  28 #include "config.h"
  29
  30 #include "nlopt.h"
  31
  32 /* workaround for Solaris + gcc 3.4.x bug (see configure.ac) */
  33 #if defined(__GNUC__) && defined(REPLACEMENT_HUGE_VAL)
  34 #  undef HUGE_VAL
  35 #  define HUGE_VAL REPLACEMENT_HUGE_VAL
  36 #endif
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #endif /* __cplusplus */
  42
  43 int nlopt_isinf(double x);
  44
  45 /* re-entrant qsort */
  46 extern void nlopt_qsort_r(void *base_, size_t nmemb, size_t size, void *thunk,
  47                           int (*compar)(void *, const void *, const void *));
  48
  49 /* seconds timer */
  50 extern double nlopt_seconds(void);
  51 extern unsigned long nlopt_time_seed(void);
  52
  53 /* pseudorandom number generation by Mersenne twister algorithm */
  54 extern void nlopt_init_genrand(unsigned long s);
  55 extern double nlopt_urand(double a, double b);
  56 extern int nlopt_iurand(int n);
  57 extern double nlopt_nrand(double mean, double stddev);
  58
  59 /* Sobol' low-discrepancy-sequence generation */
  60 typedef struct nlopt_soboldata_s *nlopt_sobol;
  61 extern nlopt_sobol nlopt_sobol_create(unsigned sdim);
  62 extern void nlopt_sobol_destroy(nlopt_sobol s);
  63 extern void nlopt_sobol_next01(nlopt_sobol s, double *x);
  64 extern void nlopt_sobol_next(nlopt_sobol s, double *x,
  65                             const double *lb, const double *ub);
  66 extern void nlopt_sobol_skip(nlopt_sobol s, unsigned n, double *x);
  67
  68 /* stopping criteria */
  69 typedef struct {
  70      unsigned n;
  71      double minf_max;
  72      double ftol_rel;
  73      double ftol_abs;
  74      double xtol_rel;
  75      const double *xtol_abs;
  76      int nevals, maxeval;
  77      double maxtime, start;
  78 } nlopt_stopping;
  79 extern int nlopt_stop_f(const nlopt_stopping *stop, double f, double oldf);
  80 extern int nlopt_stop_ftol(const nlopt_stopping *stop, double f, double oldf);
  81 extern int nlopt_stop_x(const nlopt_stopping *stop,
  82                         const double *x, const double *oldx);
  83 extern int nlopt_stop_dx(const nlopt_stopping *stop,
  84                          const double *x, const double *dx);
  85 extern int nlopt_stop_xs(const nlopt_stopping *stop,
  86                          const double *xs, const double *oldxs,
  87                          const double *scale_min, const double *scale_max);
  88 extern int nlopt_stop_evals(const nlopt_stopping *stop);
  89 extern int nlopt_stop_time(const nlopt_stopping *stop);
  90 extern int nlopt_stop_evalstime(const nlopt_stopping *stop);
  91
  92 /* for local optimizations, temporarily setting eval/time limits */
  93 extern nlopt_result nlopt_optimize_limited(nlopt_opt opt,
  94                                            double *x, double *minf,
  95                                            int maxevals, double maxtime);
  96
  97 /* data structure for nonlinear inequality or equality constraint
  98    (f <= 0 or f = 0, respectively).  tol (>= 0) is a tolerance
  99    that is used for stopping criteria -- the point is considered
 100    "feasible" for purposes of stopping of the constraint is violated
 101    by at most tol. */
 102 typedef struct {
 103      nlopt_func f;
 104      void *f_data;
 105      double tol;
 106 } nlopt_constraint;
 107
 108 #ifdef __cplusplus
 109 }  /* extern "C" */
 110 #endif /* __cplusplus */
 111
 112 #endif