Fix/remove improper printf style formats
[openmx:openmx.git] / src / omxHessianCalculation.cpp
1 /*
2  *  Copyright 2007-2013 The OpenMx Project
3  *
4  *  Licensed under the Apache License, Version 2.0 (the "License");
5  *  you may not use this file except in compliance with the License.
6  *  You may obtain a copy of the License at
7  *
8  *       http://www.apache.org/licenses/LICENSE-2.0
9  *
10  *   Unless required by applicable law or agreed to in writing, software
11  *   distributed under the License is distributed on an "AS IS" BASIS,
12  *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  *  See the License for the specific language governing permissions and
14  *  limitations under the License.
15  */
16
17 /**
18  * Based on:
19  *
20  * Paul Gilbert and Ravi Varadhan (2012). numDeriv: Accurate Numerical Derivatives. R package
21  * version 2012.9-1. http://CRAN.R-project.org/package=numDeriv
22  *
23  **/
24
25 #include <stdio.h>
26 #include <sys/types.h>
27 #include <errno.h>
28
29 #include <R.h>
30 #include <Rinternals.h>
31 #include <Rdefines.h>
32 #include <R_ext/Rdynload.h>
33 #include <R_ext/BLAS.h>
34 #include <R_ext/Lapack.h>
35
36 #include "omxDefines.h"
37 #include "npsolWrap.h"
38 #include "omxState.h"
39 #include "omxMatrix.h"
40 #include "omxAlgebra.h"
41 #include "omxFitFunction.h"
42 #include "omxNPSOLSpecific.h"
43 #include "omxOpenmpWrap.h"
44 #include "omxExportBackendState.h"
45 #include "Compute.h"
46
47 class omxComputeEstimatedHessian : public omxCompute {
48         typedef omxCompute super;
49         double stepSize;
50         int numIter;
51         bool wantSE;
52
53         FitContext *fitContext;
54         omxMatrix *fitMat;
55         double minimum;
56         int numParams;
57         double *optima;
58         double *gradient;
59         double *hessian;
60
61         // move to FitContext? TODO
62         SEXP calculatedHessian;
63         SEXP stdErrors;
64
65         void init();
66         void omxPopulateHessianWork(struct hess_struct *hess_work, omxState* state);
67         void omxEstimateHessianOnDiagonal(int i, struct hess_struct* hess_work);
68         void omxEstimateHessianOffDiagonal(int i, int l, struct hess_struct* hess_work);
69         void doHessianCalculation(int numChildren, struct hess_struct *hess_work);
70
71  public:
72         omxComputeEstimatedHessian();
73         virtual void initFromFrontend(SEXP rObj);
74         virtual void compute(FitContext *fc);
75         virtual void reportResults(FitContext *fc, MxRList *out);
76 };
77
78 struct hess_struct {
79         double* freeParams;
80         double* Haprox;
81         double* Gaprox;
82         omxMatrix* fitMatrix;
83 };
84
85 void omxComputeEstimatedHessian::omxPopulateHessianWork(struct hess_struct *hess_work, omxState* state)
86 {
87         double *freeParams = (double*) Calloc(numParams, double);
88
89         hess_work->Haprox = (double*) Calloc(numIter, double);          // Hessian Workspace
90         hess_work->Gaprox = (double*) Calloc(numIter, double);          // Gradient Workspace
91         hess_work->freeParams = freeParams;
92         for(int i = 0; i < numParams; i++) {
93                 freeParams[i] = optima[i];
94         }
95
96         hess_work->fitMatrix = omxLookupDuplicateElement(state, fitMat);
97 }
98
99 /**
100   @params i              parameter number
101   @params hess_work      local copy
102   @params optima         shared read-only variable
103   @params gradient       shared write-only variable
104   @params hessian        shared write-only variable
105  */
106 void omxComputeEstimatedHessian::omxEstimateHessianOnDiagonal(int i, struct hess_struct* hess_work)
107 {
108         static const double v = 2.0; //Note: NumDeriv comments that this could be a parameter, but is hard-coded in the algorithm
109         static const double eps = 1E-4; // Kept here for access purposes.
110
111         double *Haprox             = hess_work->Haprox;
112         double *Gaprox             = hess_work->Gaprox;
113         double *freeParams         = hess_work->freeParams;
114         omxMatrix* fitMatrix = hess_work->fitMatrix; 
115
116         /* Part the first: Gradient and diagonal */
117         double iOffset = fabs(stepSize * optima[i]);
118         if(fabs(iOffset) < eps) iOffset += eps;
119         if(OMX_DEBUG) {mxLog("Hessian estimation: iOffset: %f.", iOffset);}
120         for(int k = 0; k < numIter; k++) {                      // Decreasing step size, starting at k == 0
121                 if(OMX_DEBUG) {mxLog("Hessian estimation: Parameter %d at refinement level %d (%f). One Step Forward.", i, k, iOffset);}
122                 freeParams[i] = optima[i] + iOffset;
123
124                 
125                 fitContext->copyParamToModel(fitMatrix, freeParams);
126
127                 omxRecompute(fitMatrix);
128                 double f1 = omxMatrixElement(fitMatrix, 0, 0);
129
130                 if(OMX_DEBUG) {mxLog("Hessian estimation: One Step Back.");}
131
132                 freeParams[i] = optima[i] - iOffset;
133
134                 fitContext->copyParamToModel(fitMatrix, freeParams);
135
136                 omxRecompute(fitMatrix);
137                 double f2 = omxMatrixElement(fitMatrix, 0, 0);
138
139                 Gaprox[k] = (f1 - f2) / (2.0*iOffset);                                          // This is for the gradient
140                 Haprox[k] = (f1 - 2.0 * minimum + f2) / (iOffset * iOffset);            // This is second derivative
141                 freeParams[i] = optima[i];                                                                      // Reset parameter value
142                 iOffset /= v;
143                 if(OMX_DEBUG) {mxLog("Hessian estimation: (%d, %d)--Calculating F1: %f F2: %f, Haprox: %f...", i, i, f1, f2, Haprox[k]);}
144         }
145
146         for(int m = 1; m < numIter; m++) {                                              // Richardson Step
147                 for(int k = 0; k < (numIter - m); k++) {
148                         Gaprox[k] = (Gaprox[k+1] * pow(4.0, m) - Gaprox[k])/(pow(4.0, m)-1); // NumDeriv Hard-wires 4s for r here. Why?
149                         Haprox[k] = (Haprox[k+1] * pow(4.0, m) - Haprox[k])/(pow(4.0, m)-1); // NumDeriv Hard-wires 4s for r here. Why?
150                 }
151         }
152
153         if(OMX_DEBUG) { mxLog("Hessian estimation: Populating Hessian (%p) at ([%d, %d] = %d) with value %f...", hessian, i, i, i*numParams+i, Haprox[0]); }
154         gradient[i] = Gaprox[0];                                                // NPSOL reports a gradient that's fine.  Why report two?
155         hessian[i*numParams + i] = Haprox[0];
156
157         if(OMX_DEBUG) {mxLog("Done with parameter %d.", i);}
158
159 }
160
161 void omxComputeEstimatedHessian::omxEstimateHessianOffDiagonal(int i, int l, struct hess_struct* hess_work)
162 {
163     static const double v = 2.0; //Note: NumDeriv comments that this could be a parameter, but is hard-coded in the algorithm
164     static const double eps = 1E-4; // Kept here for access purposes.
165
166         double *Haprox             = hess_work->Haprox;
167         double *freeParams         = hess_work->freeParams;
168         omxMatrix* fitMatrix = hess_work->fitMatrix; 
169
170         double iOffset = fabs(stepSize*optima[i]);
171         if(fabs(iOffset) < eps) iOffset += eps;
172         double lOffset = fabs(stepSize*optima[l]);
173         if(fabs(lOffset) < eps) lOffset += eps;
174
175         for(int k = 0; k < numIter; k++) {
176                 freeParams[i] = optima[i] + iOffset;
177                 freeParams[l] = optima[l] + lOffset;
178
179                 fitContext->copyParamToModel(fitMatrix, freeParams);
180
181                 omxRecompute(fitMatrix);
182                 double f1 = omxMatrixElement(fitMatrix, 0, 0);
183
184                 if(OMX_DEBUG) {mxLog("Hessian estimation: One Step Back.");}
185
186                 freeParams[i] = optima[i] - iOffset;
187                 freeParams[l] = optima[l] - lOffset;
188
189                 fitContext->copyParamToModel(fitMatrix, freeParams);
190
191                 omxRecompute(fitMatrix);
192                 double f2 = omxMatrixElement(fitMatrix, 0, 0);
193
194                 Haprox[k] = (f1 - 2.0 * minimum + f2 - hessian[i*numParams+i]*iOffset*iOffset -
195                                                 hessian[l*numParams+l]*lOffset*lOffset)/(2.0*iOffset*lOffset);
196                 if(OMX_DEBUG) {mxLog("Hessian first off-diagonal calculation: Haprox = %f, iOffset = %f, lOffset=%f from params %f, %f and %f, %f and %d (also: %f, %f and %f).", Haprox[k], iOffset, lOffset, f1, hessian[i*numParams+i], hessian[l*numParams+l], v, k, pow(v, k), stepSize*optima[i], stepSize*optima[l]);}
197
198                 freeParams[i] = optima[i];                              // Reset parameter values
199                 freeParams[l] = optima[l];
200
201                 iOffset = iOffset / v;                                  //  And shrink step
202                 lOffset = lOffset / v;
203         }
204
205         for(int m = 1; m < numIter; m++) {                                              // Richardson Step
206                 for(int k = 0; k < (numIter - m); k++) {
207                         //if(OMX_DEBUG) {mxLog("Hessian off-diagonal calculation: Haprox = %f, iOffset = %f, lOffset=%f from params %f, %f and %f, %f and %d (also: %f, %f and %f, and %f).", Haprox[k], iOffset, lOffset, stepSize, optima[i], optima[l], v, m, pow(4.0, m), stepSize*optima[i], stepSize*optima[l], k);}
208                         Haprox[k] = (Haprox[k+1] * pow(4.0, m) - Haprox[k]) / (pow(4.0, m)-1);
209                 }
210         }
211
212         if(OMX_DEBUG) {mxLog("Hessian estimation: Populating Hessian (%p) at ([%d, %d] = %d and %d) with value %f...", hessian, i, l, i*numParams+l, l*numParams+i, Haprox[0]);}
213         hessian[i*numParams+l] = Haprox[0];
214         hessian[l*numParams+i] = Haprox[0];
215
216 }
217
218 void omxComputeEstimatedHessian::doHessianCalculation(int numChildren, struct hess_struct *hess_work)
219 {
220         int i,j;
221
222         int numOffDiagonal = (numParams * (numParams - 1)) / 2;
223         int *diags = Calloc(numOffDiagonal, int);
224         int *offDiags = Calloc(numOffDiagonal, int);
225         int offset = 0;
226         // gcc does not detect the usage of the following variable
227         // in the omp parallel pragma, and marks the variable as
228         // unused, so the attribute is placed to silence the warning.
229     int __attribute__((unused)) parallelism = (numChildren == 0) ? 1 : numChildren;
230
231         // There must be a way to avoid constructing the
232         // diags and offDiags arrays and replace them with functions
233         // that produce these values given the input
234         /// {0, 1, ..., numOffDiagonal - 1} -- M. Spiegel
235         for(i = 0; i < numParams; i++) {
236                 for(j = i - 1; j >= 0; j--) {
237                         diags[offset] = i;
238                         offDiags[offset] = j;
239                         offset++;
240                 }
241         }
242
243         #pragma omp parallel for num_threads(parallelism) 
244         for(i = 0; i < numParams; i++) {
245                 int threadId = (numChildren < 2) ? 0 : omx_absolute_thread_num();
246                 omxEstimateHessianOnDiagonal(i, hess_work + threadId);
247         }
248
249         #pragma omp parallel for num_threads(parallelism) 
250         for(offset = 0; offset < numOffDiagonal; offset++) {
251                 int threadId = (numChildren < 2) ? 0 : omx_absolute_thread_num();
252                 omxEstimateHessianOffDiagonal(diags[offset], offDiags[offset],
253                         hess_work + threadId);
254         }
255
256         Free(diags);
257         Free(offDiags);
258 }
259
260 void omxComputeEstimatedHessian::init()
261 {
262         stepSize = .0001;
263         numIter = 4;
264         stdErrors = NULL;
265         optima = NULL;
266 }
267
268 omxComputeEstimatedHessian::omxComputeEstimatedHessian()
269 {
270         init();
271 }
272
273 void omxComputeEstimatedHessian::initFromFrontend(SEXP rObj)
274 {
275         super::initFromFrontend(rObj);
276
277         fitMat = omxNewMatrixFromSlot(rObj, globalState, "fitfunction");
278         setFreeVarGroup(fitMat->fitFunction, varGroup);
279
280         SEXP slotValue;
281         PROTECT(slotValue = GET_SLOT(rObj, install("se")));
282         wantSE = asLogical(slotValue);
283         UNPROTECT(1);
284 }
285
286 void omxComputeEstimatedHessian::compute(FitContext *fc)
287 {
288         fitContext = fc;
289         numParams = int(fc->varGroup->vars.size());
290         if (numParams <= 0) error("Model has no free parameters");
291
292         omxFitFunctionCreateChildren(globalState);
293
294         optima = fc->est;
295
296         PROTECT(calculatedHessian = allocMatrix(REALSXP, numParams, numParams));
297
298         // TODO: Check for nonlinear constraints and adjust algorithm accordingly.
299         // TODO: Allow more than one hessian value for calculation
300
301         int numChildren = Global->numChildren;
302
303         omxRecompute(fitMat);
304         minimum = omxMatrixElement(fitMat, 0, 0);
305
306         struct hess_struct* hess_work;
307         if (numChildren < 2) {
308                 hess_work = Calloc(1, struct hess_struct);
309                 omxPopulateHessianWork(hess_work, globalState);
310         } else {
311                 hess_work = Calloc(numChildren, struct hess_struct);
312                 for(int i = 0; i < numChildren; i++) {
313                         omxPopulateHessianWork(hess_work + i, globalState->childList[i]);
314                 }
315         }
316         if(OMX_DEBUG) mxLog("Hessian Calculation using %d children", numChildren);
317
318         hessian = REAL(calculatedHessian);
319
320         gradient = (double*) R_alloc(numParams, sizeof(double));
321   
322         doHessianCalculation(numChildren, hess_work);
323
324         if(OMX_DEBUG) {mxLog("Hessian Computation complete.");}
325
326         if (numChildren < 2) {
327                 Free(hess_work->Haprox);
328                 Free(hess_work->Gaprox);
329                 Free(hess_work->freeParams);
330             Free(hess_work);
331         } else {
332                 for(int i = 0; i < numChildren; i++) {
333                         Free((hess_work + i)->Haprox);
334                         Free((hess_work + i)->Gaprox);
335                         Free((hess_work + i)->freeParams);
336                 }
337                 Free(hess_work);
338         }
339
340         if (wantSE) {
341                 // This function calculates the standard errors from the hessian matrix
342                 // sqrt(diag(solve(hessian)))
343
344                 const double scale = 2;
345                 double* workspace = (double *) Calloc(numParams * numParams, double);
346         
347                 for(int i = 0; i < numParams; i++)
348                         for(int j = 0; j <= i; j++)
349                                 workspace[i*numParams+j] = hessian[i*numParams+j];              // Populate upper triangle
350         
351                 char u = 'U';
352                 std::vector<int> ipiv(numParams);
353                 int lwork = -1;
354                 double temp;
355                 int info = 0;
356         
357                 F77_CALL(dsytrf)(&u, &numParams, workspace, &numParams, ipiv.data(), &temp, &lwork, &info);
358         
359                 lwork = (temp > numParams?temp:numParams);
360         
361                 double* work = (double*) Calloc(lwork, double);
362         
363                 F77_CALL(dsytrf)(&u, &numParams, workspace, &numParams, ipiv.data(), work, &lwork, &info);
364         
365                 if(info != 0) {
366                         // report error TODO
367                 } else {
368                         F77_CALL(dsytri)(&u, &numParams, workspace, &numParams, ipiv.data(), work, &info);
369         
370                         if(info != 0) {
371                                 // report error TODO
372                         } else {
373                                 PROTECT(stdErrors = allocMatrix(REALSXP, numParams, 1));
374                                 double* stdErr = REAL(stdErrors);
375                                 for(int i = 0; i < numParams; i++) {
376                                         stdErr[i] = sqrt(scale) * sqrt(workspace[i * numParams + i]);
377                                 }
378                         }
379                 }
380         
381                 Free(workspace);
382                 Free(work);
383         }
384
385         omxFreeChildStates(globalState);
386 }
387
388 void omxComputeEstimatedHessian::reportResults(FitContext *fc, MxRList *result)
389 {
390         result->push_back(std::make_pair(mkChar("calculatedHessian"), calculatedHessian));
391
392         if (stdErrors) {
393                 result->push_back(std::make_pair(mkChar("standardErrors"), stdErrors));
394         }
395 }
396
397 omxCompute *newComputeEstimatedHessian()
398 {
399         if (globalState->numConstraints != 0) {
400                 error("Cannot compute estimated Hessian with constraints (%d constraints found)",
401                       globalState->numConstraints);
402         }
403         return new omxComputeEstimatedHessian;
404 }
405