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