|
1
|
1 /* |
|
|
2 |
|
1884
|
3 Copyright (C) 1996 John W. Eaton |
|
1
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
20 |
|
|
21 */ |
|
|
22 |
|
240
|
23 #ifdef HAVE_CONFIG_H |
|
1192
|
24 #include <config.h> |
|
1
|
25 #endif |
|
|
26 |
|
1728
|
27 #include <string> |
|
|
28 |
|
2095
|
29 #include <iostream.h> |
|
287
|
30 |
|
1
|
31 #include "NPSOL.h" |
|
|
32 |
|
1352
|
33 #include "defun-dld.h" |
|
1
|
34 #include "error.h" |
|
1352
|
35 #include "gripes.h" |
|
|
36 #include "help.h" |
|
1740
|
37 #include "mappers.h" |
|
|
38 #include "oct-obj.h" |
|
287
|
39 #include "pager.h" |
|
2367
|
40 #include "pt-fvc.h" |
|
1
|
41 #include "utils.h" |
|
1352
|
42 #include "variables.h" |
|
1
|
43 |
|
646
|
44 #ifndef NPSOL_MISSING |
|
|
45 |
|
1
|
46 // Global pointers for user defined functions required by npsol. |
|
488
|
47 static tree_fvc *npsol_objective; |
|
|
48 static tree_fvc *npsol_constraints; |
|
1
|
49 |
|
287
|
50 static NPSOL_options npsol_opts; |
|
|
51 |
|
1
|
52 double |
|
162
|
53 npsol_objective_function (const ColumnVector& x) |
|
1
|
54 { |
|
|
55 int n = x.capacity (); |
|
|
56 |
|
2086
|
57 octave_value decision_vars; |
|
1
|
58 if (n > 1) |
|
|
59 { |
|
|
60 Matrix m (n, 1); |
|
|
61 for (int i = 0; i < n; i++) |
|
2305
|
62 m (i, 0) = x (i); |
|
516
|
63 decision_vars = m; |
|
1
|
64 } |
|
|
65 else |
|
|
66 { |
|
2305
|
67 double d = x (0); |
|
516
|
68 decision_vars = d; |
|
1
|
69 } |
|
|
70 |
|
2086
|
71 octave_value_list args; |
|
718
|
72 args(0) = decision_vars; |
|
1
|
73 |
|
255
|
74 static double retval; |
|
|
75 retval = 0.0; |
|
|
76 |
|
2086
|
77 octave_value objective_value; |
|
519
|
78 if (npsol_objective) |
|
1
|
79 { |
|
2086
|
80 octave_value_list tmp = npsol_objective->eval (0, 1, args); |
|
255
|
81 |
|
|
82 if (error_state) |
|
|
83 { |
|
|
84 error ("npsol: error evaluating objective function"); |
|
|
85 npsol_objective_error = 1; // XXX FIXME XXX |
|
|
86 return retval; |
|
|
87 } |
|
|
88 |
|
497
|
89 if (tmp.length () > 0 && tmp(0).is_defined ()) |
|
|
90 objective_value = tmp(0); |
|
1
|
91 else |
|
|
92 { |
|
158
|
93 error ("npsol: error evaluating objective function"); |
|
255
|
94 npsol_objective_error = 1; // XXX FIXME XXX |
|
|
95 return retval; |
|
1
|
96 } |
|
|
97 } |
|
|
98 |
|
620
|
99 if (objective_value.is_real_matrix ()) |
|
1
|
100 { |
|
620
|
101 Matrix m = objective_value.matrix_value (); |
|
|
102 if (m.rows () == 1 && m.columns () == 1) |
|
2305
|
103 retval = m (0, 0); |
|
620
|
104 else |
|
|
105 { |
|
|
106 gripe_user_returned_invalid ("npsol_objective"); |
|
|
107 npsol_objective_error = 1; // XXX FIXME XXX |
|
|
108 } |
|
|
109 } |
|
|
110 else if (objective_value.is_real_scalar ()) |
|
|
111 { |
|
1
|
112 retval = objective_value.double_value (); |
|
620
|
113 } |
|
|
114 else |
|
|
115 { |
|
1
|
116 gripe_user_returned_invalid ("npsol_objective"); |
|
255
|
117 npsol_objective_error = 1; // XXX FIXME XXX |
|
1
|
118 } |
|
|
119 |
|
|
120 return retval; |
|
|
121 } |
|
|
122 |
|
|
123 ColumnVector |
|
162
|
124 npsol_constraint_function (const ColumnVector& x) |
|
1
|
125 { |
|
|
126 ColumnVector retval; |
|
|
127 |
|
|
128 int n = x.capacity (); |
|
|
129 |
|
2086
|
130 octave_value decision_vars; |
|
1
|
131 if (n > 1) |
|
|
132 { |
|
|
133 Matrix m (n, 1); |
|
|
134 for (int i = 0; i < n; i++) |
|
2305
|
135 m (i, 0) = x (i); |
|
516
|
136 decision_vars = m; |
|
1
|
137 } |
|
|
138 else |
|
|
139 { |
|
2305
|
140 double d = x (0); |
|
516
|
141 decision_vars = d; |
|
1
|
142 } |
|
|
143 |
|
2086
|
144 octave_value_list args; |
|
718
|
145 args(0) = decision_vars; |
|
1
|
146 |
|
519
|
147 if (npsol_constraints) |
|
1
|
148 { |
|
2086
|
149 octave_value_list tmp = npsol_constraints->eval (0, 1, args); |
|
255
|
150 |
|
|
151 if (error_state) |
|
|
152 { |
|
|
153 error ("npsol: error evaluating constraints"); |
|
|
154 return retval; |
|
|
155 } |
|
|
156 |
|
497
|
157 if (tmp.length () > 0 && tmp(0).is_defined ()) |
|
1
|
158 { |
|
628
|
159 retval = tmp(0).vector_value (); |
|
255
|
160 |
|
636
|
161 if (error_state || retval.length () <= 0) |
|
255
|
162 error ("npsol: error evaluating constraints"); |
|
1
|
163 } |
|
|
164 else |
|
497
|
165 error ("npsol: error evaluating constraints"); |
|
1
|
166 } |
|
|
167 |
|
|
168 return retval; |
|
|
169 } |
|
|
170 |
|
1949
|
171 static int |
|
1
|
172 linear_constraints_ok (const ColumnVector& x, const ColumnVector& llb, |
|
|
173 const Matrix& c, const ColumnVector& lub, |
|
|
174 char *warn_for, int warn) |
|
|
175 { |
|
|
176 int x_len = x.capacity (); |
|
|
177 int llb_len = llb.capacity (); |
|
|
178 int lub_len = lub.capacity (); |
|
|
179 int c_rows = c.rows (); |
|
|
180 int c_cols = c.columns (); |
|
|
181 |
|
132
|
182 int ok = 1; |
|
|
183 if (warn) |
|
|
184 { |
|
|
185 if (c_rows == 0 || c_cols == 0 || llb_len == 0 || lub_len == 0) |
|
|
186 { |
|
|
187 ok = 0; |
|
158
|
188 error ("%s: linear constraints must have nonzero dimensions", |
|
|
189 warn_for); |
|
132
|
190 } |
|
|
191 else if (x_len != c_cols || llb_len != lub_len || llb_len != c_rows) |
|
|
192 { |
|
|
193 ok = 0; |
|
158
|
194 error ("%s: linear constraints have inconsistent dimensions", |
|
|
195 warn_for); |
|
132
|
196 } |
|
|
197 } |
|
1
|
198 |
|
|
199 return ok; |
|
|
200 } |
|
|
201 |
|
1949
|
202 static int |
|
1
|
203 nonlinear_constraints_ok (const ColumnVector& x, const ColumnVector& nllb, |
|
1537
|
204 NLFunc::nonlinear_fcn g, const ColumnVector& nlub, |
|
1
|
205 char *warn_for, int warn) |
|
|
206 { |
|
|
207 int nllb_len = nllb.capacity (); |
|
|
208 int nlub_len = nlub.capacity (); |
|
|
209 ColumnVector c = (*g) (x); |
|
|
210 int c_len = c.capacity (); |
|
|
211 |
|
132
|
212 int ok = 1; |
|
|
213 if (warn) |
|
|
214 { |
|
|
215 if (nllb_len == 0 || nlub_len == 0 || c_len == 0) |
|
|
216 { |
|
|
217 ok = 0; |
|
158
|
218 error ("%s: nonlinear constraints have nonzero dimensions", |
|
|
219 warn_for); |
|
132
|
220 } |
|
|
221 else if (nllb_len != nlub_len || nllb_len != c_len) |
|
|
222 { |
|
|
223 ok = 0; |
|
162
|
224 error ("%s: nonlinear constraints have inconsistent dimensions", |
|
|
225 warn_for); |
|
132
|
226 } |
|
135
|
227 } |
|
1
|
228 return ok; |
|
|
229 } |
|
|
230 |
|
646
|
231 #endif |
|
|
232 |
|
519
|
233 #if defined (NPSOL_MISSING) |
|
2465
|
234 DEFUN_DLD (npsol, , , |
|
519
|
235 "This function requires NPSOL, which is not freely\n\ |
|
|
236 redistributable. For more information, read the file\n\ |
|
|
237 libcruft/npsol/README.MISSING in the source distribution.") |
|
|
238 #else |
|
2465
|
239 DEFUN_DLD (npsol, args, nargout, |
|
1686
|
240 "[X, OBJ, INFO, LAMBDA] = npsol (X, PHI [, LB, UB] [, A_LB, A, A_UB]\n\ |
|
|
241 [, G_LB, G, G_UB])\n\ |
|
519
|
242 \n\ |
|
|
243 Groups of arguments surrounded in `[]' are optional, but\n\ |
|
|
244 must appear in the same relative order shown above.\n\ |
|
|
245 \n\ |
|
|
246 The second argument is a string containing the name of the objective\n\ |
|
|
247 function to call. The objective function must be of the form\n\ |
|
|
248 \n\ |
|
|
249 y = phi (x)\n\ |
|
|
250 \n\ |
|
|
251 where x is a vector and y is a scalar.\n\ |
|
|
252 \n\ |
|
|
253 The argument G is a string containing the name of the function that |
|
|
254 defines the nonlinear constraints. It must be of the form\n\ |
|
|
255 \n\ |
|
|
256 y = g (x)\n\ |
|
|
257 \n\ |
|
|
258 where x is a vector and y is a vector.") |
|
|
259 #endif |
|
1
|
260 { |
|
|
261 /* |
|
|
262 |
|
|
263 Handle all of the following: |
|
|
264 |
|
|
265 1. npsol (x, phi) |
|
|
266 2. npsol (x, phi, lb, ub) |
|
|
267 3. npsol (x, phi, lb, ub, llb, c, lub) |
|
|
268 4. npsol (x, phi, lb, ub, llb, c, lub, nllb, g, nlub) |
|
|
269 5. npsol (x, phi, lb, ub, nllb, g, nlub) |
|
|
270 6. npsol (x, phi, llb, c, lub, nllb, g, nlub) |
|
|
271 7. npsol (x, phi, llb, c, lub) |
|
|
272 8. npsol (x, phi, nllb, g, nlub) |
|
|
273 |
|
|
274 */ |
|
|
275 |
|
2086
|
276 octave_value_list retval; |
|
1
|
277 |
|
519
|
278 #if defined (NPSOL_MISSING) |
|
|
279 |
|
1357
|
280 // Force a bad value of inform, and empty matrices for x, phi, and |
|
|
281 // lambda. |
|
519
|
282 |
|
|
283 retval.resize (4, Matrix ()); |
|
|
284 |
|
|
285 retval(2) = -1.0; |
|
|
286 |
|
|
287 print_usage ("npsol"); |
|
|
288 |
|
|
289 #else |
|
|
290 |
|
506
|
291 int nargin = args.length (); |
|
|
292 |
|
712
|
293 if (nargin < 2 || nargin == 3 || nargin == 6 || nargin == 9 |
|
|
294 || nargin > 10 || nargout > 4) |
|
519
|
295 { |
|
|
296 print_usage ("npsol"); |
|
|
297 return retval; |
|
|
298 } |
|
|
299 |
|
712
|
300 ColumnVector x = args(0).vector_value (); |
|
1
|
301 |
|
636
|
302 if (error_state || x.capacity () == 0) |
|
1
|
303 { |
|
158
|
304 error ("npsol: expecting vector as first argument"); |
|
1
|
305 return retval; |
|
|
306 } |
|
|
307 |
|
2797
|
308 npsol_objective = extract_function |
|
|
309 (args(1), "npsol", "__npsol_obj__", |
|
|
310 "function phi = __npsol_obj__ (x) phi = ", |
|
|
311 "; endfunction"); |
|
|
312 |
|
1488
|
313 if (! npsol_objective) |
|
1
|
314 return retval; |
|
|
315 |
|
|
316 Objective func (npsol_objective_function); |
|
|
317 |
|
|
318 ColumnVector soln; |
|
|
319 |
|
|
320 Bounds bounds; |
|
712
|
321 if (nargin == 4 || nargin == 7 || nargin == 10) |
|
1
|
322 { |
|
712
|
323 ColumnVector lb = args(2).vector_value (); |
|
|
324 ColumnVector ub = args(3).vector_value (); |
|
1
|
325 |
|
|
326 int lb_len = lb.capacity (); |
|
|
327 int ub_len = ub.capacity (); |
|
636
|
328 |
|
|
329 if (error_state || lb_len != ub_len || lb_len != x.capacity ()) |
|
1
|
330 { |
|
214
|
331 error ("npsol: lower and upper bounds and decision variable vector"); |
|
|
332 error ("must all have the same number of elements"); |
|
1
|
333 return retval; |
|
|
334 } |
|
|
335 |
|
|
336 bounds.resize (lb_len); |
|
|
337 bounds.set_lower_bounds (lb); |
|
|
338 bounds.set_upper_bounds (ub); |
|
|
339 } |
|
|
340 |
|
|
341 double objf; |
|
|
342 ColumnVector lambda; |
|
|
343 int inform; |
|
|
344 |
|
712
|
345 if (nargin == 2) |
|
1
|
346 { |
|
|
347 // 1. npsol (x, phi) |
|
|
348 |
|
|
349 NPSOL nlp (x, func); |
|
1874
|
350 nlp.set_options (npsol_opts); |
|
1
|
351 soln = nlp.minimize (objf, inform, lambda); |
|
|
352 |
|
|
353 goto solved; |
|
|
354 } |
|
|
355 |
|
712
|
356 if (nargin == 4) |
|
1
|
357 { |
|
|
358 // 2. npsol (x, phi, lb, ub) |
|
|
359 |
|
|
360 NPSOL nlp (x, func, bounds); |
|
1874
|
361 nlp.set_options (npsol_opts); |
|
1
|
362 soln = nlp.minimize (objf, inform, lambda); |
|
|
363 |
|
|
364 goto solved; |
|
|
365 } |
|
|
366 |
|
519
|
367 npsol_constraints = 0; |
|
712
|
368 if (nargin == 5 || nargin == 7 || nargin == 8 || nargin == 10) |
|
2797
|
369 npsol_constraints = extract_function |
|
|
370 (args(nargin-2), "npsol", "__npsol_constr__", |
|
|
371 "function y = __npsol_constr__ (x) y = ", |
|
|
372 "; endfunction"); |
|
1
|
373 |
|
712
|
374 if (nargin == 7 || nargin == 5) |
|
1
|
375 { |
|
519
|
376 if (! npsol_constraints) |
|
1
|
377 { |
|
945
|
378 ColumnVector lub = args(nargin-1).vector_value (); |
|
|
379 ColumnVector llb = args(nargin-3).vector_value (); |
|
1
|
380 |
|
636
|
381 if (error_state || llb.capacity () == 0 || lub.capacity () == 0) |
|
215
|
382 { |
|
|
383 error ("npsol: bounds for linear constraints must be vectors"); |
|
|
384 return retval; |
|
|
385 } |
|
1
|
386 |
|
945
|
387 Matrix c = args(nargin-2).matrix_value (); |
|
636
|
388 |
|
|
389 if (error_state) |
|
|
390 { |
|
|
391 error ("npsol: invalid linear constraint matrix"); |
|
|
392 return retval; |
|
|
393 } |
|
|
394 |
|
1
|
395 if (! linear_constraints_ok (x, llb, c, lub, "npsol", 1)) |
|
|
396 return retval; |
|
|
397 |
|
215
|
398 LinConst linear_constraints (llb, c, lub); |
|
|
399 |
|
712
|
400 if (nargin == 5) |
|
1
|
401 { |
|
|
402 // 7. npsol (x, phi, llb, c, lub) |
|
|
403 |
|
|
404 NPSOL nlp (x, func, linear_constraints); |
|
1874
|
405 nlp.set_options (npsol_opts); |
|
1
|
406 soln = nlp.minimize (objf, inform, lambda); |
|
|
407 } |
|
|
408 else |
|
|
409 { |
|
|
410 // 3. npsol (x, phi, lb, ub, llb, c, lub) |
|
|
411 |
|
|
412 NPSOL nlp (x, func, bounds, linear_constraints); |
|
1874
|
413 nlp.set_options (npsol_opts); |
|
1
|
414 soln = nlp.minimize (objf, inform, lambda); |
|
|
415 } |
|
|
416 goto solved; |
|
|
417 } |
|
|
418 else |
|
|
419 { |
|
1488
|
420 ColumnVector nlub = args(nargin-1).vector_value (); |
|
|
421 ColumnVector nllb = args(nargin-3).vector_value (); |
|
1
|
422 |
|
1488
|
423 if (error_state |
|
|
424 || (! nonlinear_constraints_ok |
|
|
425 (x, nllb, npsol_constraint_function, nlub, "npsol", 1))) |
|
|
426 return retval; |
|
1
|
427 |
|
1488
|
428 NLFunc const_func (npsol_constraint_function); |
|
|
429 NLConst nonlinear_constraints (nllb, const_func, nlub); |
|
1
|
430 |
|
1488
|
431 if (nargin == 5) |
|
|
432 { |
|
|
433 // 8. npsol (x, phi, nllb, g, nlub) |
|
1
|
434 |
|
1488
|
435 NPSOL nlp (x, func, nonlinear_constraints); |
|
1874
|
436 nlp.set_options (npsol_opts); |
|
1488
|
437 soln = nlp.minimize (objf, inform, lambda); |
|
|
438 } |
|
|
439 else |
|
|
440 { |
|
|
441 // 5. npsol (x, phi, lb, ub, nllb, g, nlub) |
|
1
|
442 |
|
1488
|
443 NPSOL nlp (x, func, bounds, nonlinear_constraints); |
|
1874
|
444 nlp.set_options (npsol_opts); |
|
1488
|
445 soln = nlp.minimize (objf, inform, lambda); |
|
1
|
446 } |
|
1488
|
447 goto solved; |
|
1
|
448 } |
|
|
449 } |
|
|
450 |
|
712
|
451 if (nargin == 8 || nargin == 10) |
|
1
|
452 { |
|
519
|
453 if (! npsol_constraints) |
|
1
|
454 { |
|
|
455 // Produce error message. |
|
1357
|
456 |
|
945
|
457 is_valid_function (args(nargin-2), "npsol", 1); |
|
1
|
458 } |
|
|
459 else |
|
|
460 { |
|
1488
|
461 ColumnVector nlub = args(nargin-1).vector_value (); |
|
|
462 ColumnVector nllb = args(nargin-3).vector_value (); |
|
1
|
463 |
|
1488
|
464 if (error_state |
|
|
465 || (! nonlinear_constraints_ok |
|
|
466 (x, nllb, npsol_constraint_function, nlub, "npsol", 1))) |
|
|
467 return retval; |
|
|
468 |
|
|
469 NLFunc const_func (npsol_constraint_function); |
|
|
470 NLConst nonlinear_constraints (nllb, const_func, nlub); |
|
1
|
471 |
|
1488
|
472 ColumnVector lub = args(nargin-4).vector_value (); |
|
|
473 ColumnVector llb = args(nargin-6).vector_value (); |
|
1
|
474 |
|
1488
|
475 if (error_state || llb.capacity () == 0 || lub.capacity () == 0) |
|
|
476 { |
|
|
477 error ("npsol: bounds for linear constraints must be vectors"); |
|
|
478 return retval; |
|
|
479 } |
|
636
|
480 |
|
1488
|
481 Matrix c = args(nargin-5).matrix_value (); |
|
636
|
482 |
|
1488
|
483 if (error_state) |
|
|
484 { |
|
|
485 error ("npsol: invalid linear constraint matrix"); |
|
|
486 return retval; |
|
|
487 } |
|
215
|
488 |
|
1488
|
489 if (! linear_constraints_ok (x, llb, c, lub, "npsol", 1)) |
|
|
490 return retval; |
|
1
|
491 |
|
1488
|
492 LinConst linear_constraints (llb, c, lub); |
|
1
|
493 |
|
1488
|
494 if (nargin == 8) |
|
|
495 { |
|
|
496 // 6. npsol (x, phi, llb, c, lub, nllb, g, nlub) |
|
1
|
497 |
|
1488
|
498 NPSOL nlp (x, func, linear_constraints, |
|
|
499 nonlinear_constraints); |
|
1874
|
500 nlp.set_options (npsol_opts); |
|
1488
|
501 soln = nlp.minimize (objf, inform, lambda); |
|
|
502 } |
|
|
503 else |
|
|
504 { |
|
|
505 // 4. npsol (x, phi, lb, ub, llb, c, lub, nllb, g, nlub) |
|
1
|
506 |
|
1488
|
507 NPSOL nlp (x, func, bounds, linear_constraints, |
|
|
508 nonlinear_constraints); |
|
1874
|
509 nlp.set_options (npsol_opts); |
|
1488
|
510 soln = nlp.minimize (objf, inform, lambda); |
|
1
|
511 } |
|
1488
|
512 goto solved; |
|
1
|
513 } |
|
|
514 } |
|
|
515 |
|
|
516 return retval; |
|
|
517 |
|
|
518 solved: |
|
|
519 |
|
497
|
520 retval.resize (nargout ? nargout : 1); |
|
516
|
521 retval(0) = soln, 1; |
|
1
|
522 if (nargout > 1) |
|
516
|
523 retval(1) = objf; |
|
1
|
524 if (nargout > 2) |
|
516
|
525 retval(2) = (double) inform; |
|
1
|
526 if (nargout > 3) |
|
516
|
527 retval(3) = lambda; |
|
1
|
528 |
|
519
|
529 #endif |
|
|
530 |
|
1
|
531 return retval; |
|
|
532 } |
|
|
533 |
|
646
|
534 #ifndef NPSOL_MISSING |
|
|
535 |
|
287
|
536 typedef void (NPSOL_options::*d_set_opt_mf) (double); |
|
|
537 typedef void (NPSOL_options::*i_set_opt_mf) (int); |
|
|
538 typedef double (NPSOL_options::*d_get_opt_mf) (void); |
|
|
539 typedef int (NPSOL_options::*i_get_opt_mf) (void); |
|
|
540 |
|
|
541 #define MAX_TOKENS 5 |
|
|
542 |
|
|
543 struct NPSOL_OPTIONS |
|
|
544 { |
|
540
|
545 const char *keyword; |
|
|
546 const char *kw_tok[MAX_TOKENS + 1]; |
|
287
|
547 int min_len[MAX_TOKENS + 1]; |
|
|
548 int min_toks_to_match; |
|
|
549 d_set_opt_mf d_set_fcn; |
|
|
550 i_set_opt_mf i_set_fcn; |
|
|
551 d_get_opt_mf d_get_fcn; |
|
|
552 i_get_opt_mf i_get_fcn; |
|
|
553 }; |
|
|
554 |
|
497
|
555 static NPSOL_OPTIONS npsol_option_table [] = |
|
287
|
556 { |
|
|
557 { "central difference interval", |
|
519
|
558 { "central", "difference", "interval", 0, 0, 0, }, |
|
287
|
559 { 2, 0, 0, 0, 0, 0, }, 1, |
|
519
|
560 NPSOL_options::set_central_difference_interval, 0, |
|
|
561 NPSOL_options::central_difference_interval, 0, }, |
|
287
|
562 |
|
|
563 { "crash tolerance", |
|
519
|
564 { "crash", "tolerance", 0, 0, 0, 0, }, |
|
287
|
565 { 2, 0, 0, 0, 0, 0, }, 1, |
|
519
|
566 NPSOL_options::set_crash_tolerance, 0, |
|
|
567 NPSOL_options::crash_tolerance, 0, }, |
|
287
|
568 |
|
|
569 { "derivative level", |
|
519
|
570 { "derivative", "level", 0, 0, 0, 0, }, |
|
287
|
571 { 1, 0, 0, 0, 0, 0, }, 1, |
|
519
|
572 0, NPSOL_options::set_derivative_level, |
|
|
573 0, NPSOL_options::derivative_level, }, |
|
287
|
574 |
|
|
575 { "difference interval", |
|
519
|
576 { "difference", "interval", 0, 0, 0, 0, }, |
|
287
|
577 { 3, 0, 0, 0, 0, 0, }, 1, |
|
519
|
578 NPSOL_options::set_difference_interval, 0, |
|
|
579 NPSOL_options::difference_interval, 0, }, |
|
287
|
580 |
|
|
581 { "function precision", |
|
519
|
582 { "function", "precision", 0, 0, 0, 0, }, |
|
287
|
583 { 2, 0, 0, 0, 0, 0, }, 1, |
|
519
|
584 NPSOL_options::set_function_precision, 0, |
|
|
585 NPSOL_options::function_precision, 0, }, |
|
287
|
586 |
|
|
587 { "infinite bound size", |
|
519
|
588 { "infinite", "bound", "size", 0, 0, 0, }, |
|
287
|
589 { 1, 1, 0, 0, 0, 0, }, 2, |
|
519
|
590 NPSOL_options::set_infinite_bound, 0, |
|
|
591 NPSOL_options::infinite_bound, 0, }, |
|
287
|
592 |
|
|
593 { "infinite step size", |
|
519
|
594 { "infinite", "step", "size", 0, 0, 0, }, |
|
287
|
595 { 1, 1, 0, 0, 0, 0, }, 2, |
|
519
|
596 NPSOL_options::set_infinite_step, 0, |
|
|
597 NPSOL_options::infinite_step, 0, }, |
|
287
|
598 |
|
|
599 { "linear feasibility tolerance", |
|
519
|
600 { "linear", "feasibility", "tolerance", 0, 0, 0, }, |
|
287
|
601 { 5, 0, 0, 0, 0, 0, }, 1, |
|
519
|
602 NPSOL_options::set_linear_feasibility_tolerance, 0, |
|
|
603 NPSOL_options::linear_feasibility_tolerance, 0, }, |
|
287
|
604 |
|
|
605 { "linesearch tolerance", |
|
519
|
606 { "linesearch", "tolerance", 0, 0, 0, 0, }, |
|
287
|
607 { 5, 0, 0, 0, 0, 0, }, 1, |
|
519
|
608 NPSOL_options::set_linesearch_tolerance, 0, |
|
|
609 NPSOL_options::linesearch_tolerance, 0, }, |
|
287
|
610 |
|
|
611 { "major iteration limit", |
|
519
|
612 { "major", "iteration", "limit", 0, 0, 0, }, |
|
287
|
613 { 2, 1, 0, 0, 0, 0, }, 2, |
|
519
|
614 0, NPSOL_options::set_major_iteration_limit, |
|
|
615 0, NPSOL_options::major_iteration_limit, }, |
|
287
|
616 |
|
|
617 { "minor iteration limit", |
|
519
|
618 { "minor", "iteration", "limit", 0, 0, 0, }, |
|
287
|
619 { 2, 1, 0, 0, 0, 0, }, 2, |
|
519
|
620 0, NPSOL_options::set_minor_iteration_limit, |
|
|
621 0, NPSOL_options::minor_iteration_limit, }, |
|
287
|
622 |
|
|
623 { "major print level", |
|
519
|
624 { "major", "print", "level", 0, 0, 0, }, |
|
287
|
625 { 2, 1, 0, 0, 0, 0, }, 2, |
|
519
|
626 0, NPSOL_options::set_major_print_level, |
|
|
627 0, NPSOL_options::major_print_level, }, |
|
287
|
628 |
|
|
629 { "minor print level", |
|
519
|
630 { "minor", "print", "level", 0, 0, 0, }, |
|
287
|
631 { 2, 1, 0, 0, 0, 0, }, 2, |
|
519
|
632 0, NPSOL_options::set_minor_print_level, |
|
|
633 0, NPSOL_options::minor_print_level, }, |
|
287
|
634 |
|
|
635 { "nonlinear feasibility tolerance", |
|
519
|
636 { "nonlinear", "feasibility", "tolerance", 0, 0, }, |
|
287
|
637 { 1, 0, 0, 0, 0, 0, }, 1, |
|
519
|
638 NPSOL_options::set_nonlinear_feasibility_tolerance, 0, |
|
|
639 NPSOL_options::nonlinear_feasibility_tolerance, 0, }, |
|
287
|
640 |
|
|
641 { "optimality tolerance", |
|
519
|
642 { "optimality", "tolerance", 0, 0, 0, 0, }, |
|
287
|
643 { 1, 0, 0, 0, 0, 0, }, 1, |
|
519
|
644 NPSOL_options::set_optimality_tolerance, 0, |
|
|
645 NPSOL_options::optimality_tolerance, 0, }, |
|
287
|
646 |
|
|
647 { "start objective check at variable", |
|
519
|
648 { "start", "objective", "check", "at", "variable", 0, }, |
|
287
|
649 { 3, 1, 0, 0, 0, 0, }, 2, |
|
519
|
650 0, NPSOL_options::set_start_objective_check, |
|
|
651 0, NPSOL_options::start_objective_check, }, |
|
287
|
652 |
|
|
653 { "start constraint check at variable", |
|
519
|
654 { "start", "constraint", "check", "at", "variable", 0, }, |
|
287
|
655 { 3, 1, 0, 0, 0, 0, }, 2, |
|
519
|
656 0, NPSOL_options::set_start_constraint_check, |
|
|
657 0, NPSOL_options::start_constraint_check, }, |
|
287
|
658 |
|
|
659 { "stop objective check at variable", |
|
519
|
660 { "stop", "objective", "check", "at", "variable", 0, }, |
|
287
|
661 { 3, 1, 0, 0, 0, 0, }, 2, |
|
519
|
662 0, NPSOL_options::set_stop_objective_check, |
|
|
663 0, NPSOL_options::stop_objective_check, }, |
|
287
|
664 |
|
|
665 { "stop constraint check at variable", |
|
519
|
666 { "stop", "constraint", "check", "at", "variable", 0, }, |
|
287
|
667 { 3, 1, 0, 0, 0, 0, }, 2, |
|
519
|
668 0, NPSOL_options::set_stop_constraint_check, |
|
|
669 0, NPSOL_options::stop_constraint_check, }, |
|
287
|
670 |
|
|
671 { "verify level", |
|
519
|
672 { "verify", "level", 0, 0, 0, 0, }, |
|
287
|
673 { 1, 0, 0, 0, 0, 0, }, 1, |
|
519
|
674 0, NPSOL_options::set_verify_level, |
|
|
675 0, NPSOL_options::verify_level, }, |
|
287
|
676 |
|
519
|
677 { 0, |
|
|
678 { 0, 0, 0, 0, 0, 0, }, |
|
287
|
679 { 0, 0, 0, 0, 0, 0, }, 0, |
|
519
|
680 0, 0, 0, 0, }, |
|
287
|
681 }; |
|
|
682 |
|
|
683 static void |
|
2095
|
684 print_npsol_option_list (ostream& os) |
|
287
|
685 { |
|
|
686 print_usage ("npsol_options", 1); |
|
|
687 |
|
2095
|
688 os << "\n" |
|
|
689 << "Options for npsol include:\n\n" |
|
|
690 << " keyword value\n" |
|
|
691 << " ------- -----\n\n"; |
|
287
|
692 |
|
|
693 NPSOL_OPTIONS *list = npsol_option_table; |
|
|
694 |
|
540
|
695 const char *keyword; |
|
519
|
696 while ((keyword = list->keyword) != 0) |
|
287
|
697 { |
|
2095
|
698 os.form (" %-40s ", keyword); |
|
287
|
699 if (list->d_get_fcn) |
|
|
700 { |
|
|
701 double val = (npsol_opts.*list->d_get_fcn) (); |
|
|
702 if (val < 0.0) |
|
2095
|
703 os << "computed automatically"; |
|
287
|
704 else |
|
2095
|
705 os << val; |
|
287
|
706 } |
|
|
707 else |
|
|
708 { |
|
|
709 int val = (npsol_opts.*list->i_get_fcn) (); |
|
|
710 if (val < 0) |
|
2095
|
711 os << "depends on problem size"; |
|
287
|
712 else |
|
2095
|
713 os << val; |
|
287
|
714 } |
|
2095
|
715 os << "\n"; |
|
287
|
716 list++; |
|
|
717 } |
|
|
718 |
|
2095
|
719 os << "\n"; |
|
287
|
720 } |
|
|
721 |
|
|
722 static void |
|
1755
|
723 set_npsol_option (const string& keyword, double val) |
|
287
|
724 { |
|
|
725 NPSOL_OPTIONS *list = npsol_option_table; |
|
|
726 |
|
519
|
727 while (list->keyword != 0) |
|
287
|
728 { |
|
|
729 if (keyword_almost_match (list->kw_tok, list->min_len, keyword, |
|
|
730 list->min_toks_to_match, MAX_TOKENS)) |
|
|
731 { |
|
|
732 if (list->d_set_fcn) |
|
|
733 (npsol_opts.*list->d_set_fcn) (val); |
|
|
734 else |
|
1086
|
735 { |
|
|
736 if (xisnan (val)) |
|
|
737 { |
|
|
738 error ("npsol_options: %s: expecting integer, found NaN", |
|
1755
|
739 keyword.c_str ()); |
|
1086
|
740 } |
|
|
741 else |
|
|
742 (npsol_opts.*list->i_set_fcn) (NINT (val)); |
|
|
743 } |
|
287
|
744 return; |
|
|
745 } |
|
|
746 list++; |
|
|
747 } |
|
|
748 |
|
1755
|
749 warning ("npsol_options: no match for `%s'", keyword.c_str ()); |
|
287
|
750 } |
|
|
751 |
|
2086
|
752 static octave_value_list |
|
1755
|
753 show_npsol_option (const string& keyword) |
|
1329
|
754 { |
|
2797
|
755 octave_value retval; |
|
1329
|
756 |
|
|
757 NPSOL_OPTIONS *list = npsol_option_table; |
|
|
758 |
|
|
759 while (list->keyword != 0) |
|
|
760 { |
|
|
761 if (keyword_almost_match (list->kw_tok, list->min_len, keyword, |
|
|
762 list->min_toks_to_match, MAX_TOKENS)) |
|
|
763 { |
|
|
764 if (list->d_get_fcn) |
|
2797
|
765 { |
|
|
766 double val = (npsol_opts.*list->d_get_fcn) (); |
|
|
767 if (val < 0.0) |
|
|
768 retval = "computed automatically"; |
|
|
769 else |
|
|
770 retval = val; |
|
|
771 } |
|
1329
|
772 else |
|
2797
|
773 { |
|
|
774 int val = (npsol_opts.*list->i_get_fcn) (); |
|
|
775 if (val < 0) |
|
|
776 retval = "depends on problem size"; |
|
|
777 else |
|
|
778 retval = val; |
|
|
779 } |
|
|
780 |
|
|
781 return retval; |
|
1329
|
782 } |
|
|
783 list++; |
|
|
784 } |
|
|
785 |
|
1755
|
786 warning ("npsol_options: no match for `%s'", keyword.c_str ()); |
|
1329
|
787 |
|
|
788 return retval; |
|
|
789 } |
|
|
790 |
|
646
|
791 #endif |
|
|
792 |
|
519
|
793 #if defined (NPSOL_MISSING) |
|
2465
|
794 DEFUN_DLD (npsol_options, , , |
|
519
|
795 "This function requires NPSOL, which is not freely\n\ |
|
|
796 redistributable. For more information, read the file\n\ |
|
|
797 libcruft/npsol/README.MISSING in the source distribution.") |
|
|
798 #else |
|
2465
|
799 DEFUN_DLD (npsol_options, args, , |
|
519
|
800 "npsol_options (KEYWORD, VALUE)\n\ |
|
|
801 \n\ |
|
|
802 Set or show options for npsol. Keywords may be abbreviated\n\ |
|
|
803 to the shortest match.") |
|
|
804 #endif |
|
272
|
805 { |
|
2086
|
806 octave_value_list retval; |
|
272
|
807 |
|
519
|
808 #if defined (NPSOL_MISSING) |
|
|
809 |
|
|
810 print_usage ("npsol_options"); |
|
|
811 |
|
|
812 #else |
|
|
813 |
|
506
|
814 int nargin = args.length (); |
|
|
815 |
|
712
|
816 if (nargin == 0) |
|
287
|
817 { |
|
2095
|
818 print_npsol_option_list (octave_stdout); |
|
636
|
819 return retval; |
|
287
|
820 } |
|
1329
|
821 else if (nargin == 1 || nargin == 2) |
|
287
|
822 { |
|
1755
|
823 string keyword = args(0).string_value (); |
|
636
|
824 |
|
|
825 if (! error_state) |
|
287
|
826 { |
|
1329
|
827 if (nargin == 1) |
|
|
828 return show_npsol_option (keyword); |
|
|
829 else |
|
|
830 { |
|
|
831 double val = args(1).double_value (); |
|
636
|
832 |
|
1329
|
833 if (! error_state) |
|
|
834 { |
|
|
835 set_npsol_option (keyword, val); |
|
|
836 return retval; |
|
|
837 } |
|
636
|
838 } |
|
287
|
839 } |
|
|
840 } |
|
636
|
841 |
|
|
842 print_usage ("npsol_options"); |
|
287
|
843 |
|
519
|
844 #endif |
|
|
845 |
|
272
|
846 return retval; |
|
|
847 } |
|
|
848 |
|
1
|
849 /* |
|
|
850 ;;; Local Variables: *** |
|
|
851 ;;; mode: C++ *** |
|
|
852 ;;; End: *** |
|
|
853 */ |
