omxComputeEstimateHessian reorg 3/11
[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 omxInitEmptyFitFunction(omxFitFunction *off) {
60         /* Sets everything to NULL to avoid bad pointer calls */
61         
62         memset(off, 0, sizeof(omxFitFunction));
63 }
64
65 void omxFreeFitFunctionArgs(omxFitFunction *off) {
66         if(off==NULL) return;
67     
68         /* Completely destroy the fit function structures */
69         if(OMX_DEBUG) {Rprintf("Freeing fit function object at 0x%x.\n", off);}
70         if(off->matrix != NULL) {
71                 if(off->destructFun != NULL) {
72                         if(OMX_DEBUG) {Rprintf("Calling fit function destructor for 0x%x.\n", off);}
73                         off->destructFun(off);
74                 }
75                 off->matrix = NULL;
76         }
77 }
78
79 void omxFitFunctionCreateChildren(omxState *globalState, int numThreads)
80 {
81         if (numThreads <= 1) return;
82
83         omxMatrix *fm = globalState->fitMatrix;
84         if (!fm) return;
85
86         omxFitFunction *ff = fm->fitFunction;
87         if (!ff->usesChildModels) return;
88
89         globalState->numChildren = numThreads;
90
91         globalState->childList = (omxState**) Calloc(numThreads, omxState*);
92
93         for(int ii = 0; ii < numThreads; ii++) {
94                 globalState->childList[ii] = new omxState;
95                 omxInitState(globalState->childList[ii], globalState);
96                 omxDuplicateState(globalState->childList[ii], globalState);
97         }
98 }
99
100 void omxDuplicateFitMatrix(omxMatrix *tgt, const omxMatrix *src, omxState* newState) {
101
102         if(tgt == NULL || src == NULL) return;
103         if(src->fitFunction == NULL) return;
104     
105         omxFillMatrixFromMxFitFunction(tgt, src->fitFunction->rObj, src->hasMatrixNumber, src->matrixNumber);
106
107 }
108
109 omxFitFunction* omxCreateDuplicateFitFunction(omxFitFunction *tgt, const omxFitFunction *src, omxState* newState) {
110
111         if(OMX_DEBUG) {Rprintf("Duplicating fit function 0x%x into 0x%x.", src, tgt);}
112
113         if(src == NULL) {
114                 return NULL;
115         }
116         
117         if(tgt == NULL) {
118         tgt = (omxFitFunction*) R_alloc(1, sizeof(omxFitFunction));
119         omxInitEmptyFitFunction(tgt);
120     } else {
121                 omxRaiseError(newState, -1,
122                         "omxCreateDuplicateFitFunction requested to overwrite target");
123                 return NULL;
124         }
125
126         memcpy(tgt, src, sizeof(omxFitFunction));
127         return tgt;
128
129 }
130
131 void omxFitFunctionCompute(omxFitFunction *off, int want, double* gradient) {
132         if(OMX_DEBUG_ALGEBRA) { 
133             Rprintf("FitFunction compute: 0x%0x (needed: %s).\n", off, (off->matrix->isDirty?"Yes":"No"));
134         }
135
136         off->computeFun(off, want, gradient);
137
138         omxMarkClean(off->matrix);
139 }
140
141 void omxFillMatrixFromMxFitFunction(omxMatrix* om, SEXP rObj,
142         unsigned short hasMatrixNumber, int matrixNumber) {
143
144         SEXP slotValue, fitFunctionClass;
145         omxFitFunction *obj = (omxFitFunction*) R_alloc(1, sizeof(omxFitFunction));
146         omxInitEmptyFitFunction(obj);
147
148         /* Register FitFunction and Matrix with each other */
149         obj->matrix = om;
150         omxResizeMatrix(om, 1, 1, FALSE);                                       // FitFunction matrices MUST be 1x1.
151         om->fitFunction = obj;
152         om->hasMatrixNumber = hasMatrixNumber;
153         om->matrixNumber = matrixNumber;
154         
155         /* Get FitFunction Type */
156         PROTECT(fitFunctionClass = STRING_ELT(getAttrib(rObj, install("class")), 0));
157         {
158           const char *fitType = CHAR(fitFunctionClass);
159         
160           for (size_t fx=0; fx < OMX_STATIC_ARRAY_SIZE(omxFitFunctionSymbolTable); fx++) {
161                   const omxFitFunctionTableEntry *entry = omxFitFunctionSymbolTable + fx;
162                   if(strcmp(fitType, entry->name) == 0) {
163                           obj->fitType = entry->name;
164                           obj->initFun = entry->initFun;
165                           break;
166                   }
167           }
168
169           if(obj->initFun == NULL) {
170             const int MaxErrorLen = 256;
171             char newError[MaxErrorLen];
172             snprintf(newError, MaxErrorLen, "Fit function %s not implemented.\n", fitType);
173             omxRaiseError(om->currentState, -1, newError);
174             return;
175           }
176         }
177         UNPROTECT(1);   /* fitType */
178
179         PROTECT(slotValue = GET_SLOT(rObj, install("expectation")));
180         if (LENGTH(slotValue) == 1) {
181                 int expNumber = INTEGER(slotValue)[0];  
182                 if(expNumber != NA_INTEGER) {
183                         obj->expectation = omxExpectationFromIndex(expNumber, om->currentState);
184                 }
185         }
186         UNPROTECT(1);   /* slotValue */
187         
188         if (om->currentState->statusMsg[0]) return;
189
190         obj->rObj = rObj;
191         obj->initFun(obj);
192
193         if(obj->computeFun == NULL) {// If initialization fails, error code goes in argStruct
194                 const char *errorCode;
195                 if(om->currentState->statusCode != 0) {
196                         errorCode = om->currentState->statusMsg;
197                 } else {
198                         // If no error code is reported, we report that.
199                         errorCode = "No error code reported.";
200                 }
201                 if(obj->argStruct != NULL) {
202                         errorCode = (char*)(obj->argStruct);
203                 }
204         const int MaxErrorLen = 256;
205         char newError[MaxErrorLen];
206         snprintf(newError, MaxErrorLen, "Could not initialize fit function %s.  Error: %s\n",
207                         obj->fitType, errorCode); 
208                 omxRaiseError(om->currentState, -1, newError);
209         }
210         
211         obj->matrix->isDirty = TRUE;
212
213 }
214
215 void omxFitFunctionPrint(omxFitFunction* off, const char* d) {
216         Rprintf("(FitFunction, type %s) ", off->fitType);
217         omxPrintMatrix(off->matrix, d);
218 }
219
220
221 /* Helper functions */
222 omxMatrix* omxNewMatrixFromSlot(SEXP rObj, omxState* currentState, const char* slotName) {
223         SEXP slotValue;
224         PROTECT(slotValue = GET_SLOT(rObj, install(slotName)));
225         omxMatrix* newMatrix = omxMatrixLookupFromState1(slotValue, currentState);
226         if (newMatrix) omxRecompute(newMatrix);
227         UNPROTECT(1);
228         return newMatrix;
229 }
230