Change fit function init API
[openmx:openmx.git] / src / omxFitFunction.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
19 *  omxFitFunction.cc
20 *
21 *  Created: Timothy R. Brick    Date: 2008-11-13 12:33:06
22 *
23 *       FitFunction objects are a subclass of data matrix that evaluates
24 *   itself anew at each iteration, so that any changes to
25 *   free parameters can be incorporated into the update.
26 *   // Question: Should FitFunction be a ``subtype'' of 
27 *   // omxAlgebra or a separate beast entirely?
28 *
29 **********************************************************/
30
31 #include "omxFitFunction.h"
32 #include "omxOptimizer.h"
33 #include "fitMultigroup.h"
34
35 typedef struct omxFitFunctionTableEntry omxFitFunctionTableEntry;
36
37 struct omxFitFunctionTableEntry {
38
39         char name[32];
40         void (*initFun)(omxFitFunction*);
41
42 };
43
44 extern void omxInitAlgebraFitFunction(omxFitFunction *off);
45 extern void omxInitWLSFitFunction(omxFitFunction *off);
46 extern void omxInitRowFitFunction(omxFitFunction *off);
47 extern void omxInitMLFitFunction(omxFitFunction *off);
48 extern void omxInitRFitFunction(omxFitFunction *off);
49
50 static const omxFitFunctionTableEntry omxFitFunctionSymbolTable[] = {
51         {"MxFitFunctionAlgebra",                        &omxInitAlgebraFitFunction},
52         {"MxFitFunctionWLS",                            &omxInitWLSFitFunction},
53         {"MxFitFunctionRow",                            &omxInitRowFitFunction},
54         {"MxFitFunctionML",                             &omxInitMLFitFunction},
55         {"MxFitFunctionR",                                      &omxInitRFitFunction},
56         {"MxFitFunctionMultigroup", &initFitMultigroup}
57 };
58
59 void omxCalculateStdErrorFromHessian(double scale, omxFitFunction *off) {
60         /* This function calculates the standard errors from the hessian matrix */
61         // sqrt(diag(solve(hessian)))
62
63         if(off->hessian == NULL) return;
64         
65         int numParams = off->matrix->currentState->numFreeParams;
66         
67         if(off->stdError == NULL) {
68                 off->stdError = (double*) R_alloc(numParams, sizeof(double));
69         }
70         
71         double* stdErr = off->stdError;
72         
73         double* hessian = off->hessian;
74         double* workspace = (double *) Calloc(numParams * numParams, double);
75         
76         for(int i = 0; i < numParams; i++)
77                 for(int j = 0; j <= i; j++)
78                         workspace[i*numParams+j] = hessian[i*numParams+j];              // Populate upper triangle
79         
80         char u = 'U';
81         int ipiv[numParams];
82         int lwork = -1;
83         double temp;
84         int info = 0;
85         
86         F77_CALL(dsytrf)(&u, &numParams, workspace, &numParams, ipiv, &temp, &lwork, &info);
87         
88         lwork = (temp > numParams?temp:numParams);
89         
90         double* work = (double*) Calloc(lwork, double);
91         
92         F77_CALL(dsytrf)(&u, &numParams, workspace, &numParams, ipiv, work, &lwork, &info);
93         
94         if(info != 0) {
95                 
96                 off->stdError = NULL;
97                 
98         } else {
99                 
100                 F77_CALL(dsytri)(&u, &numParams, workspace, &numParams, ipiv, work, &info);
101         
102                 if(info != 0) {
103                         off->stdError = NULL;
104                 } else {
105                         for(int i = 0; i < numParams; i++) {
106                                 stdErr[i] = sqrt(scale) * sqrt(workspace[i * numParams + i]);
107                         }
108                 }
109         }
110         
111         Free(workspace);
112         Free(work);
113         
114 }
115
116 void omxInitEmptyFitFunction(omxFitFunction *off) {
117         /* Sets everything to NULL to avoid bad pointer calls */
118         
119         memset(off, 0, sizeof(omxFitFunction));
120 }
121
122 void omxFreeFitFunctionArgs(omxFitFunction *off) {
123         if(off==NULL) return;
124     
125         /* Completely destroy the fit function structures */
126         if(OMX_DEBUG) {Rprintf("Freeing fit function object at 0x%x.\n", off);}
127         if(off->matrix != NULL) {
128                 if(off->destructFun != NULL) {
129                         if(OMX_DEBUG) {Rprintf("Calling fit function destructor for 0x%x.\n", off);}
130                         off->destructFun(off);
131                 }
132                 off->matrix = NULL;
133         }
134 }
135
136 void omxFitFunctionCreateChildren(omxState *globalState, int numThreads)
137 {
138         if (numThreads <= 1) return;
139
140         omxMatrix *fm = globalState->fitMatrix;
141         if (!fm) return;
142
143         omxFitFunction *ff = fm->fitFunction;
144         if (!ff->usesChildModels) return;
145
146         globalState->numChildren = numThreads;
147
148         globalState->childList = (omxState**) Calloc(numThreads, omxState*);
149
150         for(int ii = 0; ii < numThreads; ii++) {
151                 globalState->childList[ii] = new omxState;
152                 omxInitState(globalState->childList[ii], globalState);
153                 omxDuplicateState(globalState->childList[ii], globalState);
154         }
155 }
156
157 void omxDuplicateFitMatrix(omxMatrix *tgt, const omxMatrix *src, omxState* newState) {
158
159         if(tgt == NULL || src == NULL) return;
160         if(src->fitFunction == NULL) return;
161     
162         omxFillMatrixFromMxFitFunction(tgt, src->fitFunction->rObj, src->hasMatrixNumber, src->matrixNumber);
163
164 }
165
166 omxFitFunction* omxCreateDuplicateFitFunction(omxFitFunction *tgt, const omxFitFunction *src, omxState* newState) {
167
168         if(OMX_DEBUG) {Rprintf("Duplicating fit function 0x%x into 0x%x.", src, tgt);}
169
170         if(src == NULL) {
171                 return NULL;
172         }
173         
174         if(tgt == NULL) {
175         tgt = (omxFitFunction*) R_alloc(1, sizeof(omxFitFunction));
176         omxInitEmptyFitFunction(tgt);
177     } else {
178                 omxRaiseError(newState, -1,
179                         "omxCreateDuplicateFitFunction requested to overwrite target");
180                 return NULL;
181         }
182
183         memcpy(tgt, src, sizeof(omxFitFunction));
184         return tgt;
185
186 }
187
188 void omxFitFunctionCompute(omxFitFunction *off, int want, double* gradient) {
189         if(OMX_DEBUG_ALGEBRA) { 
190             Rprintf("FitFunction compute: 0x%0x (needed: %s).\n", off, (off->matrix->isDirty?"Yes":"No"));
191         }
192
193         off->computeFun(off, want, gradient);
194
195         omxMarkClean(off->matrix);
196 }
197
198 void omxFillMatrixFromMxFitFunction(omxMatrix* om, SEXP rObj,
199         unsigned short hasMatrixNumber, int matrixNumber) {
200
201         SEXP slotValue, fitFunctionClass;
202         omxFitFunction *obj = (omxFitFunction*) R_alloc(1, sizeof(omxFitFunction));
203         omxInitEmptyFitFunction(obj);
204
205         /* Register FitFunction and Matrix with each other */
206         obj->matrix = om;
207         omxResizeMatrix(om, 1, 1, FALSE);                                       // FitFunction matrices MUST be 1x1.
208         om->fitFunction = obj;
209         om->hasMatrixNumber = hasMatrixNumber;
210         om->matrixNumber = matrixNumber;
211         
212         /* Get FitFunction Type */
213         PROTECT(fitFunctionClass = STRING_ELT(getAttrib(rObj, install("class")), 0));
214         {
215           const char *fitType = CHAR(fitFunctionClass);
216         
217           for (size_t fx=0; fx < OMX_STATIC_ARRAY_SIZE(omxFitFunctionSymbolTable); fx++) {
218                   const omxFitFunctionTableEntry *entry = omxFitFunctionSymbolTable + fx;
219                   if(strcmp(fitType, entry->name) == 0) {
220                           obj->fitType = entry->name;
221                           obj->initFun = entry->initFun;
222                           break;
223                   }
224           }
225
226           if(obj->initFun == NULL) {
227             const int MaxErrorLen = 256;
228             char newError[MaxErrorLen];
229             snprintf(newError, MaxErrorLen, "Fit function %s not implemented.\n", fitType);
230             omxRaiseError(om->currentState, -1, newError);
231             return;
232           }
233         }
234         UNPROTECT(1);   /* fitType */
235
236         PROTECT(slotValue = GET_SLOT(rObj, install("expectation")));
237         if (LENGTH(slotValue) == 1) {
238                 int expNumber = INTEGER(slotValue)[0];  
239                 if(expNumber != NA_INTEGER) {
240                         obj->expectation = omxExpectationFromIndex(expNumber, om->currentState);
241                 }
242         }
243         UNPROTECT(1);   /* slotValue */
244         
245         if (om->currentState->statusMsg[0]) return;
246
247         obj->rObj = rObj;
248         obj->initFun(obj);
249
250         if(obj->computeFun == NULL) {// If initialization fails, error code goes in argStruct
251                 const char *errorCode;
252                 if(om->currentState->statusCode != 0) {
253                         errorCode = om->currentState->statusMsg;
254                 } else {
255                         // If no error code is reported, we report that.
256                         errorCode = "No error code reported.";
257                 }
258                 if(obj->argStruct != NULL) {
259                         errorCode = (char*)(obj->argStruct);
260                 }
261         const int MaxErrorLen = 256;
262         char newError[MaxErrorLen];
263         snprintf(newError, MaxErrorLen, "Could not initialize fit function %s.  Error: %s\n",
264                         obj->fitType, errorCode); 
265                 omxRaiseError(om->currentState, -1, newError);
266         }
267         
268         obj->matrix->isDirty = TRUE;
269
270 }
271
272 void omxFitFunctionPrint(omxFitFunction* off, const char* d) {
273         Rprintf("(FitFunction, type %s) ", off->fitType);
274         omxPrintMatrix(off->matrix, d);
275 }
276
277
278 /* Helper functions */
279 omxMatrix* omxNewMatrixFromSlot(SEXP rObj, omxState* currentState, const char* slotName) {
280         SEXP slotValue;
281         PROTECT(slotValue = GET_SLOT(rObj, install(slotName)));
282         omxMatrix* newMatrix = omxMatrixLookupFromState1(slotValue, currentState);
283         if (newMatrix) omxRecompute(newMatrix);
284         UNPROTECT(1);
285         return newMatrix;
286 }
287