src/util/nlopt-util.h

   1 /* Copyright (c) 2007-2014 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 <stdarg.h>
  28 #include <math.h>
  29 #include "nlopt_config.h"
  30
  31 #include "nlopt.h"
  32
  33 /* workaround for Solaris + gcc 3.4.x bug (see configure.ac) */
  34 #if defined(__GNUC__) && defined(REPLACEMENT_HUGE_VAL)
  35 #  undef HUGE_VAL
  36 #  define HUGE_VAL REPLACEMENT_HUGE_VAL
  37 #endif
  38
  39 #ifndef HAVE_COPYSIGN
  40    /* not quite right for y == -0, but good enough for us */
  41 #  define copysign(x, y) ((y) < 0 ? -fabs(x) : fabs(x))
  42 #endif
  43
  44 #ifdef __cplusplus
  45 extern "C"
  46 {
  47 #endif /* __cplusplus */
  48
  49 int nlopt_isinf(double x);
  50 int nlopt_isfinite(double x);
  51 int nlopt_istiny(double x);
  52 int nlopt_isnan(double x);
  53
  54 /* re-entrant qsort */
  55 extern void nlopt_qsort_r(void *base_, size_t nmemb, size_t size, void *thunk,
  56                           int (*compar)(void *, const void *, const void *));
  57
  58 /* seconds timer */
  59 extern double nlopt_seconds(void);
  60 extern unsigned long nlopt_time_seed(void);
  61
  62 /* pseudorandom number generation by Mersenne twister algorithm */
  63 extern void nlopt_init_genrand(unsigned long s);
  64 extern double nlopt_urand(double a, double b);
  65 extern int nlopt_iurand(int n);
  66 extern double nlopt_nrand(double mean, double stddev);
  67
  68 /* Sobol' low-discrepancy-sequence generation */
  69 typedef struct nlopt_soboldata_s *nlopt_sobol;
  70 extern nlopt_sobol nlopt_sobol_create(unsigned sdim);
  71 extern void nlopt_sobol_destroy(nlopt_sobol s);
  72 extern void nlopt_sobol_next01(nlopt_sobol s, double *x);
  73 extern void nlopt_sobol_next(nlopt_sobol s, double *x,
  74                             const double *lb, const double *ub);
  75 extern void nlopt_sobol_skip(nlopt_sobol s, unsigned n, double *x);
  76
  77 /* stopping criteria */
  78 typedef struct {
  79      unsigned n;
  80      double minf_max;
  81      double ftol_rel;
  82      double ftol_abs;
  83      double xtol_rel;
  84      const double *xtol_abs;
  85      int *nevals_p, maxeval;
  86      double maxtime, start;
  87      int *force_stop;
  88      char **stop_msg; /* pointer to msg string to update */
  89 } nlopt_stopping;
  90 extern int nlopt_stop_f(const nlopt_stopping *stop, double f, double oldf);
  91 extern int nlopt_stop_ftol(const nlopt_stopping *stop, double f, double oldf);
  92 extern int nlopt_stop_x(const nlopt_stopping *stop,
  93                         const double *x, const double *oldx);
  94 extern int nlopt_stop_dx(const nlopt_stopping *stop,
  95                          const double *x, const double *dx);
  96 extern int nlopt_stop_xs(const nlopt_stopping *stop,
  97                          const double *xs, const double *oldxs,
  98                          const double *scale_min, const double *scale_max);
  99 extern int nlopt_stop_evals(const nlopt_stopping *stop);
 100 extern int nlopt_stop_time_(double start, double maxtime);
 101 extern int nlopt_stop_time(const nlopt_stopping *stop);
 102 extern int nlopt_stop_evalstime(const nlopt_stopping *stop);
 103 extern int nlopt_stop_forced(const nlopt_stopping *stop);
 104
 105 /* like vsprintf, but reallocs p to whatever size is needed */
 106 extern char *nlopt_vsprintf(char *p, const char *format, va_list ap);
 107 extern void nlopt_stop_msg(const nlopt_stopping *s, const char *format, ...)
 108 #ifdef __GNUC__
 109 __attribute__ ((format (printf, 2, 3)))
 110 #endif
 111 ;
 112
 113 /* for local optimizations, temporarily setting eval/time limits */
 114 extern nlopt_result nlopt_optimize_limited(nlopt_opt opt,
 115                                            double *x, double *minf,
 116                                            int maxevals, double maxtime);
 117
 118 /* data structure for nonlinear inequality or equality constraint
 119    (f <= 0 or f = 0, respectively).  tol (>= 0) is a tolerance
 120    that is used for stopping criteria -- the point is considered
 121    "feasible" for purposes of stopping if the constraint is violated
 122    by at most tol. */
 123 typedef struct {
 124      unsigned m; /* dimensional of constraint: mf maps R^n -> R^m */
 125      nlopt_func f; /* one-dimensional constraint, requires m == 1 */
 126      nlopt_mfunc mf;
 127      nlopt_precond pre; /* preconditioner for f (NULL if none or if mf) */
 128      void *f_data;
 129      double *tol;
 130 } nlopt_constraint;
 131
 132 extern unsigned nlopt_count_constraints(unsigned p, const nlopt_constraint *c);
 133 extern unsigned nlopt_max_constraint_dim(unsigned p, const nlopt_constraint *c);
 134 extern void nlopt_eval_constraint(double *result, double *grad,
 135                                   const nlopt_constraint *c,
 136                                   unsigned n, const double *x);
 137
 138 /* rescale.c: */
 139 double *nlopt_compute_rescaling(unsigned n, const double *dx);
 140 double *nlopt_new_rescaled(unsigned n, const double *s, const double *x);
 141 void nlopt_rescale(unsigned n, const double *s, const double *x, double *xs);
 142 void nlopt_unscale(unsigned n, const double *s, const double *x, double *xs);
 143 void nlopt_reorder_bounds(unsigned n, double *lb, double *ub);
 144
 145 #ifdef __cplusplus
 146 }  /* extern "C" */
 147 #endif /* __cplusplus */
 148
 149 #endif