InvertSymmetricIndef
[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 "glue.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 #include "matrix.h"
47 #include "omxBuffer.h"
48
49 class omxComputeEstimatedHessian : public omxCompute {
50         typedef omxCompute super;
51         double stepSize;
52         int numIter;
53         bool wantSE;
54
55         FitContext *fitContext;
56         omxMatrix *fitMat;
57         double minimum;
58         int numParams;
59         double *optima;
60         double *gradient;
61         double *hessian;
62
63         // move to FitContext? TODO
64         SEXP calculatedHessian;
65         SEXP stdErrors;
66
67         void init();
68         void omxPopulateHessianWork(struct hess_struct *hess_work, omxState* state);
69         void omxEstimateHessianOnDiagonal(int i, struct hess_struct* hess_work);
70         void omxEstimateHessianOffDiagonal(int i, int l, struct hess_struct* hess_work);
71         void doHessianCalculation(int numChildren, struct hess_struct *hess_work);
72
73  public:
74         omxComputeEstimatedHessian();
75         virtual void initFromFrontend(SEXP rObj);
76         virtual void compute(FitContext *fc);
77         virtual void reportResults(FitContext *fc, MxRList *out);
78 };
79
80 struct hess_struct {
81         double* freeParams;
82         double* Haprox;
83         double* Gaprox;
84         omxMatrix* fitMatrix;
85 };
86
87 void omxComputeEstimatedHessian::omxPopulateHessianWork(struct hess_struct *hess_work, omxState* state)
88 {
89         double *freeParams = (double*) Calloc(numParams, double);
90
91         hess_work->Haprox = (double*) Calloc(numIter, double);          // Hessian Workspace
92         hess_work->Gaprox = (double*) Calloc(numIter, double);          // Gradient Workspace
93         hess_work->freeParams = freeParams;
94         for(int i = 0; i < numParams; i++) {
95                 freeParams[i] = optima[i];
96         }
97
98         hess_work->fitMatrix = omxLookupDuplicateElement(state, fitMat);
99 }
100
101 /**
102   @params i              parameter number
103   @params hess_work      local copy
104   @params optima         shared read-only variable
105   @params gradient       shared write-only variable
106   @params hessian        shared write-only variable
107  */
108 void omxComputeEstimatedHessian::omxEstimateHessianOnDiagonal(int i, struct hess_struct* hess_work)
109 {
110         static const double v = 2.0; //Note: NumDeriv comments that this could be a parameter, but is hard-coded in the algorithm
111         static const double eps = 1E-4; // Kept here for access purposes.
112
113         double *Haprox             = hess_work->Haprox;
114         double *Gaprox             = hess_work->Gaprox;
115         double *freeParams         = hess_work->freeParams;
116         omxMatrix* fitMatrix = hess_work->fitMatrix; 
117
118         /* Part the first: Gradient and diagonal */
119         double iOffset = fabs(stepSize * optima[i]);
120         if(fabs(iOffset) < eps) iOffset += eps;
121         if(OMX_DEBUG) {mxLog("Hessian estimation: iOffset: %f.", iOffset);}
122         for(int k = 0; k < numIter; k++) {                      // Decreasing step size, starting at k == 0
123                 if(OMX_DEBUG) {mxLog("Hessian estimation: Parameter %d at refinement level %d (%f). One Step Forward.", i, k, iOffset);}
124                 freeParams[i] = optima[i] + iOffset;
125
126                 
127                 fitContext->copyParamToModel(fitMatrix, freeParams);
128
129                 omxRecompute(fitMatrix);
130                 double f1 = omxMatrixElement(fitMatrix, 0, 0);
131
132                 if(OMX_DEBUG) {mxLog("Hessian estimation: One Step Back.");}
133
134                 freeParams[i] = optima[i] - iOffset;
135
136                 fitContext->copyParamToModel(fitMatrix, freeParams);
137
138                 omxRecompute(fitMatrix);
139                 double f2 = omxMatrixElement(fitMatrix, 0, 0);
140
141                 Gaprox[k] = (f1 - f2) / (2.0*iOffset);                                          // This is for the gradient
142                 Haprox[k] = (f1 - 2.0 * minimum + f2) / (iOffset * iOffset);            // This is second derivative
143                 freeParams[i] = optima[i];                                                                      // Reset parameter value
144                 iOffset /= v;
145                 if(OMX_DEBUG) {mxLog("Hessian estimation: (%d, %d)--Calculating F1: %f F2: %f, Haprox: %f...", i, i, f1, f2, Haprox[k]);}
146         }
147
148         for(int m = 1; m < numIter; m++) {                                              // Richardson Step
149                 for(int k = 0; k < (numIter - m); k++) {
150                         Gaprox[k] = (Gaprox[k+1] * pow(4.0, m) - Gaprox[k])/(pow(4.0, m)-1); // NumDeriv Hard-wires 4s for r here. Why?
151                         Haprox[k] = (Haprox[k+1] * pow(4.0, m) - Haprox[k])/(pow(4.0, m)-1); // NumDeriv Hard-wires 4s for r here. Why?
152                 }
153         }
154
155         if(OMX_DEBUG) { mxLog("Hessian estimation: Populating Hessian (%p) at ([%d, %d] = %d) with value %f...", hessian, i, i, i*numParams+i, Haprox[0]); }
156         gradient[i] = Gaprox[0];                                                // NPSOL reports a gradient that's fine.  Why report two?
157         hessian[i*numParams + i] = Haprox[0];
158
159         if(OMX_DEBUG) {mxLog("Done with parameter %d.", i);}
160
161 }
162
163 void omxComputeEstimatedHessian::omxEstimateHessianOffDiagonal(int i, int l, struct hess_struct* hess_work)
164 {
165     static const double v = 2.0; //Note: NumDeriv comments that this could be a parameter, but is hard-coded in the algorithm
166     static const double eps = 1E-4; // Kept here for access purposes.
167
168         double *Haprox             = hess_work->Haprox;
169         double *freeParams         = hess_work->freeParams;
170         omxMatrix* fitMatrix = hess_work->fitMatrix; 
171
172         double iOffset = fabs(stepSize*optima[i]);
173         if(fabs(iOffset) < eps) iOffset += eps;
174         double lOffset = fabs(stepSize*optima[l]);
175         if(fabs(lOffset) < eps) lOffset += eps;
176
177         for(int k = 0; k < numIter; k++) {
178                 freeParams[i] = optima[i] + iOffset;
179                 freeParams[l] = optima[l] + lOffset;
180
181                 fitContext->copyParamToModel(fitMatrix, freeParams);
182
183                 omxRecompute(fitMatrix);
184                 double f1 = omxMatrixElement(fitMatrix, 0, 0);
185
186                 if(OMX_DEBUG) {mxLog("Hessian estimation: One Step Back.");}
187
188                 freeParams[i] = optima[i] - iOffset;
189                 freeParams[l] = optima[l] - lOffset;
190
191                 fitContext->copyParamToModel(fitMatrix, freeParams);
192
193                 omxRecompute(fitMatrix);
194                 double f2 = omxMatrixElement(fitMatrix, 0, 0);
195
196                 Haprox[k] = (f1 - 2.0 * minimum + f2 - hessian[i*numParams+i]*iOffset*iOffset -
197                                                 hessian[l*numParams+l]*lOffset*lOffset)/(2.0*iOffset*lOffset);
198                 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]);}
199
200                 freeParams[i] = optima[i];                              // Reset parameter values
201                 freeParams[l] = optima[l];
202
203                 iOffset = iOffset / v;                                  //  And shrink step
204                 lOffset = lOffset / v;
205         }
206
207         for(int m = 1; m < numIter; m++) {                                              // Richardson Step
208                 for(int k = 0; k < (numIter - m); k++) {
209                         //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);}
210                         Haprox[k] = (Haprox[k+1] * pow(4.0, m) - Haprox[k]) / (pow(4.0, m)-1);
211                 }
212         }
213
214         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]);}
215         hessian[i*numParams+l] = Haprox[0];
216         hessian[l*numParams+i] = Haprox[0];
217
218 }
219
220 void omxComputeEstimatedHessian::doHessianCalculation(int numChildren, struct hess_struct *hess_work)
221 {
222         int i,j;
223
224         int numOffDiagonal = (numParams * (numParams - 1)) / 2;
225         int *diags = Calloc(numOffDiagonal, int);
226         int *offDiags = Calloc(numOffDiagonal, int);
227         int offset = 0;
228         // gcc does not detect the usage of the following variable
229         // in the omp parallel pragma, and marks the variable as
230         // unused, so the attribute is placed to silence the warning.
231     int __attribute__((unused)) parallelism = (numChildren == 0) ? 1 : numChildren;
232
233         // There must be a way to avoid constructing the
234         // diags and offDiags arrays and replace them with functions
235         // that produce these values given the input
236         /// {0, 1, ..., numOffDiagonal - 1} -- M. Spiegel
237         for(i = 0; i < numParams; i++) {
238                 for(j = i - 1; j >= 0; j--) {
239                         diags[offset] = i;
240                         offDiags[offset] = j;
241                         offset++;
242                 }
243         }
244
245         #pragma omp parallel for num_threads(parallelism) 
246         for(i = 0; i < numParams; i++) {
247                 int threadId = (numChildren < 2) ? 0 : omx_absolute_thread_num();
248                 omxEstimateHessianOnDiagonal(i, hess_work + threadId);
249         }
250
251         #pragma omp parallel for num_threads(parallelism) 
252         for(offset = 0; offset < numOffDiagonal; offset++) {
253                 int threadId = (numChildren < 2) ? 0 : omx_absolute_thread_num();
254                 omxEstimateHessianOffDiagonal(diags[offset], offDiags[offset],
255                         hess_work + threadId);
256         }
257
258         Free(diags);
259         Free(offDiags);
260 }
261
262 void omxComputeEstimatedHessian::init()
263 {
264         stepSize = .0001;
265         numIter = 4;
266         stdErrors = NULL;
267         optima = NULL;
268 }
269
270 omxComputeEstimatedHessian::omxComputeEstimatedHessian()
271 {
272         init();
273 }
274
275 void omxComputeEstimatedHessian::initFromFrontend(SEXP rObj)
276 {
277         super::initFromFrontend(rObj);
278
279         fitMat = omxNewMatrixFromSlot(rObj, globalState, "fitfunction");
280         setFreeVarGroup(fitMat->fitFunction, varGroup);
281
282         SEXP slotValue;
283         PROTECT(slotValue = GET_SLOT(rObj, install("se")));
284         wantSE = asLogical(slotValue);
285         UNPROTECT(1);
286 }
287
288 void omxComputeEstimatedHessian::compute(FitContext *fc)
289 {
290         fitContext = fc;
291         numParams = int(fc->varGroup->vars.size());
292         if (numParams <= 0) error("Model has no free parameters");
293
294         omxFitFunctionCreateChildren(globalState);
295
296         optima = fc->est;
297
298         PROTECT(calculatedHessian = allocMatrix(REALSXP, numParams, numParams));
299
300         // TODO: Check for nonlinear constraints and adjust algorithm accordingly.
301         // TODO: Allow more than one hessian value for calculation
302
303         int numChildren = Global->numChildren;
304
305         omxRecompute(fitMat);
306         minimum = omxMatrixElement(fitMat, 0, 0);
307
308         struct hess_struct* hess_work;
309         if (numChildren < 2) {
310                 hess_work = Calloc(1, struct hess_struct);
311                 omxPopulateHessianWork(hess_work, globalState);
312         } else {
313                 hess_work = Calloc(numChildren, struct hess_struct);
314                 for(int i = 0; i < numChildren; i++) {
315                         omxPopulateHessianWork(hess_work + i, globalState->childList[i]);
316                 }
317         }
318         if(OMX_DEBUG) mxLog("Hessian Calculation using %d children", numChildren);
319
320         hessian = REAL(calculatedHessian);
321
322         gradient = (double*) R_alloc(numParams, sizeof(double));
323   
324         doHessianCalculation(numChildren, hess_work);
325
326         if(OMX_DEBUG) {mxLog("Hessian Computation complete.");}
327
328         if (numChildren < 2) {
329                 Free(hess_work->Haprox);
330                 Free(hess_work->Gaprox);
331                 Free(hess_work->freeParams);
332             Free(hess_work);
333         } else {
334                 for(int i = 0; i < numChildren; i++) {
335                         Free((hess_work + i)->Haprox);
336                         Free((hess_work + i)->Gaprox);
337                         Free((hess_work + i)->freeParams);
338                 }
339                 Free(hess_work);
340         }
341
342         if (wantSE) {
343                 // This function calculates the standard errors from the hessian matrix
344                 // sqrt(diag(solve(hessian)))
345
346                 const double scale = 2;
347                 omxBuffer<double> workspace(numParams * numParams);
348         
349                 for(int i = 0; i < numParams; i++)
350                         for(int j = 0; j <= i; j++)
351                                 workspace[i*numParams+j] = hessian[i*numParams+j];              // Populate upper triangle
352         
353                 Matrix wmat(workspace.data(), numParams, numParams);
354                 int info = InvertSymmetricIndef(wmat, 'U');
355                 // ignore info
356
357                 PROTECT(stdErrors = allocMatrix(REALSXP, numParams, 1));
358                 double* stdErr = REAL(stdErrors);
359                 for(int i = 0; i < numParams; i++) {
360                         stdErr[i] = sqrt(scale) * sqrt(workspace[i * numParams + i]);
361                 }
362         }
363
364         omxFreeChildStates(globalState);
365 }
366
367 void omxComputeEstimatedHessian::reportResults(FitContext *fc, MxRList *result)
368 {
369         result->push_back(std::make_pair(mkChar("calculatedHessian"), calculatedHessian));
370
371         if (stdErrors) {
372                 result->push_back(std::make_pair(mkChar("standardErrors"), stdErrors));
373         }
374 }
375
376 omxCompute *newComputeEstimatedHessian()
377 {
378         if (globalState->numConstraints != 0) {
379                 error("Cannot compute estimated Hessian with constraints (%d constraints found)",
380                       globalState->numConstraints);
381         }
382         return new omxComputeEstimatedHessian;
383 }
384