chiark / gitweb /
got plip_ to compile, basic changes for NLopt, no wrapper yet
[nlopt.git] / luksan / plis.c
1 #include <limits.h>
2 #include <stdlib.h>
3 #include <math.h>
4 #include <string.h>
5 #include "luksan.h"
6
7 #define max(a,b) ((a) > (b) ? (a) : (b))
8 #define min(a,b) ((a) < (b) ? (a) : (b))
9
10 /* *********************************************************************** */
11 /* SUBROUTINE PLIS               ALL SYSTEMS                   01/09/22 */
12 /* PURPOSE : */
13 /* GENERAL SUBROUTINE FOR LARGE-SCALE BOX CONSTRAINED MINIMIZATION THAT */
14 /* USE THE LIMITED MEMORY VARIABLE METRIC METHOD BASED ON THE STRANG */
15 /* RECURRENCES. */
16
17 /* PARAMETERS : */
18 /*  II  NF  NUMBER OF VARIABLES. */
19 /*  II  NB  CHOICE OF SIMPLE BOUNDS. NB=0-SIMPLE BOUNDS SUPPRESSED. */
20 /*         NB>0-SIMPLE BOUNDS ACCEPTED. */
21 /*  RI  X(NF)  VECTOR OF VARIABLES. */
22 /*  II  IX(NF)  VECTOR CONTAINING TYPES OF BOUNDS. IX(I)=0-VARIABLE */
23 /*         X(I) IS UNBOUNDED. IX(I)=1-LOVER BOUND XL(I).LE.X(I). */
24 /*         IX(I)=2-UPPER BOUND X(I).LE.XU(I). IX(I)=3-TWO SIDE BOUND */
25 /*         XL(I).LE.X(I).LE.XU(I). IX(I)=5-VARIABLE X(I) IS FIXED. */
26 /*  RI  XL(NF)  VECTOR CONTAINING LOWER BOUNDS FOR VARIABLES. */
27 /*  RI  XU(NF)  VECTOR CONTAINING UPPER BOUNDS FOR VARIABLES. */
28 /*  RO  GF(NF)  GRADIENT OF THE OBJECTIVE FUNCTION. */
29 /*  RO  S(NF)  DIRECTION VECTOR. */
30 /*  RU  XO(NF)  VECTORS OF VARIABLES DIFFERENCE. */
31 /*  RI  GO(NF)  GRADIENTS DIFFERENCE. */
32 /*  RA  UO(NF)  AUXILIARY VECTOR. */
33 /*  RA  VO(NF)  AUXILIARY VECTOR. */
34 /*  RI  XMAX  MAXIMUM STEPSIZE. */
35 /*  RI  TOLX  TOLERANCE FOR CHANGE OF VARIABLES. */
36 /*  RI  TOLF  TOLERANCE FOR CHANGE OF FUNCTION VALUES. */
37 /*  RI  TOLB  TOLERANCE FOR THE FUNCTION VALUE. */
38 /*  RI  TOLG  TOLERANCE FOR THE GRADIENT NORM. */
39 /*  RI  MINF_EST  ESTIMATION OF THE MINIMUM FUNCTION VALUE. */
40 /*  RO  GMAX  MAXIMUM PARTIAL DERIVATIVE. */
41 /*  RO  F  VALUE OF THE OBJECTIVE FUNCTION. */
42 /*  II  MIT  MAXIMUM NUMBER OF ITERATIONS. */
43 /*  II  MFV  MAXIMUM NUMBER OF FUNCTION EVALUATIONS. */
44 /*  II  IEST  ESTIMATION INDICATOR. IEST=0-MINIMUM IS NOT ESTIMATED. */
45 /*         IEST=1-MINIMUM IS ESTIMATED BY THE VALUE MINF_EST. */
46 /*  II  MF  NUMBER OF LIMITED MEMORY STEPS. */
47 /*  IO  ITERM  VARIABLE THAT INDICATES THE CAUSE OF TERMINATION. */
48 /*         ITERM=1-IF ABS(X-XO) WAS LESS THAN OR EQUAL TO TOLX IN */
49 /*                   MTESX (USUALLY TWO) SUBSEQUEBT ITERATIONS. */
50 /*         ITERM=2-IF ABS(F-FO) WAS LESS THAN OR EQUAL TO TOLF IN */
51 /*                   MTESF (USUALLY TWO) SUBSEQUEBT ITERATIONS. */
52 /*         ITERM=3-IF F IS LESS THAN OR EQUAL TO TOLB. */
53 /*         ITERM=4-IF GMAX IS LESS THAN OR EQUAL TO TOLG. */
54 /*         ITERM=6-IF THE TERMINATION CRITERION WAS NOT SATISFIED, */
55 /*                   BUT THE SOLUTION OBTAINED IS PROBABLY ACCEPTABLE. */
56 /*         ITERM=11-IF NIT EXCEEDED MIT. ITERM=12-IF NFV EXCEEDED MFV. */
57 /*         ITERM=13-IF NFG EXCEEDED MFG. ITERM<0-IF THE METHOD FAILED. */
58
59 /* VARIABLES IN COMMON /STAT/ (STATISTICS) : */
60 /*  IO  NRES  NUMBER OF RESTARTS. */
61 /*  IO  NDEC  NUMBER OF MATRIX DECOMPOSITION. */
62 /*  IO  NIN  NUMBER OF INNER ITERATIONS. */
63 /*  IO  NIT  NUMBER OF ITERATIONS. */
64 /*  IO  NFV  NUMBER OF FUNCTION EVALUATIONS. */
65 /*  IO  NFG  NUMBER OF GRADIENT EVALUATIONS. */
66 /*  IO  NFH  NUMBER OF HESSIAN EVALUATIONS. */
67
68 /* SUBPROGRAMS USED : */
69 /*  S   PCBS04  ELIMINATION OF BOX CONSTRAINT VIOLATIONS. */
70 /*  S   PS1L01  STEPSIZE SELECTION USING LINE SEARCH. */
71 /*  S   PYADC0  ADDITION OF A BOX CONSTRAINT. */
72 /*  S   PYFUT1  TEST ON TERMINATION. */
73 /*  S   PYRMC0  DELETION OF A BOX CONSTRAINT. */
74 /*  S   PYTRCD  COMPUTATION OF PROJECTED DIFFERENCES FOR THE VARIABLE METRIC */
75 /*         UPDATE. */
76 /*  S   PYTRCG  COMPUTATION OF THE PROJECTED GRADIENT. */
77 /*  S   PYTRCS  COMPUTATION OF THE PROJECTED DIRECTION VECTOR. */
78 /*  S   MXDRCB BACKWARD PART OF THE STRANG FORMULA FOR PREMULTIPLICATION */
79 /*         OF THE VECTOR X BY AN IMPLICIT BFGS UPDATE. */
80 /*  S   MXDRCF FORWARD PART OF THE STRANG FORMULA FOR PREMULTIPLICATION */
81 /*         OF THE VECTOR X BY AN IMPLICIT BFGS UPDATE. */
82 /*  S   MXDRSU SHIFT OF COLUMNS OF THE RECTANGULAR MATRICES A AND B. */
83 /*         SHIFT OF ELEMENTS OF THE VECTOR U. THESE SHIFTS ARE USED IN */
84 /*         THE LIMITED MEMORY BFGS METHOD. */
85 /*  S   MXUDIR  VECTOR AUGMENTED BY THE SCALED VECTOR. */
86 /*  RF  MXUDOT  DOT PRODUCT OF TWO VECTORS. */
87 /*  S   MXUNEG  COPYING OF A VECTOR WITH CHANGE OF THE SIGN. */
88 /*  S   MXVCOP  COPYING OF A VECTOR. */
89 /*  S   MXVSCL  SCALING OF A VECTOR. */
90
91 /* EXTERNAL SUBROUTINES : */
92 /*  SE  OBJ  COMPUTATION OF THE VALUE OF THE OBJECTIVE FUNCTION. */
93 /*         CALLING SEQUENCE: CALL OBJ(NF,X,FF) WHERE NF IS THE NUMBER */
94 /*         OF VARIABLES, X(NF) IS THE VECTOR OF VARIABLES AND FF IS */
95 /*         THE VALUE OF THE OBJECTIVE FUNCTION. */
96 /*  SE  DOBJ  COMPUTATION OF THE GRADIENT OF THE OBJECTIVE FUNCTION. */
97 /*         CALLING SEQUENCE: CALL DOBJ(NF,X,GF) WHERE NF IS THE NUMBER */
98 /*         OF VARIABLES, X(NF) IS THE VECTOR OF VARIABLES AND GF(NF) */
99 /*         IS THE GRADIENT OF THE OBJECTIVE FUNCTION. */
100 /* -- OBJ and DOBJ are replaced by a single function, objgrad, in NLopt */
101
102 /* METHOD : */
103 /* LIMITED MEMORY VARIABLE METRIC METHOD BASED ON THE STRANG */
104 /* RECURRENCES. */
105
106 static void plis_(int *nf, int *nb, double *x, int *
107                   ix, double *xl, double *xu, double *gf, double *s, 
108                   double *xo, double *go, double *uo, double *vo, 
109                   double *xmax, double *tolx, double *tolf, double *
110                   tolb, double *tolg, nlopt_stopping *stop,
111                   double *minf_est, double *gmax, 
112                   double *f, int *mit, int *mfv, int *iest, int *mf,
113                   int *iterm, stat_common *stat_1,
114                   nlopt_func objgrad, void *objgrad_data)
115 {
116     /* System generated locals */
117     int i__1;
118     double d__1, d__2;
119
120     /* Builtin functions */
121
122     /* Local variables */
123     double a, b;
124     int i__, k, n;
125     double p, r__;
126     int kd, ld;
127     double fo, fp, po, pp, ro, rp;
128     int kbf, mfg;
129     int mes, kit;
130     double alf1, alf2, eta0, eta9, par1, par2;
131     int mes1, mes2, mes3;
132     double eps8, eps9;
133     int mred, iold, nred;
134     double maxf, dmax__;
135     int inew;
136     double told;
137     int ites;
138     double rmin, rmax, umax, tolp, tols;
139     int isys;
140     int ires1, ires2;
141     int iterd, mtesf, ntesf;
142     double gnorm;
143     int iters, irest, inits, kters, maxst;
144     double snorm;
145     int mtesx, ntesx;
146
147 /*     INITIATION */
148
149     /* Parameter adjustments */
150     --vo;
151     --uo;
152     --go;
153     --xo;
154     --s;
155     --gf;
156     --xu;
157     --xl;
158     --ix;
159     --x;
160
161     /* Function Body */
162     kbf = 0;
163     if (*nb > 0) {
164         kbf = 2;
165     }
166     stat_1->nres = 0;
167     stat_1->ndec = 0;
168     stat_1->nin = 0;
169     stat_1->nit = 0;
170     stat_1->nfg = 0;
171     stat_1->nfh = 0;
172     isys = 0;
173     ites = 1;
174     mtesx = 2;
175     mtesf = 2;
176     inits = 2;
177     *iterm = 0;
178     iterd = 0;
179     iters = 2;
180     kters = 3;
181     irest = 0;
182     ires1 = 999;
183     ires2 = 0;
184     mred = 10;
185     mes = 4;
186     mes1 = 2;
187     mes2 = 2;
188     mes3 = 2;
189     eta0 = 1e-15;
190     eta9 = 1e120;
191     eps8 = 1.;
192     eps9 = 1e-8;
193     alf1 = 1e-10;
194     alf2 = 1e10;
195     rmax = eta9;
196     dmax__ = eta9;
197     maxf = 1e20;
198     if (*iest <= 0) {
199          *minf_est = -HUGE_VAL; /* changed from -1e60 by SGJ */
200     }
201     if (*iest > 0) {
202         *iest = 1;
203     }
204     if (*xmax <= 0.) {
205         *xmax = 1e16;
206     }
207     if (*tolx <= 0.) {
208         *tolx = 1e-16;
209     }
210     if (*tolf <= 0.) {
211         *tolf = 1e-14;
212     }
213     if (*tolg <= 0.) {
214          *tolg = 1e-8; /* SGJ: was 1e-6, but this sometimes stops too soon */
215     }
216 #if 0
217     /* removed by SGJ: this check prevented us from using minf_max <= 0,
218        which doesn't make sense.  Instead, if you don't want to have a
219        lower limit, you should set minf_max = -HUGE_VAL */
220     if (*tolb <= 0.) {
221         *tolb = *minf_est + 1e-16;
222     }
223 #endif
224     told = 1e-4;
225     tols = 1e-4;
226     tolp = .8;
227     /* changed by SGJ: default is no limit (INT_MAX) on # iterations/fevals */
228     if (*mit <= 0) {
229         *mit = INT_MAX;
230     }
231     if (*mfv <= 0) {
232         *mfv = INT_MAX;
233     }
234     mfg = *mfv;
235     kd = 1;
236     ld = -1;
237     kit = -(ires1 * *nf + ires2);
238     fo = *minf_est;
239
240 /*     INITIAL OPERATIONS WITH SIMPLE BOUNDS */
241
242     if (kbf > 0) {
243         i__1 = *nf;
244         for (i__ = 1; i__ <= i__1; ++i__) {
245             if ((ix[i__] == 3 || ix[i__] == 4) && xu[i__] <= xl[i__]) {
246                 xu[i__] = xl[i__];
247                 ix[i__] = 5;
248             } else if (ix[i__] == 5 || ix[i__] == 6) {
249                 xl[i__] = x[i__];
250                 xu[i__] = x[i__];
251                 ix[i__] = 5;
252             }
253 /* L2: */
254         }
255         luksan_pcbs04__(nf, &x[1], &ix[1], &xl[1], &xu[1], &eps9, &kbf);
256         luksan_pyadc0__(nf, &n, &x[1], &ix[1], &xl[1], &xu[1], &inew);
257     }
258     if (*iterm != 0) {
259         goto L11190;
260     }
261     *f = objgrad(*nf, &x[1], &gf[1], objgrad_data);
262     ++stop->nevals;
263     ++stat_1->nfg;
264 L11120:
265     luksan_pytrcg__(nf, nf, &ix[1], &gf[1], &umax, gmax, &kbf, &iold);
266     luksan_pyfut1__(nf, f, &fo, &umax, gmax, &dmax__, tolx, tolf, tolb, tolg, 
267             &kd, &stat_1->nit, &kit, mit, &stop->nevals, mfv, &stat_1->nfg, &mfg, 
268             &ntesx, &mtesx, &ntesf, &mtesf, &ites, &ires1, &ires2, &irest, &
269             iters, iterm);
270     if (*iterm != 0) {
271         goto L11190;
272     }
273     if (nlopt_stop_time(stop)) { *iterm = 100; goto L11190; }
274     if (kbf > 0 && rmax > 0.) {
275         luksan_pyrmc0__(nf, &n, &ix[1], &gf[1], &eps8, &umax, gmax, &rmax, &
276                 iold, &irest);
277     }
278 L11130:
279
280 /*     DIRECTION DETERMINATION */
281
282     gnorm = sqrt(luksan_mxudot__(nf, &gf[1], &gf[1], &ix[1], &kbf));
283     if (irest != 0) {
284         goto L12620;
285     }
286 /* Computing MIN */
287     i__1 = stat_1->nit - kit;
288     k = min(i__1,*mf);
289     if (k <= 0) {
290         irest = max(irest,1);
291         goto L12620;
292     }
293
294 /*     DETERMINATION OF THE PARAMETER B */
295
296     b = luksan_mxudot__(nf, &xo[1], &go[1], &ix[1], &kbf);
297     if (b <= 0.) {
298         irest = max(irest,1);
299         goto L12620;
300     }
301     uo[1] = 1. / b;
302     luksan_mxuneg__(nf, &gf[1], &s[1], &ix[1], &kbf);
303     luksan_mxdrcb__(nf, &k, &xo[1], &go[1], &uo[1], &vo[1], &s[1], &ix[1], &
304             kbf);
305     a = luksan_mxudot__(nf, &go[1], &go[1], &ix[1], &kbf);
306     if (a > 0.) {
307         d__1 = b / a;
308         luksan_mxvscl__(nf, &d__1, &s[1], &s[1]);
309     }
310     luksan_mxdrcf__(nf, &k, &xo[1], &go[1], &uo[1], &vo[1], &s[1], &ix[1], &
311             kbf);
312     snorm = sqrt(luksan_mxudot__(nf, &s[1], &s[1], &ix[1], &kbf));
313 /* Computing MIN */
314     i__1 = k + 1;
315     k = min(i__1,*mf);
316     luksan_mxdrsu__(nf, &k, &xo[1], &go[1], &uo[1]);
317 L12620:
318     iterd = 0;
319     if (irest != 0) {
320
321 /*     STEEPEST DESCENT DIRECTION */
322
323         luksan_mxuneg__(nf, &gf[1], &s[1], &ix[1], &kbf);
324         snorm = gnorm;
325         if (kit < stat_1->nit) {
326             ++stat_1->nres;
327             kit = stat_1->nit;
328         } else {
329              *iterm = -10;
330             if (iters < 0) {
331                 *iterm = iters - 5;
332             }
333         }
334     }
335
336 /*     TEST ON DESCENT DIRECTION AND PREPARATION OF LINE SEARCH */
337
338     if (kd > 0) {
339         p = luksan_mxudot__(nf, &gf[1], &s[1], &ix[1], &kbf);
340     }
341     if (iterd < 0) {
342         *iterm = iterd;
343     } else {
344
345 /*     TEST ON DESCENT DIRECTION */
346
347         if (snorm <= 0.) {
348             irest = max(irest,1);
349         } else if (p + told * gnorm * snorm <= 0.) {
350             irest = 0;
351         } else {
352
353 /*     UNIFORM DESCENT CRITERION */
354
355             irest = max(irest,1);
356         }
357         if (irest == 0) {
358
359 /*     PREPARATION OF LINE SEARCH */
360
361             nred = 0;
362             rmin = alf1 * gnorm / snorm;
363 /* Computing MIN */
364             d__1 = alf2 * gnorm / snorm, d__2 = *xmax / snorm;
365             rmax = min(d__1,d__2);
366         }
367     }
368     if (*iterm != 0) {
369         goto L11190;
370     }
371     if (irest != 0) {
372         goto L11130;
373     }
374     luksan_pytrcs__(nf, &x[1], &ix[1], &xo[1], &xl[1], &xu[1], &gf[1], &go[1],
375              &s[1], &ro, &fp, &fo, f, &po, &p, &rmax, &eta9, &kbf);
376     if (rmax == 0.) {
377         goto L11175;
378     }
379 L11170:
380     luksan_ps1l01__(&r__, &rp, f, &fo, &fp, &p, &po, &pp, minf_est, &maxf, &rmin, 
381             &rmax, &tols, &tolp, &par1, &par2, &kd, &ld, &stat_1->nit, &kit, &
382             nred, &mred, &maxst, iest, &inits, &iters, &kters, &mes, &isys);
383     if (isys == 0) {
384         goto L11174;
385     }
386     luksan_mxudir__(nf, &r__, &s[1], &xo[1], &x[1], &ix[1], &kbf);
387     luksan_pcbs04__(nf, &x[1], &ix[1], &xl[1], &xu[1], &eps9, &kbf);
388     *f = objgrad(*nf, &x[1], &gf[1], objgrad_data);
389     ++stop->nevals;
390     ++stat_1->nfg;
391     p = luksan_mxudot__(nf, &gf[1], &s[1], &ix[1], &kbf);
392     goto L11170;
393 L11174:
394     if (iters <= 0) {
395         r__ = 0.;
396         *f = fo;
397         p = po;
398         luksan_mxvcop__(nf, &xo[1], &x[1]);
399         luksan_mxvcop__(nf, &go[1], &gf[1]);
400         irest = max(irest,1);
401         ld = kd;
402         goto L11130;
403     }
404     luksan_pytrcd__(nf, &x[1], &ix[1], &xo[1], &gf[1], &go[1], &r__, f, &fo, &
405             p, &po, &dmax__, &kbf, &kd, &ld, &iters);
406 L11175:
407     if (kbf > 0) {
408         luksan_mxvine__(nf, &ix[1]);
409         luksan_pyadc0__(nf, &n, &x[1], &ix[1], &xl[1], &xu[1], &inew);
410     }
411     goto L11120;
412 L11190:
413     return;
414 } /* plis_ */
415
416 /* number of double variables that can be stored in scratch memory
417    ... it's >= 2007, and this is in the context of scientific computation,
418    so assume that at least 10M are available, and that sizeof(double)==8 */
419 #define MEMAVAIL 1310720
420
421 /* NLopt wrapper around plis_, handling dynamic allocation etc. */
422 nlopt_result luksan_plis(int n, nlopt_func f, void *f_data,
423                   const double *lb, const double *ub, /* bounds */
424                   double *x, /* in: initial guess, out: minimizer */
425                   double *minf,
426                   nlopt_stopping *stop)
427 {
428      int i, *ix;
429      double *work, *xl, *xu, *xo, *gf, *s, *go, *uo, *vo;
430      double gmax, minf_est;
431      double xmax = 0; /* no maximum */
432      double tolg = 0; /* default gradient tolerance */
433      int iest = 0; /* we have no estimate of min function value */
434      int mit = 0; /* default no limit on #iterations */
435      int mfv = stop->maxeval;
436      stat_common stat;
437      int iterm;
438      int mf;
439
440      ix = (int*) malloc(sizeof(int) * n);
441      if (!ix) return NLOPT_OUT_OF_MEMORY;
442
443      /* FIXME: what should we set mf to?  The example program tlis.for
444         sets it to zero as far as I can tell, but it seems to greatly
445         improve convergence to make it > 0.  The computation time
446         per iteration, and of course the memory, seem to go as O(n * mf),
447         and we'll assume that the main limiting factor is the memory.
448         We'll assume that at least MEMAVAIL memory, or 4*n memory, whichever
449         is bigger, is available. */
450      mf = max(MEMAVAIL/n, 4);
451      if (stop->maxeval && stop->maxeval <= mf)
452           mf = max(stop->maxeval - 5, 1); /* mf > maxeval seems not good */
453
454  retry_alloc:
455      work = (double*) malloc(sizeof(double) * (n * 4 + max(n,n*mf)*2 + 
456                                                max(n,mf)*2));
457      if (!work) { 
458           if (mf > 0) {
459                mf /= 4;
460                goto retry_alloc;
461           }
462           free(ix);
463           return NLOPT_OUT_OF_MEMORY;
464      }
465
466      xl = work; xu = xl + n; gf = xu + n; s = gf + n; 
467      xo = s + n; go = xo + max(n,n*mf);
468      uo = go + max(n,n*mf); vo = uo + max(n,mf);
469
470      for (i = 0; i < n; ++i) {
471           int lbu = lb[i] <= -0.99 * HUGE_VAL; /* lb unbounded */
472           int ubu = ub[i] >= 0.99 * HUGE_VAL;  /* ub unbounded */
473           ix[i] = lbu ? (ubu ? 0 : 2) : (ubu ? 1 : (lb[i] == ub[i] ? 5 : 3));
474           xl[i] = lb[i];
475           xu[i] = ub[i];
476      }
477
478      /* ?  xo does not seem to be initialized in the
479         original Fortran code, but it is used upon
480         input to plis if mf > 0 ... perhaps ALLOCATE initializes
481         arrays to zero by default? */
482      memset(xo, 0, sizeof(double) * max(n,n*mf));
483
484      plis_(&n, &n, x, ix, xl, xu, 
485            gf, s, xo, go, uo, vo,
486            &xmax,
487
488            /* fixme: pass tol_rel and tol_abs and use NLopt check */
489            &stop->xtol_rel,
490            &stop->ftol_rel,
491            &stop->minf_max,
492            &tolg,
493            stop,
494
495            &minf_est, &gmax,
496            minf,
497            &mit, &mfv,
498            &iest,
499            &mf,
500            &iterm, &stat,
501            f, f_data);
502
503      free(work);
504      free(ix);
505
506      switch (iterm) {
507          case 1: return NLOPT_XTOL_REACHED;
508          case 2: return NLOPT_FTOL_REACHED;
509          case 3: return NLOPT_MINF_MAX_REACHED;
510          case 4: return NLOPT_SUCCESS; /* gradient tolerance reached */
511          case 6: return NLOPT_SUCCESS;
512          case 12: case 13: return NLOPT_MAXEVAL_REACHED;
513          default: return NLOPT_FAILURE;
514      }
515 }