1 /* Copyright (c) 2007-2010 Massachusetts Institute of Technology
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:
11 * The above copyright notice and this permission notice shall be
12 * included in all copies or substantial portions of the Software.
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.
26 #include <stddef.h> /* for ptrdiff_t and size_t */
28 /* use stdcall convention under Windows, since this seems to
29 be more standard there and is important for calling from .NET */
30 #if defined(_WIN32) || defined(__WIN32__)
31 # if defined(__GNUC__)
32 # define NLOPT_STDCALL __attribute__((stdcall))
33 # elif defined(_MSC_VER) || defined(_ICC) || defined(_STDCALL_SUPPORTED)
34 # define NLOPT_STDCALL __stdcall
36 # define NLOPT_STDCALL
39 # define NLOPT_STDCALL
42 /* for Windows compilers, you should add a line
44 when using NLopt from a DLL, in order to do the proper
45 Windows importing nonsense. */
46 #if defined(NLOPT_DLL) && (defined(_WIN32) || defined(__WIN32__)) && !defined(__LCC__)
47 /* annoying Windows syntax for calling functions in a DLL */
48 # if defined(NLOPT_DLL_EXPORT)
49 # define NLOPT_EXTERN(T) extern __declspec(dllexport) T NLOPT_STDCALL
51 # define NLOPT_EXTERN(T) extern __declspec(dllimport) T NLOPT_STDCALL
54 # define NLOPT_EXTERN(T) extern T NLOPT_STDCALL
60 #endif /* __cplusplus */
62 typedef double (*nlopt_func)(unsigned n, const double *x,
63 double *gradient, /* NULL if not needed */
66 typedef void (*nlopt_mfunc)(unsigned m, double *result,
67 unsigned n, const double *x,
68 double *gradient, /* NULL if not needed */
72 /* Naming conventions:
75 = global/local derivative/no-derivative optimization,
78 *_RAND algorithms involve some randomization.
80 *_NOSCAL algorithms are *not* scaled to a unit hypercube
81 (i.e. they are sensitive to the units of x)
86 NLOPT_GN_DIRECT_L_RAND,
87 NLOPT_GN_DIRECT_NOSCAL,
88 NLOPT_GN_DIRECT_L_NOSCAL,
89 NLOPT_GN_DIRECT_L_RAND_NOSCAL,
92 NLOPT_GN_ORIG_DIRECT_L,
97 NLOPT_LD_LBFGS_NOCEDAL,
107 NLOPT_LD_TNEWTON_RESTART,
108 NLOPT_LD_TNEWTON_PRECOND,
109 NLOPT_LD_TNEWTON_PRECOND_RESTART,
123 NLOPT_LN_NEWUOA_BOUND,
137 /* new variants that require local_optimizer to be set,
138 not with older constants for backwards compatibility */
146 NLOPT_NUM_ALGORITHMS /* not an algorithm, just the number of them */
149 extern const char *nlopt_algorithm_name(nlopt_algorithm a);
152 NLOPT_FAILURE = -1, /* generic failure code */
153 NLOPT_INVALID_ARGS = -2,
154 NLOPT_OUT_OF_MEMORY = -3,
155 NLOPT_ROUNDOFF_LIMITED = -4,
156 NLOPT_FORCED_STOP = -5,
157 NLOPT_SUCCESS = 1, /* generic success code */
158 NLOPT_STOPVAL_REACHED = 2,
159 NLOPT_FTOL_REACHED = 3,
160 NLOPT_XTOL_REACHED = 4,
161 NLOPT_MAXEVAL_REACHED = 5,
162 NLOPT_MAXTIME_REACHED = 6
165 #define NLOPT_MINF_MAX_REACHED NLOPT_STOPVAL_REACHED
167 NLOPT_EXTERN(void) nlopt_srand(unsigned long seed);
168 NLOPT_EXTERN(void) nlopt_srand_time(void);
170 NLOPT_EXTERN(void) nlopt_version(int *major, int *minor, int *bugfix);
172 /*************************** OBJECT-ORIENTED API **************************/
173 /* The style here is that we create an nlopt_opt "object" (an opaque pointer),
174 then set various optimization parameters, and then execute the
175 algorithm. In this way, we can add more and more optimization parameters
176 (including algorithm-specific ones) without breaking backwards
177 compatibility, having functions with zillions of parameters, or
178 relying non-reentrantly on global variables.*/
180 struct nlopt_opt_s; /* opaque structure, defined internally */
181 typedef struct nlopt_opt_s *nlopt_opt;
183 /* the only immutable parameters of an optimization are the algorithm and
184 the dimension n of the problem, since changing either of these could
185 have side-effects on lots of other parameters */
186 NLOPT_EXTERN(nlopt_opt) nlopt_create(nlopt_algorithm algorithm, unsigned n);
187 NLOPT_EXTERN(void) nlopt_destroy(nlopt_opt opt);
188 NLOPT_EXTERN(nlopt_opt) nlopt_copy(const nlopt_opt opt);
190 NLOPT_EXTERN(nlopt_result) nlopt_optimize(nlopt_opt opt, double *x,
193 NLOPT_EXTERN(nlopt_result) nlopt_set_min_objective(nlopt_opt opt, nlopt_func f,
195 NLOPT_EXTERN(nlopt_result) nlopt_set_max_objective(nlopt_opt opt, nlopt_func f,
198 NLOPT_EXTERN(nlopt_algorithm) nlopt_get_algorithm(const nlopt_opt opt);
199 NLOPT_EXTERN(unsigned) nlopt_get_dimension(const nlopt_opt opt);
203 NLOPT_EXTERN(nlopt_result) nlopt_set_lower_bounds(nlopt_opt opt,
205 NLOPT_EXTERN(nlopt_result) nlopt_set_lower_bounds1(nlopt_opt opt, double lb);
206 NLOPT_EXTERN(nlopt_result) nlopt_get_lower_bounds(const nlopt_opt opt,
208 NLOPT_EXTERN(nlopt_result) nlopt_set_upper_bounds(nlopt_opt opt,
210 NLOPT_EXTERN(nlopt_result) nlopt_set_upper_bounds1(nlopt_opt opt, double ub);
211 NLOPT_EXTERN(nlopt_result) nlopt_get_upper_bounds(const nlopt_opt opt,
214 NLOPT_EXTERN(nlopt_result) nlopt_remove_inequality_constraints(nlopt_opt opt);
215 NLOPT_EXTERN(nlopt_result) nlopt_add_inequality_constraint(nlopt_opt opt,
219 NLOPT_EXTERN(nlopt_result) nlopt_add_inequality_mconstraint(nlopt_opt opt,
225 NLOPT_EXTERN(nlopt_result) nlopt_remove_equality_constraints(nlopt_opt opt);
226 NLOPT_EXTERN(nlopt_result) nlopt_add_equality_constraint(nlopt_opt opt,
230 NLOPT_EXTERN(nlopt_result) nlopt_add_equality_mconstraint(nlopt_opt opt,
236 /* stopping criteria: */
238 NLOPT_EXTERN(nlopt_result) nlopt_set_stopval(nlopt_opt opt, double stopval);
239 NLOPT_EXTERN(double) nlopt_get_stopval(const nlopt_opt opt);
241 NLOPT_EXTERN(nlopt_result) nlopt_set_ftol_rel(nlopt_opt opt, double tol);
242 NLOPT_EXTERN(double) nlopt_get_ftol_rel(const nlopt_opt opt);
243 NLOPT_EXTERN(nlopt_result) nlopt_set_ftol_abs(nlopt_opt opt, double tol);
244 NLOPT_EXTERN(double) nlopt_get_ftol_abs(const nlopt_opt opt);
246 NLOPT_EXTERN(nlopt_result) nlopt_set_xtol_rel(nlopt_opt opt, double tol);
247 NLOPT_EXTERN(double) nlopt_get_xtol_rel(const nlopt_opt opt);
248 NLOPT_EXTERN(nlopt_result) nlopt_set_xtol_abs1(nlopt_opt opt, double tol);
249 NLOPT_EXTERN(nlopt_result) nlopt_set_xtol_abs(nlopt_opt opt, const double *tol);
250 NLOPT_EXTERN(nlopt_result) nlopt_get_xtol_abs(const nlopt_opt opt,
253 NLOPT_EXTERN(nlopt_result) nlopt_set_maxeval(nlopt_opt opt, int maxeval);
254 NLOPT_EXTERN(int) nlopt_get_maxeval(nlopt_opt opt);
256 NLOPT_EXTERN(nlopt_result) nlopt_set_maxtime(nlopt_opt opt, double maxtime);
257 NLOPT_EXTERN(double) nlopt_get_maxtime(nlopt_opt opt);
259 NLOPT_EXTERN(nlopt_result) nlopt_force_stop(nlopt_opt opt);
260 NLOPT_EXTERN(nlopt_result) nlopt_set_force_stop(nlopt_opt opt, int val);
261 NLOPT_EXTERN(int) nlopt_get_force_stop(nlopt_opt opt);
263 /* more algorithm-specific parameters */
265 NLOPT_EXTERN(nlopt_result) nlopt_set_local_optimizer(nlopt_opt opt,
266 const nlopt_opt local_opt);
268 NLOPT_EXTERN(nlopt_result) nlopt_set_population(nlopt_opt opt, unsigned pop);
269 NLOPT_EXTERN(unsigned) nlopt_get_population(const nlopt_opt opt);
271 NLOPT_EXTERN(nlopt_result) nlopt_set_default_initial_step(nlopt_opt opt,
273 NLOPT_EXTERN(nlopt_result) nlopt_set_initial_step(nlopt_opt opt,
275 NLOPT_EXTERN(nlopt_result) nlopt_set_initial_step1(nlopt_opt opt, double dx);
276 NLOPT_EXTERN(nlopt_result) nlopt_get_initial_step(const nlopt_opt opt,
277 const double *x, double *dx);
279 /* the following are functions mainly designed to be used internally
280 by the Fortran and SWIG wrappers, allow us to tel nlopt_destroy and
281 nlopt_copy to do something to the f_data pointers (e.g. free or
282 duplicate them, respectively) */
283 typedef void* (*nlopt_munge)(void *p);
284 NLOPT_EXTERN(void) nlopt_set_munge(nlopt_opt opt,
285 nlopt_munge munge_on_destroy,
286 nlopt_munge munge_on_copy);
288 /*************************** DEPRECATED API **************************/
289 /* The new "object-oriented" API is preferred, since it allows us to
290 gracefully add new features and algorithm-specific options in a
291 re-entrant way, and we can automatically assume reasonable defaults
292 for unspecified parameters. */
294 /* Where possible (e.g. for gcc >= 3.1), enable a compiler warning
295 for code that uses a deprecated function */
296 #if defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__==3 && __GNUC_MINOR__ > 0))
297 # define NLOPT_DEPRECATED __attribute__((deprecated))
299 # define NLOPT_DEPRECATED
302 typedef double (*nlopt_func_old)(int n, const double *x,
303 double *gradient, /* NULL if not needed */
306 NLOPT_EXTERN(nlopt_result) nlopt_minimize(
307 nlopt_algorithm algorithm,
308 int n, nlopt_func_old f, void *f_data,
309 const double *lb, const double *ub, /* bounds */
310 double *x, /* in: initial guess, out: minimizer */
311 double *minf, /* out: minimum */
312 double minf_max, double ftol_rel, double ftol_abs,
313 double xtol_rel, const double *xtol_abs,
314 int maxeval, double maxtime) NLOPT_DEPRECATED;
316 NLOPT_EXTERN(nlopt_result) nlopt_minimize_constrained(
317 nlopt_algorithm algorithm,
318 int n, nlopt_func_old f, void *f_data,
319 int m, nlopt_func_old fc, void *fc_data, ptrdiff_t fc_datum_size,
320 const double *lb, const double *ub, /* bounds */
321 double *x, /* in: initial guess, out: minimizer */
322 double *minf, /* out: minimum */
323 double minf_max, double ftol_rel, double ftol_abs,
324 double xtol_rel, const double *xtol_abs,
325 int maxeval, double maxtime) NLOPT_DEPRECATED;
327 NLOPT_EXTERN(nlopt_result) nlopt_minimize_econstrained(
328 nlopt_algorithm algorithm,
329 int n, nlopt_func_old f, void *f_data,
330 int m, nlopt_func_old fc, void *fc_data, ptrdiff_t fc_datum_size,
331 int p, nlopt_func_old h, void *h_data, ptrdiff_t h_datum_size,
332 const double *lb, const double *ub, /* bounds */
333 double *x, /* in: initial guess, out: minimizer */
334 double *minf, /* out: minimum */
335 double minf_max, double ftol_rel, double ftol_abs,
336 double xtol_rel, const double *xtol_abs,
337 double htol_rel, double htol_abs,
338 int maxeval, double maxtime) NLOPT_DEPRECATED;
340 NLOPT_EXTERN(void) nlopt_get_local_search_algorithm(nlopt_algorithm *deriv,
341 nlopt_algorithm *nonderiv,
342 int *maxeval) NLOPT_DEPRECATED;
343 NLOPT_EXTERN(void) nlopt_set_local_search_algorithm(nlopt_algorithm deriv,
344 nlopt_algorithm nonderiv,
345 int maxeval) NLOPT_DEPRECATED;
347 NLOPT_EXTERN(int) nlopt_get_stochastic_population(void) NLOPT_DEPRECATED;
348 NLOPT_EXTERN(void) nlopt_set_stochastic_population(int pop) NLOPT_DEPRECATED;
350 /*********************************************************************/
354 #endif /* __cplusplus */