Fixed a bug where could not be accessed from a model object, and adjusted one test...
[openmx:openmx.git] / src / omxMLFitFunction.cpp
1  /*
2  *  Copyright 2007-2015 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 #include "omxExpectation.h"
18 #include "omxFIMLFitFunction.h"
19 #include "omxRAMExpectation.h"
20 #include "omxBuffer.h"
21 #include "matrix.h"
22
23 static const double MIN_VARIANCE = 1e-6;
24
25 struct MLFitState {
26
27         omxMatrix* observedCov;
28         omxMatrix* observedMeans;
29         omxMatrix* expectedCov;
30         omxMatrix* expectedMeans;
31         omxMatrix* localCov;
32         omxMatrix* localProd;
33         omxMatrix* P;
34         omxMatrix* C;
35         omxMatrix* I;
36
37         double n;
38         double logDetObserved;
39
40         double* work;
41         int lwork;
42
43     // Expectation Storage;
44     omxMatrix** dSigma;         // dSigma/dTheta
45     omxMatrix** dMu;            // dMu/dTheta
46     omxMatrix* Mu;
47     omxMatrix* Ms;
48     omxMatrix* X;
49     omxMatrix* Y;
50
51         // fisher information
52         int haveLatentMap;
53         std::vector<int> latentMap;
54         std::vector<HessianBlock> lhBlocks;
55 };
56
57 static void omxDestroyMLFitFunction(omxFitFunction *oo) {
58
59         if(OMX_DEBUG) {mxLog("Freeing ML Fit Function.");}
60         MLFitState* omlo = ((MLFitState*)oo->argStruct);
61
62         omxFreeMatrix(omlo->localCov);
63         omxFreeMatrix(omlo->localProd);
64         omxFreeMatrix(omlo->P);
65         omxFreeMatrix(omlo->C);
66         omxFreeMatrix(omlo->I);
67
68         delete omlo;
69 }
70
71 static void calcExtraLikelihoods(omxFitFunction *oo, double *saturated_out, double *independence_out)
72 {
73         MLFitState *state = (MLFitState*) oo->argStruct;
74         double det = 0.0;
75         omxMatrix* cov = state->observedCov;
76         int ncols = state->observedCov->cols;
77
78         *saturated_out = (state->logDetObserved + ncols) * (state->n - 1);
79
80         // Independence model assumes all-zero manifest covariances.
81         // (det(expected) + tr(observed * expected^-1)) * (n - 1);
82         // expected is the diagonal of the observed.  Inverse expected is 1/each diagonal value.
83         // Therefore the diagonal elements of observed * expected^-1 are each 1.
84         // So the trace of the matrix is the same as the number of columns.
85         // The determinant of a diagonal matrix is the product of the diagonal elements.
86         // Since these are the same in the expected as in the observed, we can get 'em direct.
87
88         for(int i = 0; i < ncols; i++) {
89                 // We sum logs instead of logging the product.
90                 det += log(omxMatrixElement(cov, i, i));
91         }
92         if(OMX_DEBUG) { omxPrint(cov, "Observed:"); }
93
94         *independence_out = (ncols + det) * (state->n - 1);
95 }
96
97 static void addOutput(omxFitFunction *oo, MxRList *out)
98 {
99         // DEPRECATED, use omxPopulateMLAttributes
100         if(OMX_DEBUG) { mxLog("Deprecated ML Attribute Population Code Running."); }
101         double saturated_out;
102         double independence_out;
103         omxData* dataMat = oo->expectation->data;
104         if (!strEQ(omxDataType(dataMat), "raw")) {
105                 calcExtraLikelihoods(oo, &saturated_out, &independence_out);
106                 out->add("SaturatedLikelihood", Rf_ScalarReal(saturated_out));
107                 out->add("IndependenceLikelihood", Rf_ScalarReal(independence_out));
108         }
109 }
110
111 static void mvnFit(omxFitFunction *oo, FitContext *fc)
112 {
113         double sum = 0.0, det = 0.0;
114         char u = 'U';
115         char r = 'R';
116         int info = 0;
117         double oned = 1.0;
118         double zerod = 0.0;
119         double minusoned = -1.0;
120         int onei = 1;
121         double fmean = 0.0;
122
123         MLFitState *omo = ((MLFitState*)oo->argStruct);
124         omxMatrix *scov, *smeans, *cov, *means, *localCov, *localProd, *P, *C;
125         scov            = omo->observedCov;
126         smeans          = omo->observedMeans;
127         cov                     = omo->expectedCov;
128         means           = omo->expectedMeans;
129         localCov        = omo->localCov;
130         localProd       = omo->localProd;
131         P                       = omo->P;
132         C                       = omo->C;
133         double n        = omo->n;
134         double Q        = omo->logDetObserved;
135
136         omxCopyMatrix(localCov, cov);                           // But expected cov is destroyed in inversion
137
138         if(OMX_DEBUG_ALGEBRA) {
139                 omxPrint(scov, "Observed Covariance is");
140                 omxPrint(localCov, "Implied Covariance Is");
141                 omxPrint(cov, "Original Covariance Is");
142         }
143
144         /* Calculate |expected| */
145
146 //      F77_CALL(dgetrf)(&(localCov->cols), &(localCov->rows), localCov->data, &(localCov->cols), ipiv, &info);
147         F77_CALL(dpotrf)(&u, &(localCov->cols), localCov->data, &(localCov->cols), &info);
148
149         if(OMX_DEBUG_ALGEBRA) { mxLog("Info on LU Decomp: %d", info);}
150         if(info > 0) {
151                 oo->matrix->data[0] = NA_REAL;
152                 if (fc) fc->recordIterationError("Expected covariance matrix is non-positive-definite");
153                 return;
154         }
155
156         //det = log(det)        // TVO: changed multiplication of det to first log and the summing up; this line should just set det to zero.
157         for(info = 0; info < localCov->cols; info++) {          // |cov| is the square of the product of the diagonal elements of U from the LU factorization.
158                 det += log(fabs(localCov->data[info+localCov->rows*info])); // TVO: changed * to + and added fabs command
159         }
160         det *= 2.0;             // TVO: instead of det *= det;
161
162         if(OMX_DEBUG_ALGEBRA) { mxLog("Determinant of Expected Cov: %f", exp(det)); }
163         // TVO: removed det = log(fabs(det))
164         if(OMX_DEBUG_ALGEBRA) { mxLog("Log of Determinant of Expected Cov: %f", det); }
165
166         /* Calculate Expected^(-1) */
167 //      F77_CALL(dgetri)(&(localCov->rows), localCov->data, &(localCov->cols), ipiv, work, lwork, &info);
168         F77_CALL(dpotri)(&u, &(localCov->rows), localCov->data, &(localCov->cols), &info);
169         if(OMX_DEBUG_ALGEBRA) { mxLog("Info on Invert: %d", info); }
170
171         if(OMX_DEBUG_ALGEBRA) {omxPrint(cov, "Expected Covariance Matrix:");}
172         if(OMX_DEBUG_ALGEBRA) {omxPrint(localCov, "Inverted Matrix:");}
173
174         /* Calculate C = Observed * expected^(-1) */
175
176         // Stop gcc from issuing a Rf_warning
177         int majority = *(scov->majority) == 'n' ? scov->rows : scov->cols;
178
179         /*  TODO:  Make sure leading edges are being appropriately calculated, and sub them back into this */
180         F77_CALL(dsymm)(&r, &u, &(localCov->rows), &(scov->cols),
181                                         &oned, localCov->data, &(majority),
182                                         scov->data, &(majority),
183                                         &zerod, localProd->data, &(localProd->leading));
184
185     /* And get the trace of the result */
186
187         for(info = 0; info < localCov->cols; info++) {
188                 sum += localProd->data[info*localCov->cols + info];
189         }
190
191 //      for(info = 0; info < (localCov->cols * localCov->rows); info++) {
192 //              sum += localCov->data[info] * scov->data[info];
193 //      }
194
195         if(OMX_DEBUG_ALGEBRA) {omxPrint(scov, "Observed Covariance Matrix:");}
196         if(OMX_DEBUG_ALGEBRA) {omxPrint(localCov, "Inverse Matrix:");}
197         if(OMX_DEBUG_ALGEBRA) {omxPrint(localProd, "Product Matrix:");}
198
199         if(means != NULL) {
200                 if(OMX_DEBUG_ALGEBRA) { mxLog("Means Likelihood Calculation"); }
201                 omxRecompute(means, fc);
202                 omxCopyMatrix(P, means);
203                 // P = means - smeans
204                 if(OMX_DEBUG_ALGEBRA) {omxPrint(means, "means");}
205                 if(OMX_DEBUG_ALGEBRA) {omxPrint(smeans, "smeans");}
206                 F77_CALL(daxpy)(&(smeans->cols), &minusoned, smeans->data, &onei, P->data, &onei);
207                 if(OMX_DEBUG_ALGEBRA) {omxPrint(P, "means - smeans");}
208                 // C = P * Cov
209                 F77_CALL(dsymv)(&u, &(localCov->rows), &oned, localCov->data, &(localCov->leading), P->data, &onei, &zerod, C->data, &onei);
210                 // P = C * P'
211                 fmean = F77_CALL(ddot)(&(C->cols), P->data, &onei, C->data, &onei);
212
213                 if(OMX_DEBUG_ALGEBRA) { mxLog("Mean contribution to likelihood is %f per row.", fmean); }
214                 if(fmean < 0.0) fmean = 0.0;
215         }
216
217         oo->matrix->data[0] = (sum + det) * (n - 1) + fmean * (n);
218
219         if(OMX_DEBUG) { mxLog("MLFitFunction value comes to: %f (Chisq: %f).", oo->matrix->data[0], (sum + det) - Q - cov->cols); }
220 }
221
222 static void buildLatentParamMap(omxFitFunction* oo, FitContext *fc)
223 {
224         FreeVarGroup *fvg = fc->varGroup;
225         MLFitState *state = (MLFitState*) oo->argStruct;
226         std::vector<int> &latentMap = state->latentMap;
227         int meanNum = ~state->expectedMeans->matrixNumber;
228         int covNum = ~state->expectedCov->matrixNumber;
229         int maxAbilities = state->expectedCov->rows;
230         int numLatents = maxAbilities + triangleLoc1(maxAbilities);
231
232         if (state->haveLatentMap == fvg->id[0]) return;
233         if (0) mxLog("%s: rebuild latent parameter map for var group %d",
234                      oo->matrix->name, fvg->id[0]); // TODO add runtime verbose setting
235
236         latentMap.assign(numLatents + triangleLoc1(numLatents), -1);
237
238         state->lhBlocks.clear();
239         state->lhBlocks.resize(2);  // 0=mean, 1=cov
240
241         int numParam = int(fvg->vars.size());
242         for (int px=0; px < numParam; px++) {
243                 omxFreeVar *fv = fvg->vars[px];
244                 for (size_t lx=0; lx < fv->locations.size(); lx++) {
245                         omxFreeVarLocation *loc = &fv->locations[lx];
246                         int matNum = loc->matrix;
247                         if (matNum == meanNum) {
248                                 latentMap[loc->row + loc->col] = px;
249                                 state->lhBlocks[0].vars.push_back(px);
250                         } else if (matNum == covNum) {
251                                 int a1 = loc->row;
252                                 int a2 = loc->col;
253                                 if (a1 < a2) std::swap(a1, a2);
254                                 int cell = maxAbilities + triangleLoc1(a1) + a2;
255                                 if (latentMap[cell] == -1) {
256                                         latentMap[cell] = px;
257                                         state->lhBlocks[1].vars.push_back(px);
258
259                                         if (a1 == a2 && fv->lbound == NEG_INF) {
260                                                 fv->lbound = MIN_VARIANCE;  // variance must be positive
261                                                 if (fc->est[px] < fv->lbound) {
262                                                         Rf_error("Starting value for variance %s is not positive", fv->name);
263                                                 }
264                                         }
265                                 } else if (latentMap[cell] != px) {
266                                         // doesn't detect similar problems in multigroup constraints TODO
267                                         Rf_error("Covariance matrix must be constrained to preserve symmetry");
268                                 }
269                         }
270                 }
271         }
272         state->haveLatentMap = fvg->id[0];
273
274         for (int p1=0; p1 < maxAbilities; p1++) {
275                 HessianBlock &hb = state->lhBlocks[0];
276                 int at1 = latentMap[p1];
277                 if (at1 < 0) continue;
278                 const int outer_hb1 = std::lower_bound(hb.vars.begin(), hb.vars.end(), at1) - hb.vars.begin();
279
280                 for (int p2=0; p2 <= p1; p2++) {
281                         int at2 = latentMap[p2];
282                         if (at2 < 0) continue;
283                         int hb1 = outer_hb1;
284                         int hb2 = std::lower_bound(hb.vars.begin(), hb.vars.end(), at2) - hb.vars.begin();
285
286                         if (hb1 < hb2) std::swap(hb1, hb2);
287                         int at = numLatents + triangleLoc1(p1) + p2;
288                         latentMap[at] = hb1 * hb.vars.size() + hb2;
289                 }
290         }
291
292         for (int p1=maxAbilities; p1 < numLatents; p1++) {
293                 HessianBlock &hb = state->lhBlocks[1];
294                 int at1 = latentMap[p1];
295                 if (at1 < 0) continue;
296                 const int outer_hb1 = std::lower_bound(hb.vars.begin(), hb.vars.end(), at1) - hb.vars.begin();
297
298                 for (int p2=maxAbilities; p2 <= p1; p2++) {
299                         int at2 = latentMap[p2];
300                         if (at2 < 0) continue;
301                         int hb1 = outer_hb1;
302                         int hb2 = std::lower_bound(hb.vars.begin(), hb.vars.end(), at2) - hb.vars.begin();
303
304                         if (hb1 < hb2) std::swap(hb1, hb2);
305                         int at = numLatents + triangleLoc1(p1) + p2;
306                         latentMap[at] = hb1 * hb.vars.size() + hb2;
307                 }
308         }
309 }
310
311 static void mvnInfo(omxFitFunction *oo, FitContext *fc)
312 {
313         buildLatentParamMap(oo, fc);
314
315         const double Scale = Global->llScale;
316         MLFitState *state = (MLFitState*) oo->argStruct;
317         const int maxAbilities = state->expectedCov->rows;
318         omxMatrix *cov = state->expectedCov;
319         const double numObs = state->n;
320         int numLatents = maxAbilities + triangleLoc1(maxAbilities);
321         std::vector<int> &latentMap = state->latentMap;
322
323         if (0) mxLog("%s: latentHessian", oo->matrix->name);
324
325         omxBuffer<double> icovBuffer(maxAbilities * maxAbilities);
326         memcpy(icovBuffer.data(), cov->data, sizeof(double) * maxAbilities * maxAbilities);
327         Matrix icovMat(icovBuffer.data(), maxAbilities, maxAbilities);
328         int info = InvertSymmetricPosDef(icovMat, 'U');
329         if (info) return;
330
331         for (int m1=0; m1 < maxAbilities; ++m1) {
332                 for (int m2=0; m2 < m1; ++m2) {
333                         icovBuffer[m2 * maxAbilities + m1] = icovBuffer[m1 * maxAbilities + m2];
334                 }
335         }
336
337         {
338                 HessianBlock *hb = state->lhBlocks[0].clone();
339
340                 int px=numLatents;
341                 for (int m1=0; m1 < maxAbilities; ++m1) {
342                         for (int m2=0; m2 <= m1; ++m2) {
343                                 int to = latentMap[px];
344                                 ++px;
345                                 if (to < 0) continue;
346                                 hb->mat.data()[to] = -Scale * numObs * icovBuffer[m1 * maxAbilities + m2];
347                         }
348                 }
349                 fc->queue(hb);
350         }
351
352         HessianBlock *hb = state->lhBlocks[1].clone();
353
354         std::vector<double> term1(maxAbilities * maxAbilities);
355         std::vector<double> term2(maxAbilities * maxAbilities);
356
357         int f1=0;
358         for (int r1=0; r1 < maxAbilities; ++r1) {
359                 for (int c1=0; c1 <= r1; ++c1) {
360                         memcpy(term1.data()      + c1 * maxAbilities,
361                                icovBuffer.data() + r1 * maxAbilities, maxAbilities * sizeof(double));
362                         if (r1 != c1) {
363                                 memcpy(term1.data()      + r1 * maxAbilities,
364                                        icovBuffer.data() + c1 * maxAbilities, maxAbilities * sizeof(double));
365                         }
366                         int f2 = f1;
367                         for (int r2=r1; r2 < maxAbilities; ++r2) {
368                                 for (int c2 = (r1==r2? c1 : 0); c2 <= r2; ++c2) {
369                                         int to = latentMap[numLatents + triangleLoc1(f2 + maxAbilities) + f1 + maxAbilities];
370                                         ++f2;
371                                         if (to < 0) continue;
372
373                                         memcpy(term2.data()      + c2 * maxAbilities,
374                                                icovBuffer.data() + r2 * maxAbilities, maxAbilities * sizeof(double));
375                                         if (r2 != c2) {
376                                                 memcpy(term2.data()      + r2 * maxAbilities,
377                                                        icovBuffer.data() + c2 * maxAbilities, maxAbilities * sizeof(double));
378                                         }
379
380                                         double tr = 0;
381                                         for (int d1=0; d1 < maxAbilities; ++d1) {
382                                                 for (int d2=0; d2 < maxAbilities; ++d2) {
383                                                         tr += term1[d2 * maxAbilities + d1] * term2[d1 * maxAbilities + d2];
384                                                 }
385                                         }
386
387                                         // Simulation suggests the sample size should be
388                                         // numObs-2 but this is tedious to accomodate
389                                         // when there are parameter equality constraints. Whether
390                                         // the sample size is adjusted or not seems to make
391                                         // no detectable difference in tests.
392                                         hb->mat.data()[to] = Scale * numObs * -.5 * tr;
393
394                                         OMXZERO(term2.data() + c2 * maxAbilities, maxAbilities);
395                                         if (c2 != r2) OMXZERO(term2.data() + r2 * maxAbilities, maxAbilities);
396                                 }
397                         }
398                         OMXZERO(term1.data() + c1 * maxAbilities, maxAbilities);
399                         if (c1 != r1) OMXZERO(term1.data() + r1 * maxAbilities, maxAbilities);
400                         ++f1;
401                 }
402         }
403         fc->queue(hb);
404 }
405
406 static void omxCallMLFitFunction(omxFitFunction *oo, int want, FitContext *fc)
407 {
408         if (want & (FF_COMPUTE_PREOPTIMIZE)) return;
409
410         omxExpectation* expectation = oo->expectation;
411         omxExpectationCompute(expectation, NULL);
412
413         if ((want & FF_COMPUTE_INFO) && strcmp(expectation->expType, "MxExpectationNormal")==0) {
414                 if (fc->infoMethod != INFO_METHOD_HESSIAN) {
415                         omxRaiseErrorf("Information matrix approximation method %d is not available",
416                                        fc->infoMethod);
417                         return;
418                 }
419                 mvnInfo(oo, fc);
420         }
421
422         if (want & FF_COMPUTE_FIT) {
423                 mvnFit(oo, fc);
424         }
425 }
426
427 static void omxPopulateMLAttributes(omxFitFunction *oo, SEXP algebra) {
428     if(OMX_DEBUG) { mxLog("Populating ML Attributes."); }
429
430         MLFitState *argStruct = ((MLFitState*)oo->argStruct);
431         omxMatrix *expCovInt = argStruct->expectedCov;                  // Expected covariance
432         omxMatrix *expMeanInt = argStruct->expectedMeans;                       // Expected means
433
434         SEXP expCovExt, expMeanExt;
435         Rf_protect(expCovExt = Rf_allocMatrix(REALSXP, expCovInt->rows, expCovInt->cols));
436         for(int row = 0; row < expCovInt->rows; row++)
437                 for(int col = 0; col < expCovInt->cols; col++)
438                         REAL(expCovExt)[col * expCovInt->rows + row] =
439                                 omxMatrixElement(expCovInt, row, col);
440
441         if (expMeanInt != NULL) {
442                 Rf_protect(expMeanExt = Rf_allocMatrix(REALSXP, expMeanInt->rows, expMeanInt->cols));
443                 for(int row = 0; row < expMeanInt->rows; row++)
444                         for(int col = 0; col < expMeanInt->cols; col++)
445                                 REAL(expMeanExt)[col * expMeanInt->rows + row] =
446                                         omxMatrixElement(expMeanInt, row, col);
447         } else {
448                 Rf_protect(expMeanExt = Rf_allocMatrix(REALSXP, 0, 0));         
449         }   
450
451         Rf_setAttrib(algebra, Rf_install("expCov"), expCovExt);
452         Rf_setAttrib(algebra, Rf_install("expMean"), expMeanExt);
453         
454         double saturated_out;
455         double independence_out;
456         calcExtraLikelihoods(oo, &saturated_out, &independence_out);
457         Rf_setAttrib(algebra, Rf_install("SaturatedLikelihood"), Rf_ScalarReal(saturated_out));
458         Rf_setAttrib(algebra, Rf_install("IndependenceLikelihood"), Rf_ScalarReal(independence_out));
459 }
460
461 void omxInitMLFitFunction(omxFitFunction* oo)
462 {
463         if (!oo->expectation) { Rf_error("%s requires an expectation", oo->fitType); }
464
465         omxExpectation *expectation = oo->expectation;
466         if (strcmp(expectation->expType, "MxExpectationBA81")==0) {
467                 omxInitFitFunctionBA81(oo);
468                 return;
469         }
470
471         if(OMX_DEBUG) { mxLog("Initializing ML fit function."); }
472
473         int info = 0;
474         double det = 1.0;
475         char u = 'U';
476         
477         oo->computeFun = omxCallMLFitFunction;
478         oo->destructFun = omxDestroyMLFitFunction;
479         oo->addOutput = addOutput;
480         oo->populateAttrFun = omxPopulateMLAttributes;
481
482         omxData* dataMat = oo->expectation->data;
483
484         if(strEQ(omxDataType(dataMat), "raw")) {
485                 if(OMX_DEBUG) { mxLog("Raw Data: Converting from multivariate Normal ML to FIML"); }
486                 omxChangeFitType(oo, "imxFitFunctionFIML");
487                 omxCompleteFitFunction(oo->matrix);
488                 return;
489         }
490
491         if(!strEQ(omxDataType(dataMat), "cov") && !strEQ(omxDataType(dataMat), "cor")) {
492                 omxRaiseErrorf("ML FitFunction unable to handle data type %s", omxDataType(dataMat));
493                 return;
494         }
495
496         MLFitState *newObj = new MLFitState;
497         newObj->haveLatentMap = FREEVARGROUP_INVALID;
498         oo->argStruct = (void*)newObj;
499
500         if(OMX_DEBUG) { mxLog("Processing Observed Covariance."); }
501         newObj->observedCov = omxDataCovariance(dataMat);
502         if(OMX_DEBUG) { mxLog("Processing Observed Means."); }
503         newObj->observedMeans = omxDataMeans(dataMat);
504         if(OMX_DEBUG && newObj->observedMeans == NULL) { mxLog("ML: No Observed Means."); }
505         if(OMX_DEBUG) { mxLog("Processing n."); }
506         newObj->n = omxDataNumObs(dataMat);
507
508         newObj->expectedCov = omxGetExpectationComponent(oo->expectation, oo, "cov");
509         newObj->expectedMeans = omxGetExpectationComponent(oo->expectation, oo, "means");
510
511         if(newObj->expectedCov == NULL) {
512                 omxRaiseError("Developer Error in ML-based fit function object: ML's expectation must specify a model-implied covariance matrix.\nIf you are not developing a new expectation type, you should probably post this to the OpenMx forums.");
513                 return;
514         }
515
516         // Error Checking: Observed/Expected means must agree.  
517         // ^ is XOR: true when one is false and the other is not.
518         if((newObj->expectedMeans == NULL) ^ (newObj->observedMeans == NULL)) {
519                 if(newObj->expectedMeans != NULL) {
520                         omxRaiseError("Observed means not detected, but an expected means matrix was specified.\n  If you provide observed means, you must specify a model for the means.\n");
521                         return;
522                 } else {
523                         omxRaiseErrorf("%s: Observed means were provided, but an expected means matrix was not specified.\n  If you  wish to model the means, you must provide observed means.\n", oo->matrix->name);
524                         return;         
525                 }
526         }
527
528         /* Temporary storage for calculation */
529         int rows = newObj->observedCov->rows;
530         int cols = newObj->observedCov->cols;
531         newObj->localCov = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
532         newObj->localProd = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
533         newObj->P = omxInitMatrix(1, cols, TRUE, oo->matrix->currentState);
534         newObj->C = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
535         newObj->I = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
536
537         for(int i = 0; i < rows; i++) omxSetMatrixElement(newObj->I, i, i, 1.0);
538
539         omxCopyMatrix(newObj->localCov, newObj->observedCov);
540
541         newObj->lwork = newObj->expectedCov->rows;
542         newObj->work = (double*)R_alloc(newObj->lwork, sizeof(double));
543
544         // TODO: Determine where the saturated model computation should go.
545
546         F77_CALL(dpotrf)(&u, &(newObj->localCov->cols), newObj->localCov->data, &(newObj->localCov->cols), &info);
547
548         if(OMX_DEBUG) { mxLog("Info on LU Decomp: %d", info); }
549         if(info != 0) {
550                 char *errstr = (char*) calloc(250, sizeof(char));
551                 sprintf(errstr, "Observed Covariance Matrix is non-positive-definite.\n");
552                 omxRaiseError(errstr);
553                 free(errstr);
554                 return;
555         }
556         for(info = 0; info < newObj->localCov->cols; info++) {
557                 det *= omxMatrixElement(newObj->localCov, info, info);
558         }
559         det *= det;                                     // Product of squares.
560
561         if(OMX_DEBUG) { mxLog("Determinant of Observed Cov: %f", det); }
562         newObj->logDetObserved = log(det);
563         if(OMX_DEBUG) { mxLog("Log Determinant of Observed Cov: %f", newObj->logDetObserved); }
564
565         omxCopyMatrix(newObj->localCov, newObj->expectedCov);
566 }
567
568 static void omxSetMLFitFunctionGradientComponents(omxFitFunction* oo, void (*derivativeFun)(omxFitFunction*, omxMatrix**, omxMatrix**, int*)) {
569     if(OMX_DEBUG) { mxLog("Setting up gradient component function for ML FitFunction."); }
570     if(strEQ("omxFIMLFitFunction", oo->fitType)) {
571         if(OMX_DEBUG) { mxLog("FIML FitFunction gradients not yet implemented. Skipping."); }
572         return; // ERROR:NYI.
573     }
574     
575     if(derivativeFun == NULL) {
576         char Rf_errorstr[250];
577         sprintf(Rf_errorstr, "Programmer Rf_error: ML gradient components given NULL gradient function.");
578         omxRaiseError(Rf_errorstr);
579         return;
580     }
581     
582     MLFitState *omo = ((MLFitState*) oo->argStruct);
583     int rows = omo->observedCov->rows;
584     int cols = omo->observedCov->cols;
585     size_t nFreeVars = oo->freeVarGroup->vars.size();
586             
587     omo->X  = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
588     omo->Y  = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
589     omo->Ms = omxInitMatrix(1, cols, TRUE, oo->matrix->currentState);
590     omo->Mu = omxInitMatrix(1, cols, TRUE, oo->matrix->currentState);
591     omo->dSigma = (omxMatrix**) R_alloc(nFreeVars, sizeof(omxMatrix*));
592     omo->dMu = (omxMatrix**) R_alloc(nFreeVars, sizeof(omxMatrix*));
593     for(size_t i = 0; i < nFreeVars; i++) {
594         omo->dSigma[i] = omxInitMatrix(rows, cols, TRUE, oo->matrix->currentState);
595         omo->dMu[i] = omxInitMatrix(rows, 1, TRUE, oo->matrix->currentState);
596     }
597     //oo->gradientFun = omxCalculateMLGradient; TODO
598 }
599
600 static void omxCalculateMLGradient(omxFitFunction* oo, double* gradient) {
601
602     if(OMX_DEBUG) { mxLog("Beginning ML Gradient Calculation."); }
603     // mxLog("Beginning ML Gradient Calculation, Iteration %d.%d (%d)\n", 
604         // oo->matrix->currentState->majorIteration, oo->matrix->currentState->minorIteration,
605     // 1) Calculate current Expected Covariance
606     // 2) Calculate eCov, the Inverse Expected Covariance matrix 
607     // 3) Calculate C = I - eCov D, where D is the observed covariance matrix
608     // 4) Calculate b = M - [observed M]
609     // 5) For each location in locs:
610     //   gradient[loc] = tr(eCov^-1 %*% dEdt %*% C) - (b^T %*% eCov^-1 %*% dEdt + 2 dMdt^T))eCov^-1 b)
611
612     MLFitState *omo = ((MLFitState*)oo->argStruct);
613     
614     /* Locals for readability.  Compiler should cut through this. */
615     omxMatrix *scov         = omo->observedCov;
616     omxMatrix *smeans       = omo->observedMeans;
617     omxMatrix *cov          = omo->expectedCov;
618     omxMatrix *M            = omo->expectedMeans;
619     omxMatrix *eCov         = omo->localCov;        // TODO: Maybe need to avoid reusing these
620     omxMatrix *I            = omo->I;
621     omxMatrix *C            = omo->C;
622     omxMatrix *X            = omo->X;
623     omxMatrix *Y            = omo->Y;
624     omxMatrix *Mu           = omo->Mu;
625     omxMatrix *Ms           = omo->Ms;
626     omxMatrix *P            = omo->P;
627     double n                = omo->n;
628     omxMatrix** dSigmas     = omo->dSigma;
629     omxMatrix** dMus        = omo->dMu;
630     
631     size_t gradientSize = oo->freeVarGroup->vars.size();
632     
633     char u = 'U';
634     int info;
635     double minusoned = -1.0;
636     int onei = 1;
637     Eigen::VectorXi status(gradientSize);
638     int nLocs = gradientSize;
639     
640     // Calculate current FitFunction values
641     // We can safely assume this has been done
642     // omxFitFunctionCompute(oo);
643     
644     // Calculate current eCov
645     
646     omxCopyMatrix(eCov, cov);                           // But expected cov is destroyed in inversion
647     
648     F77_CALL(dpotrf)(&u, &(eCov->cols), eCov->data, &(eCov->cols), &info);
649
650     if(OMX_DEBUG_ALGEBRA) { mxLog("Info on LU Decomp: %d", info);}
651     if(info > 0) {
652             char *errstr = (char*) calloc(250, sizeof(char));
653         sprintf(errstr, "Expected covariance matrix is non-positive-definite");
654         strncat(errstr, ".\n", 3);
655         omxRaiseError(errstr);                        // Raise Rf_error
656         free(errstr);
657         return;                                                                     // Leave output untouched
658     }
659     
660     F77_CALL(dpotri)(&u, &(eCov->rows), eCov->data, &(eCov->cols), &info);
661     if(info > 0) {
662             char *errstr = (char*) calloc(250, sizeof(char));
663         sprintf(errstr, "Expected covariance matrix is not invertible");
664         strncat(errstr, ".\n", 3);
665         omxRaiseError(errstr);                        // Raise Rf_error
666         free(errstr);
667         return;
668     }
669     // Calculate P = expected means - observed means
670     if(M != NULL) {
671         omxCopyMatrix(P, smeans);
672         F77_CALL(daxpy)(&(smeans->cols), &minusoned, M->data, &onei, P->data, &onei);
673     }
674         
675         // Reset C and Calculate C = I - eCov * oCov
676     omxCopyMatrix(C, I);
677     omxDSYMM(TRUE, -1.0, eCov, scov, 1.0, C);
678     
679     // For means, calculate Ms = eCov-1 %*% P
680     if(M != NULL)
681         omxDSYMM(FALSE, 1.0, eCov, P, 0.0, Ms);
682     
683     // Calculate parameter-level derivatives
684     // TODO: Parallelize Here.
685
686     if(OMX_DEBUG)  { mxLog("Calling component function."); }
687     // omo->derivativeFun(oo, dSigmas, dMus, status);
688     
689     for(int currentLoc = 0; currentLoc < nLocs; currentLoc++) {
690         double meanInfluence, covInfluence;
691         if(status[currentLoc] < 0) continue;  // Failure in computation--skip.
692         //   gradient[loc] = tr(eCov^-1 %*% dEdt %*% C) - 
693         //    (b^T %*% eCov^-1 %*% dEdt + 2 dMdt^T))eCov^-1 b)
694         // omxDGEMM(FALSE, FALSE, 1.0, dSigmas[currentLoc], C, 0.0, Y);
695         omxDSYMM(TRUE, 1.0, dSigmas[currentLoc], C, 0.0, Y);
696         omxDSYMM(TRUE, 1.0, eCov, Y, 0.0, X);
697         gradient[currentLoc] = 0;
698         covInfluence = 0.0;
699         for(int i = 0; i < eCov->cols; i++) 
700             covInfluence += omxMatrixElement(X, i, i);
701         if(M != NULL) {
702             omxCopyMatrix(Mu, dMus[currentLoc]);
703             omxDSYMV(1.0, dSigmas[currentLoc], Ms, 2.0, Mu);
704             meanInfluence = F77_CALL(ddot)(&(eCov->cols), Mu->data, &onei, Ms->data, &onei);
705         } else {
706             meanInfluence = 0;
707         }
708         gradient[currentLoc] = (covInfluence * (n-1)) - (meanInfluence * n);
709         if(OMX_DEBUG) { 
710             mxLog("Calculation for Gradient value %d: Cov: %3.9f, Mean: %3.9f, total: %3.9f",
711             currentLoc, covInfluence, meanInfluence, gradient[currentLoc]); 
712         }
713     }
714 }