ifa: Fixup
[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 "fitMultigroup.h"
33
34 typedef struct omxFitFunctionTableEntry omxFitFunctionTableEntry;
35
36 struct omxFitFunctionTableEntry {
37
38         char name[32];
39         void (*initFun)(omxFitFunction*);
40
41 };
42
43 static const omxFitFunctionTableEntry omxFitFunctionSymbolTable[] = {
44         {"MxFitFunctionAlgebra",                        &omxInitAlgebraFitFunction},
45         {"MxFitFunctionWLS",                            &omxInitWLSFitFunction},
46         {"MxFitFunctionRow",                            &omxInitRowFitFunction},
47         {"MxFitFunctionML",                             &omxInitMLFitFunction},
48         {"imxFitFunctionFIML", &omxInitFIMLFitFunction},
49         {"MxFitFunctionR",                                      &omxInitRFitFunction},
50         {"MxFitFunctionMultigroup", &initFitMultigroup}
51 };
52
53 void omxFreeFitFunctionArgs(omxFitFunction *off) {
54         if(off==NULL) return;
55     
56         /* Completely destroy the fit function structures */
57         if(OMX_DEBUG) {mxLog("Freeing fit function object at 0x%x.", off);}
58         if(off->matrix != NULL) {
59                 if(off->destructFun != NULL) {
60                         if(OMX_DEBUG) {mxLog("Calling fit function destructor for 0x%x.", off);}
61                         off->destructFun(off);
62                 }
63                 off->matrix = NULL;
64         }
65 }
66
67 void omxFitFunctionCreateChildren(omxState *globalState)
68 {
69         if (Global->numThreads <= 1) return;
70
71         int numThreads = Global->numChildren = Global->numThreads;
72
73         globalState->childList = (omxState**) Calloc(numThreads, omxState*);
74
75         for(int ii = 0; ii < numThreads; ii++) {
76                 globalState->childList[ii] = new omxState;
77                 omxInitState(globalState->childList[ii]);
78                 omxDuplicateState(globalState->childList[ii], globalState);
79         }
80 }
81
82 void omxDuplicateFitMatrix(omxMatrix *tgt, const omxMatrix *src, omxState* newState) {
83
84         if(tgt == NULL || src == NULL) return;
85
86         omxFitFunction *ff = src->fitFunction;
87         if(ff == NULL) return;
88     
89         omxFillMatrixFromMxFitFunction(tgt, ff->fitType, src->matrixNumber);
90         setFreeVarGroup(tgt->fitFunction, src->fitFunction->freeVarGroup);
91         omxCompleteFitFunction(tgt, ff->rObj);
92 }
93
94 void omxFitFunctionCompute(omxFitFunction *off, int want, double* gradient) {
95         if (!off->initialized) error("FitFunction not initialized");
96
97         if(OMX_DEBUG_ALGEBRA) { 
98             mxLog("FitFunction compute: 0x%0x (needed: %s).", off, (off->matrix->isDirty?"Yes":"No"));
99         }
100
101         off->computeFun(off, want, gradient);
102
103         omxMarkClean(off->matrix);
104 }
105
106 void omxFillMatrixFromMxFitFunction(omxMatrix* om, const char *fitType, int matrixNumber)
107 {
108         omxFitFunction *obj = (omxFitFunction*) R_alloc(1, sizeof(omxFitFunction));
109         memset(obj, 0, sizeof(omxFitFunction));
110
111         /* Register FitFunction and Matrix with each other */
112         obj->matrix = om;
113         omxResizeMatrix(om, 1, 1, FALSE);                                       // FitFunction matrices MUST be 1x1.
114         om->fitFunction = obj;
115         om->hasMatrixNumber = TRUE;
116         om->matrixNumber = matrixNumber;
117         
118         for (size_t fx=0; fx < OMX_STATIC_ARRAY_SIZE(omxFitFunctionSymbolTable); fx++) {
119                 const omxFitFunctionTableEntry *entry = omxFitFunctionSymbolTable + fx;
120                 if(strcmp(fitType, entry->name) == 0) {
121                         obj->fitType = entry->name;
122                         obj->initFun = entry->initFun;
123                         break;
124                 }
125         }
126
127         if (obj->initFun == NULL) error("Fit function %s not implemented", fitType);
128 }
129
130 void omxCompleteFitFunction(omxMatrix *om, SEXP rObj)
131 {
132         omxFitFunction *obj = om->fitFunction;
133         if (obj->initialized) return;
134         obj->rObj = rObj;
135
136         SEXP slotValue;
137         PROTECT(slotValue = GET_SLOT(rObj, install("expectation")));
138         if (LENGTH(slotValue) == 1) {
139                 int expNumber = INTEGER(slotValue)[0];  
140                 if(expNumber != NA_INTEGER) {
141                         obj->expectation = omxExpectationFromIndex(expNumber, om->currentState);
142                         setFreeVarGroup(obj->expectation, obj->freeVarGroup);
143                 }
144         }
145         UNPROTECT(1);   /* slotValue */
146         
147         obj->initFun(obj);
148
149         if(obj->computeFun == NULL) error("Failed to initialize fit function %s", obj->fitType); 
150         
151         obj->matrix->isDirty = TRUE;
152         obj->initialized = TRUE;
153 }
154
155 void setFreeVarGroup(omxFitFunction *ff, FreeVarGroup *fvg)
156 {
157         ff->freeVarGroup = fvg;
158 }
159
160 void omxFitFunctionPrint(omxFitFunction* off, const char* d) {
161         mxLog("(FitFunction, type %s)", off->fitType);
162         omxPrintMatrix(off->matrix, d);
163 }
164
165
166 /* Helper functions */
167 omxMatrix* omxNewMatrixFromSlot(SEXP rObj, omxState* currentState, const char* slotName) {
168         SEXP slotValue;
169         PROTECT(slotValue = GET_SLOT(rObj, install(slotName)));
170         omxMatrix* newMatrix = omxMatrixLookupFromState1(slotValue, currentState);
171         UNPROTECT(1);
172         return newMatrix;
173 }
174