util/nlopt-util.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_UTIL_H
  24 #define NLOPT_UTIL_H
  25
  26 #ifdef __cplusplus
  27 extern "C"
  28 {
  29 #endif /* __cplusplus */
  30
  31 int nlopt_isinf(double x);
  32
  33 /* seconds timer */
  34 extern double nlopt_seconds(void);
  35 extern unsigned long nlopt_time_seed(void);
  36
  37 /* pseudorandom number generation by Mersenne twister algorithm */
  38 extern void nlopt_init_genrand(unsigned long s);
  39 extern double nlopt_urand(double a, double b);
  40 extern int nlopt_iurand(int n);
  41
  42 /* Sobol' low-discrepancy-sequence generation */
  43 typedef struct nlopt_soboldata_s *nlopt_sobol;
  44 extern nlopt_sobol nlopt_sobol_create(unsigned sdim);
  45 extern void nlopt_sobol_destroy(nlopt_sobol s);
  46 extern void nlopt_sobol_next01(nlopt_sobol s, double *x);
  47 extern void nlopt_sobol_next(nlopt_sobol s, double *x,
  48                             const double *lb, const double *ub);
  49 extern void nlopt_sobol_skip(nlopt_sobol s, unsigned n, double *x);
  50
  51 /* stopping criteria */
  52 typedef struct {
  53      int n;
  54      double minf_max;
  55      double ftol_rel;
  56      double ftol_abs;
  57      double xtol_rel;
  58      const double *xtol_abs;
  59      int nevals, maxeval;
  60      double maxtime, start;
  61 } nlopt_stopping;
  62 extern int nlopt_stop_f(const nlopt_stopping *stop, double f, double oldf);
  63 extern int nlopt_stop_ftol(const nlopt_stopping *stop, double f, double oldf);
  64 extern int nlopt_stop_x(const nlopt_stopping *stop,
  65                         const double *x, const double *oldx);
  66 extern int nlopt_stop_xs(const nlopt_stopping *stop,
  67                          const double *xs, const double *oldxs,
  68                          const double *scale_min, const double *scale_max);
  69 extern int nlopt_stop_evals(const nlopt_stopping *stop);
  70 extern int nlopt_stop_time(const nlopt_stopping *stop);
  71 extern int nlopt_stop_evalstime(const nlopt_stopping *stop);
  72
  73 #ifdef __cplusplus
  74 }  /* extern "C" */
  75 #endif /* __cplusplus */
  76
  77 #endif