chiark / gitweb /
untabify source files, make indenting more uniform with GNU indent -kr --no-tabs...
[nlopt.git] / src / util / nlopt-util.h
index 437cb67b26c1f2526aee6ef3be85236e5d72842b..b7f8ab654afdc62b8ee1eca845ddd85de3ddedb8 100644 (file)
 #endif
 
 #ifdef __cplusplus
-extern "C"
-{
-#endif /* __cplusplus */
+extern "C" {
+#endif                          /* __cplusplus */
 
-int nlopt_isinf(double x);
-int nlopt_isfinite(double x);
-int nlopt_istiny(double x);
-int nlopt_isnan(double x);
+    int nlopt_isinf(double x);
+    int nlopt_isfinite(double x);
+    int nlopt_istiny(double x);
+    int nlopt_isnan(double x);
 
 /* re-entrant qsort */
-extern void nlopt_qsort_r(void *base_, size_t nmemb, size_t size, void *thunk,
-                         int (*compar)(void *, const void *, const void *));
+    extern void nlopt_qsort_r(void *base_, size_t nmemb, size_t size, void *thunk, int (*compar) (void *, const void *, const void *));
 
 /* seconds timer */
-extern double nlopt_seconds(void);
-extern unsigned long nlopt_time_seed(void);
+    extern double nlopt_seconds(void);
+    extern unsigned long nlopt_time_seed(void);
 
 /* pseudorandom number generation by Mersenne twister algorithm */
-extern void nlopt_init_genrand(unsigned long s);
-extern double nlopt_urand(double a, double b);
-extern int nlopt_iurand(int n);
-extern double nlopt_nrand(double mean, double stddev);
+    extern void nlopt_init_genrand(unsigned long s);
+    extern double nlopt_urand(double a, double b);
+    extern int nlopt_iurand(int n);
+    extern double nlopt_nrand(double mean, double stddev);
 
 /* Sobol' low-discrepancy-sequence generation */
-typedef struct nlopt_soboldata_s *nlopt_sobol;
-extern nlopt_sobol nlopt_sobol_create(unsigned sdim);
-extern void nlopt_sobol_destroy(nlopt_sobol s);
-extern void nlopt_sobol_next01(nlopt_sobol s, double *x);
-extern void nlopt_sobol_next(nlopt_sobol s, double *x,
-                           const double *lb, const double *ub);
-extern void nlopt_sobol_skip(nlopt_sobol s, unsigned n, double *x);
+    typedef struct nlopt_soboldata_s *nlopt_sobol;
+    extern nlopt_sobol nlopt_sobol_create(unsigned sdim);
+    extern void nlopt_sobol_destroy(nlopt_sobol s);
+    extern void nlopt_sobol_next01(nlopt_sobol s, double *x);
+    extern void nlopt_sobol_next(nlopt_sobol s, double *x, const double *lb, const double *ub);
+    extern void nlopt_sobol_skip(nlopt_sobol s, unsigned n, double *x);
 
 /* stopping criteria */
-typedef struct {
-     unsigned n;
-     double minf_max;
-     double ftol_rel;
-     double ftol_abs;
-     double xtol_rel;
-     const double *xtol_abs;
-     int *nevals_p, maxeval;
-     double maxtime, start;
-     int *force_stop;
-     char **stop_msg; /* pointer to msg string to update */
-} nlopt_stopping;
-extern int nlopt_stop_f(const nlopt_stopping *stop, double f, double oldf);
-extern int nlopt_stop_ftol(const nlopt_stopping *stop, double f, double oldf);
-extern int nlopt_stop_x(const nlopt_stopping *stop, 
-                       const double *x, const double *oldx);
-extern int nlopt_stop_dx(const nlopt_stopping *stop, 
-                        const double *x, const double *dx);
-extern int nlopt_stop_xs(const nlopt_stopping *stop, 
-                        const double *xs, const double *oldxs,
-                        const double *scale_min, const double *scale_max);
-extern int nlopt_stop_evals(const nlopt_stopping *stop);
-extern int nlopt_stop_time_(double start, double maxtime);
-extern int nlopt_stop_time(const nlopt_stopping *stop);
-extern int nlopt_stop_evalstime(const nlopt_stopping *stop);
-extern int nlopt_stop_forced(const nlopt_stopping *stop);
+    typedef struct {
+        unsigned n;
+        double minf_max;
+        double ftol_rel;
+        double ftol_abs;
+        double xtol_rel;
+        const double *xtol_abs;
+        int *nevals_p, maxeval;
+        double maxtime, start;
+        int *force_stop;
+        char **stop_msg;        /* pointer to msg string to update */
+    } nlopt_stopping;
+    extern int nlopt_stop_f(const nlopt_stopping * stop, double f, double oldf);
+    extern int nlopt_stop_ftol(const nlopt_stopping * stop, double f, double oldf);
+    extern int nlopt_stop_x(const nlopt_stopping * stop, const double *x, const double *oldx);
+    extern int nlopt_stop_dx(const nlopt_stopping * stop, const double *x, const double *dx);
+    extern int nlopt_stop_xs(const nlopt_stopping * stop, const double *xs, const double *oldxs, const double *scale_min, const double *scale_max);
+    extern int nlopt_stop_evals(const nlopt_stopping * stop);
+    extern int nlopt_stop_time_(double start, double maxtime);
+    extern int nlopt_stop_time(const nlopt_stopping * stop);
+    extern int nlopt_stop_evalstime(const nlopt_stopping * stop);
+    extern int nlopt_stop_forced(const nlopt_stopping * stop);
 
 /* like vsprintf, but reallocs p to whatever size is needed */
-extern char *nlopt_vsprintf(char *p, const char *format, va_list ap);
-extern void nlopt_stop_msg(const nlopt_stopping *s, const char *format, ...)
+    extern char *nlopt_vsprintf(char *p, const char *format, va_list ap);
+    extern void nlopt_stop_msg(const nlopt_stopping * s, const char *format, ...)
 #ifdef __GNUC__
-__attribute__ ((format (printf, 2, 3)))
+        __attribute__ ((format(printf, 2, 3)))
 #endif
-;
+        ;
 
 /* for local optimizations, temporarily setting eval/time limits */
-extern nlopt_result nlopt_optimize_limited(nlopt_opt opt, 
-                                          double *x, double *minf,
-                                          int maxevals, double maxtime);
+    extern nlopt_result nlopt_optimize_limited(nlopt_opt opt, double *x, double *minf, int maxevals, double maxtime);
 
 /* data structure for nonlinear inequality or equality constraint
    (f <= 0 or f = 0, respectively).  tol (>= 0) is a tolerance
    that is used for stopping criteria -- the point is considered
    "feasible" for purposes of stopping if the constraint is violated
    by at most tol. */
-typedef struct {
-     unsigned m; /* dimensional of constraint: mf maps R^n -> R^m */
-     nlopt_func f; /* one-dimensional constraint, requires m == 1 */
-     nlopt_mfunc mf;
-     nlopt_precond pre; /* preconditioner for f (NULL if none or if mf) */
-     void *f_data;
-     double *tol;
-} nlopt_constraint;
-
-extern unsigned nlopt_count_constraints(unsigned p, const nlopt_constraint *c);
-extern unsigned nlopt_max_constraint_dim(unsigned p, const nlopt_constraint *c);
-extern void nlopt_eval_constraint(double *result, double *grad,
-                                 const nlopt_constraint *c,
-                                 unsigned n, const double *x);
+    typedef struct {
+        unsigned m;             /* dimensional of constraint: mf maps R^n -> R^m */
+        nlopt_func f;           /* one-dimensional constraint, requires m == 1 */
+        nlopt_mfunc mf;
+        nlopt_precond pre;      /* preconditioner for f (NULL if none or if mf) */
+        void *f_data;
+        double *tol;
+    } nlopt_constraint;
+
+    extern unsigned nlopt_count_constraints(unsigned p, const nlopt_constraint * c);
+    extern unsigned nlopt_max_constraint_dim(unsigned p, const nlopt_constraint * c);
+    extern void nlopt_eval_constraint(double *result, double *grad, const nlopt_constraint * c, unsigned n, const double *x);
 
 /* rescale.c: */
-double *nlopt_compute_rescaling(unsigned n, const double *dx);
-double *nlopt_new_rescaled(unsigned n, const double *s, const double *x);
-void nlopt_rescale(unsigned n, const double *s, const double *x, double *xs);
-void nlopt_unscale(unsigned n, const double *s, const double *x, double *xs);
-void nlopt_reorder_bounds(unsigned n, double *lb, double *ub);
+    double *nlopt_compute_rescaling(unsigned n, const double *dx);
+    double *nlopt_new_rescaled(unsigned n, const double *s, const double *x);
+    void nlopt_rescale(unsigned n, const double *s, const double *x, double *xs);
+    void nlopt_unscale(unsigned n, const double *s, const double *x, double *xs);
+    void nlopt_reorder_bounds(unsigned n, double *lb, double *ub);
 
 #ifdef __cplusplus
-}  /* extern "C" */
-#endif /* __cplusplus */
-
+}                               /* extern "C" */
+#endif                          /* __cplusplus */
 #endif