|
7
|
1 // f-npsol.cc -*- C++ -*- |
|
1
|
2 /* |
|
|
3 |
|
|
4 Copyright (C) 1993 John W. Eaton |
|
|
5 |
|
|
6 This file is part of Octave. |
|
|
7 |
|
|
8 Octave is free software; you can redistribute it and/or modify it |
|
|
9 under the terms of the GNU General Public License as published by the |
|
|
10 Free Software Foundation; either version 2, or (at your option) any |
|
|
11 later version. |
|
|
12 |
|
|
13 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
16 for more details. |
|
|
17 |
|
|
18 You should have received a copy of the GNU General Public License |
|
|
19 along with Octave; see the file COPYING. If not, write to the Free |
|
|
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
240
|
24 #ifdef HAVE_CONFIG_H |
|
|
25 #include "config.h" |
|
1
|
26 #endif |
|
|
27 |
|
|
28 #ifndef NPSOL_MISSING |
|
|
29 |
|
|
30 #include "NPSOL.h" |
|
|
31 |
|
|
32 #include "tree-const.h" |
|
|
33 #include "variables.h" |
|
|
34 #include "gripes.h" |
|
|
35 #include "error.h" |
|
|
36 #include "utils.h" |
|
7
|
37 #include "f-npsol.h" |
|
1
|
38 |
|
|
39 // Global pointers for user defined functions required by npsol. |
|
|
40 static tree *npsol_objective; |
|
|
41 static tree *npsol_constraints; |
|
|
42 |
|
|
43 #ifdef WITH_DLD |
|
|
44 tree_constant * |
|
162
|
45 builtin_npsol_2 (const tree_constant *args, int nargin, int nargout) |
|
1
|
46 { |
|
|
47 return npsol (args, nargin, nargout); |
|
|
48 } |
|
272
|
49 |
|
|
50 tree_constant * |
|
|
51 builtin_npsol_options_2 (const tree_constant *args, int nargin, int nargout) |
|
|
52 { |
|
|
53 return npsol_options (args, nargin, nargout); |
|
|
54 } |
|
1
|
55 #endif |
|
|
56 |
|
|
57 double |
|
162
|
58 npsol_objective_function (const ColumnVector& x) |
|
1
|
59 { |
|
|
60 int n = x.capacity (); |
|
|
61 |
|
|
62 tree_constant decision_vars; |
|
|
63 if (n > 1) |
|
|
64 { |
|
|
65 Matrix m (n, 1); |
|
|
66 for (int i = 0; i < n; i++) |
|
|
67 m (i, 0) = x.elem (i); |
|
|
68 decision_vars = tree_constant (m); |
|
|
69 } |
|
|
70 else |
|
|
71 { |
|
|
72 double d = x.elem (0); |
|
|
73 decision_vars = tree_constant (d); |
|
|
74 } |
|
|
75 |
|
|
76 // tree_constant name = tree_constant (npsol_objective->name ()); |
|
|
77 tree_constant *args = new tree_constant [2]; |
|
|
78 // args[0] = name; |
|
|
79 args[1] = decision_vars; |
|
|
80 |
|
255
|
81 static double retval; |
|
|
82 retval = 0.0; |
|
|
83 |
|
1
|
84 tree_constant objective_value; |
|
|
85 if (npsol_objective != NULL_TREE) |
|
|
86 { |
|
|
87 tree_constant *tmp = npsol_objective->eval (args, 2, 1, 0); |
|
255
|
88 |
|
1
|
89 delete [] args; |
|
255
|
90 |
|
|
91 if (error_state) |
|
|
92 { |
|
|
93 error ("npsol: error evaluating objective function"); |
|
|
94 npsol_objective_error = 1; // XXX FIXME XXX |
|
260
|
95 delete [] tmp; |
|
255
|
96 return retval; |
|
|
97 } |
|
|
98 |
|
1
|
99 if (tmp != NULL_TREE_CONST && tmp[0].is_defined ()) |
|
|
100 { |
|
|
101 objective_value = tmp[0]; |
|
|
102 delete [] tmp; |
|
|
103 } |
|
|
104 else |
|
|
105 { |
|
|
106 delete [] tmp; |
|
158
|
107 error ("npsol: error evaluating objective function"); |
|
255
|
108 npsol_objective_error = 1; // XXX FIXME XXX |
|
|
109 return retval; |
|
1
|
110 } |
|
|
111 } |
|
|
112 |
|
|
113 switch (objective_value.const_type ()) |
|
|
114 { |
|
|
115 case tree_constant_rep::matrix_constant: |
|
|
116 { |
|
|
117 Matrix m = objective_value.matrix_value (); |
|
|
118 if (m.rows () == 1 && m.columns () == 1) |
|
|
119 retval = m.elem (0, 0); |
|
|
120 else |
|
255
|
121 { |
|
|
122 gripe_user_returned_invalid ("npsol_objective"); |
|
|
123 npsol_objective_error = 1; // XXX FIXME XXX |
|
|
124 } |
|
1
|
125 } |
|
|
126 break; |
|
|
127 case tree_constant_rep::scalar_constant: |
|
|
128 retval = objective_value.double_value (); |
|
|
129 break; |
|
|
130 default: |
|
|
131 gripe_user_returned_invalid ("npsol_objective"); |
|
255
|
132 npsol_objective_error = 1; // XXX FIXME XXX |
|
1
|
133 break; |
|
|
134 } |
|
|
135 |
|
|
136 return retval; |
|
|
137 } |
|
|
138 |
|
|
139 ColumnVector |
|
162
|
140 npsol_constraint_function (const ColumnVector& x) |
|
1
|
141 { |
|
|
142 ColumnVector retval; |
|
|
143 |
|
|
144 int n = x.capacity (); |
|
|
145 |
|
|
146 tree_constant decision_vars; |
|
|
147 if (n > 1) |
|
|
148 { |
|
|
149 Matrix m (n, 1); |
|
|
150 for (int i = 0; i < n; i++) |
|
|
151 m (i, 0) = x.elem (i); |
|
|
152 decision_vars = tree_constant (m); |
|
|
153 } |
|
|
154 else |
|
|
155 { |
|
|
156 double d = x.elem (0); |
|
|
157 decision_vars = tree_constant (d); |
|
|
158 } |
|
|
159 |
|
|
160 // tree_constant name = tree_constant (npsol_constraints->name ()); |
|
|
161 tree_constant *args = new tree_constant [2]; |
|
|
162 // args[0] = name; |
|
|
163 args[1] = decision_vars; |
|
|
164 |
|
|
165 if (npsol_constraints != NULL_TREE) |
|
|
166 { |
|
|
167 tree_constant *tmp = npsol_constraints->eval (args, 2, 1, 0); |
|
255
|
168 |
|
1
|
169 delete [] args; |
|
255
|
170 |
|
|
171 if (error_state) |
|
|
172 { |
|
260
|
173 delete [] tmp; |
|
255
|
174 error ("npsol: error evaluating constraints"); |
|
|
175 return retval; |
|
|
176 } |
|
|
177 |
|
1
|
178 if (tmp != NULL_TREE_CONST && tmp[0].is_defined ()) |
|
|
179 { |
|
|
180 retval = tmp[0].to_vector (); |
|
255
|
181 |
|
1
|
182 delete [] tmp; |
|
255
|
183 |
|
|
184 if (retval.length () <= 0) |
|
|
185 error ("npsol: error evaluating constraints"); |
|
1
|
186 } |
|
|
187 else |
|
|
188 { |
|
|
189 delete [] tmp; |
|
158
|
190 error ("npsol: error evaluating constraints"); |
|
1
|
191 } |
|
|
192 } |
|
|
193 |
|
|
194 return retval; |
|
|
195 } |
|
|
196 |
|
|
197 int |
|
|
198 linear_constraints_ok (const ColumnVector& x, const ColumnVector& llb, |
|
|
199 const Matrix& c, const ColumnVector& lub, |
|
|
200 char *warn_for, int warn) |
|
|
201 { |
|
|
202 int x_len = x.capacity (); |
|
|
203 int llb_len = llb.capacity (); |
|
|
204 int lub_len = lub.capacity (); |
|
|
205 int c_rows = c.rows (); |
|
|
206 int c_cols = c.columns (); |
|
|
207 |
|
132
|
208 int ok = 1; |
|
|
209 if (warn) |
|
|
210 { |
|
|
211 if (c_rows == 0 || c_cols == 0 || llb_len == 0 || lub_len == 0) |
|
|
212 { |
|
|
213 ok = 0; |
|
158
|
214 error ("%s: linear constraints must have nonzero dimensions", |
|
|
215 warn_for); |
|
132
|
216 } |
|
|
217 else if (x_len != c_cols || llb_len != lub_len || llb_len != c_rows) |
|
|
218 { |
|
|
219 ok = 0; |
|
158
|
220 error ("%s: linear constraints have inconsistent dimensions", |
|
|
221 warn_for); |
|
132
|
222 } |
|
|
223 } |
|
1
|
224 |
|
|
225 return ok; |
|
|
226 } |
|
|
227 |
|
|
228 int |
|
|
229 nonlinear_constraints_ok (const ColumnVector& x, const ColumnVector& nllb, |
|
|
230 nonlinear_fcn g, const ColumnVector& nlub, |
|
|
231 char *warn_for, int warn) |
|
|
232 { |
|
|
233 int nllb_len = nllb.capacity (); |
|
|
234 int nlub_len = nlub.capacity (); |
|
|
235 ColumnVector c = (*g) (x); |
|
|
236 int c_len = c.capacity (); |
|
|
237 |
|
132
|
238 int ok = 1; |
|
|
239 if (warn) |
|
|
240 { |
|
|
241 if (nllb_len == 0 || nlub_len == 0 || c_len == 0) |
|
|
242 { |
|
|
243 ok = 0; |
|
158
|
244 error ("%s: nonlinear constraints have nonzero dimensions", |
|
|
245 warn_for); |
|
132
|
246 } |
|
|
247 else if (nllb_len != nlub_len || nllb_len != c_len) |
|
|
248 { |
|
|
249 ok = 0; |
|
162
|
250 error ("%s: nonlinear constraints have inconsistent dimensions", |
|
|
251 warn_for); |
|
132
|
252 } |
|
135
|
253 } |
|
1
|
254 return ok; |
|
|
255 } |
|
|
256 |
|
|
257 tree_constant * |
|
162
|
258 npsol (const tree_constant *args, int nargin, int nargout) |
|
1
|
259 { |
|
|
260 /* |
|
|
261 |
|
|
262 Handle all of the following: |
|
|
263 |
|
|
264 1. npsol (x, phi) |
|
|
265 2. npsol (x, phi, lb, ub) |
|
|
266 3. npsol (x, phi, lb, ub, llb, c, lub) |
|
|
267 4. npsol (x, phi, lb, ub, llb, c, lub, nllb, g, nlub) |
|
|
268 5. npsol (x, phi, lb, ub, nllb, g, nlub) |
|
|
269 6. npsol (x, phi, llb, c, lub, nllb, g, nlub) |
|
|
270 7. npsol (x, phi, llb, c, lub) |
|
|
271 8. npsol (x, phi, nllb, g, nlub) |
|
|
272 |
|
|
273 */ |
|
|
274 |
|
|
275 // Assumes that we have been given the correct number of arguments. |
|
|
276 |
|
|
277 tree_constant *retval = NULL_TREE_CONST; |
|
|
278 |
|
|
279 ColumnVector x = args[1].to_vector (); |
|
|
280 |
|
|
281 if (x.capacity () == 0) |
|
|
282 { |
|
158
|
283 error ("npsol: expecting vector as first argument"); |
|
1
|
284 return retval; |
|
|
285 } |
|
|
286 |
|
|
287 npsol_objective = is_valid_function (args[2], "npsol", 1); |
|
|
288 if (npsol_objective == NULL_TREE |
|
|
289 || takes_correct_nargs (npsol_objective, 2, "npsol", 1) != 1) |
|
|
290 return retval; |
|
|
291 |
|
|
292 Objective func (npsol_objective_function); |
|
|
293 |
|
|
294 ColumnVector soln; |
|
|
295 |
|
|
296 Bounds bounds; |
|
|
297 if (nargin == 5 || nargin == 8 || nargin == 11) |
|
|
298 { |
|
|
299 ColumnVector lb = args[3].to_vector (); |
|
|
300 ColumnVector ub = args[4].to_vector (); |
|
|
301 |
|
|
302 int lb_len = lb.capacity (); |
|
|
303 int ub_len = ub.capacity (); |
|
|
304 if (lb_len != ub_len || lb_len != x.capacity ()) |
|
|
305 { |
|
214
|
306 error ("npsol: lower and upper bounds and decision variable vector"); |
|
|
307 error ("must all have the same number of elements"); |
|
1
|
308 return retval; |
|
|
309 } |
|
|
310 |
|
|
311 bounds.resize (lb_len); |
|
|
312 bounds.set_lower_bounds (lb); |
|
|
313 bounds.set_upper_bounds (ub); |
|
|
314 } |
|
|
315 |
|
|
316 double objf; |
|
|
317 ColumnVector lambda; |
|
|
318 int inform; |
|
|
319 |
|
|
320 if (nargin == 3) |
|
|
321 { |
|
|
322 // 1. npsol (x, phi) |
|
|
323 |
|
|
324 NPSOL nlp (x, func); |
|
|
325 soln = nlp.minimize (objf, inform, lambda); |
|
|
326 |
|
|
327 goto solved; |
|
|
328 } |
|
|
329 |
|
|
330 if (nargin == 5) |
|
|
331 { |
|
|
332 // 2. npsol (x, phi, lb, ub) |
|
|
333 |
|
|
334 NPSOL nlp (x, func, bounds); |
|
|
335 soln = nlp.minimize (objf, inform, lambda); |
|
|
336 |
|
|
337 goto solved; |
|
|
338 } |
|
|
339 |
|
|
340 npsol_constraints = NULL_TREE; |
|
|
341 if (nargin == 6 || nargin == 8 || nargin == 9 || nargin == 11) |
|
|
342 npsol_constraints = is_valid_function (args[nargin-2], "npsol", 0); |
|
|
343 |
|
|
344 if (nargin == 8 || nargin == 6) |
|
|
345 { |
|
|
346 if (npsol_constraints == NULL_TREE) |
|
|
347 { |
|
|
348 ColumnVector lub = args[nargin-1].to_vector (); |
|
|
349 Matrix c = args[nargin-2].to_matrix (); |
|
|
350 ColumnVector llb = args[nargin-3].to_vector (); |
|
|
351 |
|
215
|
352 if (llb.capacity () == 0 || lub.capacity () == 0) |
|
|
353 { |
|
|
354 error ("npsol: bounds for linear constraints must be vectors"); |
|
|
355 return retval; |
|
|
356 } |
|
1
|
357 |
|
|
358 if (! linear_constraints_ok (x, llb, c, lub, "npsol", 1)) |
|
|
359 return retval; |
|
|
360 |
|
215
|
361 LinConst linear_constraints (llb, c, lub); |
|
|
362 |
|
1
|
363 if (nargin == 6) |
|
|
364 { |
|
|
365 // 7. npsol (x, phi, llb, c, lub) |
|
|
366 |
|
|
367 NPSOL nlp (x, func, linear_constraints); |
|
|
368 soln = nlp.minimize (objf, inform, lambda); |
|
|
369 } |
|
|
370 else |
|
|
371 { |
|
|
372 // 3. npsol (x, phi, lb, ub, llb, c, lub) |
|
|
373 |
|
|
374 NPSOL nlp (x, func, bounds, linear_constraints); |
|
|
375 soln = nlp.minimize (objf, inform, lambda); |
|
|
376 } |
|
|
377 goto solved; |
|
|
378 } |
|
|
379 else |
|
|
380 { |
|
|
381 if (takes_correct_nargs (npsol_constraints, 2, "npsol", 1)) |
|
|
382 { |
|
|
383 ColumnVector nlub = args[nargin-1].to_vector (); |
|
|
384 ColumnVector nllb = args[nargin-3].to_vector (); |
|
|
385 |
|
|
386 NLFunc const_func (npsol_constraint_function); |
|
|
387 |
|
|
388 if (! nonlinear_constraints_ok |
|
|
389 (x, nllb, npsol_constraint_function, nlub, "npsol", 1)) |
|
|
390 return retval; |
|
|
391 |
|
|
392 NLConst nonlinear_constraints (nllb, const_func, nlub); |
|
|
393 |
|
|
394 if (nargin == 6) |
|
|
395 { |
|
|
396 // 8. npsol (x, phi, nllb, g, nlub) |
|
|
397 |
|
|
398 NPSOL nlp (x, func, nonlinear_constraints); |
|
|
399 soln = nlp.minimize (objf, inform, lambda); |
|
|
400 } |
|
|
401 else |
|
|
402 { |
|
|
403 // 5. npsol (x, phi, lb, ub, nllb, g, nlub) |
|
|
404 |
|
|
405 NPSOL nlp (x, func, bounds, nonlinear_constraints); |
|
|
406 soln = nlp.minimize (objf, inform, lambda); |
|
|
407 } |
|
|
408 goto solved; |
|
|
409 } |
|
|
410 } |
|
|
411 } |
|
|
412 |
|
|
413 if (nargin == 9 || nargin == 11) |
|
|
414 { |
|
|
415 if (npsol_constraints == NULL_TREE) |
|
|
416 { |
|
|
417 // Produce error message. |
|
|
418 is_valid_function (args[nargin-2], "npsol", 1); |
|
|
419 } |
|
|
420 else |
|
|
421 { |
|
|
422 if (takes_correct_nargs (npsol_constraints, 2, "npsol", 1)) |
|
|
423 { |
|
|
424 ColumnVector nlub = args[nargin-1].to_vector (); |
|
|
425 ColumnVector nllb = args[nargin-3].to_vector (); |
|
|
426 |
|
|
427 NLFunc const_func (npsol_constraint_function); |
|
|
428 |
|
|
429 if (! nonlinear_constraints_ok |
|
|
430 (x, nllb, npsol_constraint_function, nlub, "npsol", 1)) |
|
|
431 return retval; |
|
|
432 |
|
|
433 NLConst nonlinear_constraints (nllb, const_func, nlub); |
|
|
434 |
|
|
435 ColumnVector lub = args[nargin-4].to_vector (); |
|
|
436 Matrix c = args[nargin-5].to_matrix (); |
|
|
437 ColumnVector llb = args[nargin-6].to_vector (); |
|
|
438 |
|
215
|
439 if (llb.capacity () == 0 || lub.capacity () == 0) |
|
|
440 { |
|
|
441 error ("npsol: bounds for linear constraints must be vectors"); |
|
|
442 return retval; |
|
|
443 } |
|
|
444 |
|
1
|
445 if (! linear_constraints_ok (x, llb, c, lub, "npsol", 1)) |
|
|
446 return retval; |
|
|
447 |
|
|
448 LinConst linear_constraints (llb, c, lub); |
|
|
449 |
|
|
450 if (nargin == 9) |
|
|
451 { |
|
|
452 // 6. npsol (x, phi, llb, c, lub, nllb, g, nlub) |
|
|
453 |
|
|
454 NPSOL nlp (x, func, linear_constraints, |
|
|
455 nonlinear_constraints); |
|
|
456 |
|
|
457 soln = nlp.minimize (objf, inform, lambda); |
|
|
458 } |
|
|
459 else |
|
|
460 { |
|
|
461 // 4. npsol (x, phi, lb, ub, llb, c, lub, nllb, g, nlub) |
|
|
462 |
|
|
463 NPSOL nlp (x, func, bounds, linear_constraints, |
|
|
464 nonlinear_constraints); |
|
|
465 |
|
|
466 soln = nlp.minimize (objf, inform, lambda); |
|
|
467 } |
|
|
468 goto solved; |
|
|
469 } |
|
|
470 } |
|
|
471 } |
|
|
472 |
|
|
473 return retval; |
|
|
474 |
|
|
475 solved: |
|
|
476 |
|
|
477 retval = new tree_constant [nargout+1]; |
|
|
478 retval[0] = tree_constant (soln, 1); |
|
|
479 if (nargout > 1) |
|
|
480 retval[1] = tree_constant (objf); |
|
|
481 if (nargout > 2) |
|
|
482 retval[2] = tree_constant ((double) inform); |
|
|
483 if (nargout > 3) |
|
|
484 retval[3] = tree_constant (lambda); |
|
|
485 |
|
|
486 return retval; |
|
|
487 } |
|
|
488 |
|
272
|
489 tree_constant * |
|
|
490 npsol_options (const tree_constant *args, int nargin, int nargout) |
|
|
491 { |
|
|
492 // Assumes that we have been given the correct number of arguments. |
|
|
493 |
|
|
494 tree_constant *retval = NULL_TREE_CONST; |
|
|
495 error ("npsol_options: not implemented yet"); |
|
|
496 return retval; |
|
|
497 } |
|
|
498 |
|
1
|
499 #endif |
|
|
500 |
|
|
501 /* |
|
|
502 ;;; Local Variables: *** |
|
|
503 ;;; mode: C++ *** |
|
|
504 ;;; page-delimiter: "^/\\*" *** |
|
|
505 ;;; End: *** |
|
|
506 */ |
