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