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.
23 #ifndef NLOPT_INTERNAL_H
24 #define NLOPT_INTERNAL_H
27 #include "nlopt-util.h"
32 #endif /* __cplusplus */
34 /*********************************************************************/
37 nlopt_algorithm algorithm; /* the optimization algorithm (immutable) */
38 unsigned n; /* the dimension of the problem (immutable) */
40 nlopt_func f; void *f_data; /* objective function to minimize */
41 int maximize; /* nonzero if we are maximizing, not minimizing */
43 double *lb, *ub; /* lower and upper bounds (length n) */
45 unsigned m; /* number of inequality constraints */
46 unsigned m_alloc; /* number of inequality constraints allocated */
47 nlopt_constraint *fc; /* inequality constraints, length m_alloc */
49 unsigned p; /* number of equality constraints */
50 unsigned p_alloc; /* number of inequality constraints allocated */
51 nlopt_constraint *h; /* equality constraints, length p_alloc */
53 nlopt_munge munge_on_destroy, munge_on_copy; /* hack for wrappers */
55 /* stopping criteria */
56 double stopval; /* stop when f reaches stopval or better */
57 double ftol_rel, ftol_abs; /* relative/absolute f tolerances */
58 double xtol_rel, *xtol_abs; /* rel/abs x tolerances */
59 int maxeval; /* max # evaluations */
60 double maxtime; /* max time (seconds) */
62 int force_stop; /* if nonzero, force a halt the next time we
63 try to evaluate the objective during optimization */
64 /* when local optimization is used, we need a force_stop in the
65 parent object to force a stop in child optimizations */
66 struct nlopt_opt_s *force_stop_child;
68 /* algorithm-specific parameters */
69 nlopt_opt local_opt; /* local optimizer */
70 unsigned stochastic_population; /* population size for stochastic algs */
71 double *dx; /* initial step sizes (length n) for nonderivative algs */
73 double *work; /* algorithm-specific workspace during optimization */
76 /*********************************************************************/
77 extern void nlopt_srand_time_default(void); /* init the rand. seed only if unset */
79 /*********************************************************************/
80 /* global defaults set by deprecated API: */
82 extern nlopt_algorithm nlopt_local_search_alg_deriv;
83 extern nlopt_algorithm nlopt_local_search_alg_nonderiv;
84 extern int nlopt_local_search_maxeval;
85 extern unsigned nlopt_stochastic_population;
87 /*********************************************************************/
91 #endif /* __cplusplus */
93 #endif /* NLOPT_INTERNAL_H */