Improve diagnostics
[openmx:openmx.git] / src / omxMatrix.cpp
1 /*
2  *  Copyright 2007-2014 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 *  omxMatrix.cc
20 *
21 *  Created: Timothy R. Brick    Date: 2008-11-13 12:33:06
22 *
23 *       Contains code for the omxMatrix class
24 *   omxDataMatrices hold necessary information to simplify
25 *       dealings between the OpenMX back end and BLAS.
26 *
27 **********************************************************/
28 #include "omxMatrix.h"
29 #include "omxOpenmpWrap.h"
30 #include "matrix.h"
31
32 // forward declarations
33 static omxMatrix* fillMatrixHelperFunction(omxMatrix* om, SEXP matrix, omxState* state,
34         unsigned short hasMatrixNumber, int matrixNumber);
35
36 const char omxMatrixMajorityList[3] = "Tn";             // BLAS Column Majority.
37
38 void omxPrintMatrix(omxMatrix *source, const char* header)
39 {
40         std::string buf;
41         buf += string_snprintf("[%d] %s %s = matrix(c(    # %dx%d",
42                                omx_absolute_thread_num(),
43                                header, source->name? source->name : "?", source->rows, source->cols);
44
45         int first=TRUE;
46         if(source->colMajor) {
47                 for(int j = 0; j < source->rows; j++) {
48                         buf += "\n";
49                         for(int k = 0; k < source->cols; k++) {
50                                 if (first) first=FALSE;
51                                 else buf += ",";
52                                 buf += string_snprintf(" %3.6f", source->data[k*source->rows+j]);
53                         }
54                 }
55         } else {
56                 for(int j = 0; j < source->cols; j++) {
57                         buf += "\n";
58                         for(int k = 0; k < source->rows; k++) {
59                                 if (first) first=FALSE;
60                                 else buf += ",";
61                                 buf += string_snprintf(" %3.6f", source->data[k*source->cols+j]);
62                         }
63                 }
64         }
65
66         buf += string_snprintf("), byrow=TRUE, nrow=%d, ncol=%d)\n", source->rows, source->cols);
67         mxLogBig(buf);
68 }
69
70 omxMatrix* omxInitMatrix(omxMatrix* om, int nrows, int ncols, unsigned short isColMajor, omxState* os) {
71
72         if (!isColMajor) Rf_error("All matrices are created column major");
73         if (om) Rf_error("om is always NULL"); // remove argument TODO
74
75         om = (omxMatrix*) Calloc(1, omxMatrix);
76
77         om->hasMatrixNumber = 0;
78         om->rows = nrows;
79         om->cols = ncols;
80         om->colMajor = (isColMajor ? 1 : 0);
81
82         om->originalRows = om->rows;
83         om->originalCols = om->cols;
84         om->originalColMajor=om->colMajor;
85
86         om->owner = NULL;
87         if(om->rows == 0 || om->cols == 0) {
88                 om->data = NULL;
89         } else {
90                 om->data = (double*) Calloc(nrows * ncols, double);
91         }
92
93         om->populateFrom = NULL;
94         om->populateFromCol = NULL;
95         om->populateFromRow = NULL;
96         om->populateToCol = NULL;
97         om->populateToRow = NULL;
98
99         om->numPopulateLocations = 0;
100
101         om->aliasedPtr = NULL;
102         om->algebra = NULL;
103         om->fitFunction = NULL;
104
105         om->currentState = os;
106         om->isTemporary = FALSE;
107         om->name = NULL;
108         om->version = 1;
109         omxMarkClean(om);
110
111         omxMatrixLeadingLagging(om);
112
113         return om;
114
115 }
116
117 omxMatrix* omxInitTemporaryMatrix(omxMatrix* om, int nrows, int ncols, unsigned short isColMajor, omxState* os)
118 {
119         if (om) Rf_error("om must be NULL");  // remove this argument TODO
120
121         om = omxInitMatrix(NULL, nrows, ncols, isColMajor, os);
122         om->isTemporary = TRUE;
123         
124         return(om);
125
126 }
127
128 void omxCopyMatrix(omxMatrix *dest, omxMatrix *orig) {
129         /* Copy a matrix.  NOTE: Matrix maintains its algebra bindings. */
130
131         int regenerateMemory = TRUE;
132         int numPopLocs = orig->numPopulateLocations;
133
134         if(!dest->owner && (dest->originalRows == orig->rows && dest->originalCols == orig->cols)) {
135                 regenerateMemory = FALSE;                               // If it's local data and the right size, we can keep memory.
136         }
137
138         dest->rows = orig->rows;
139         dest->cols = orig->cols;
140         dest->colMajor = orig->colMajor;
141         dest->originalRows = dest->rows;
142         dest->originalCols = dest->cols;
143         dest->originalColMajor = dest->colMajor;
144
145         dest->numPopulateLocations = numPopLocs;
146         if (numPopLocs > 0) {
147                 dest->populateFrom = (int*)R_alloc(numPopLocs, sizeof(int));
148                 dest->populateFromRow = (int*)R_alloc(numPopLocs, sizeof(int));
149                 dest->populateFromCol = (int*)R_alloc(numPopLocs, sizeof(int));
150                 dest->populateToRow = (int*)R_alloc(numPopLocs, sizeof(int));
151                 dest->populateToCol = (int*)R_alloc(numPopLocs, sizeof(int));
152                 
153                 memcpy(dest->populateFrom, orig->populateFrom, numPopLocs * sizeof(int));
154                 memcpy(dest->populateFromRow, orig->populateFromRow, numPopLocs * sizeof(int));
155                 memcpy(dest->populateFromCol, orig->populateFromCol, numPopLocs * sizeof(int));
156                 memcpy(dest->populateToRow, orig->populateToRow, numPopLocs * sizeof(int));
157                 memcpy(dest->populateToCol, orig->populateToCol, numPopLocs * sizeof(int));
158         }
159
160         if(dest->rows == 0 || dest->cols == 0) {
161                 omxFreeMatrixData(dest);
162                 dest->data = NULL;
163         } else {
164                 if(regenerateMemory) {
165                         omxFreeMatrixData(dest);                                                                                        // Free and regenerate memory
166                         dest->data = (double*) Calloc(dest->rows * dest->cols, double);
167                 }
168                 if (dest->data != orig->data) {  // if equal then programmer Rf_error? TODO
169                         memcpy(dest->data, orig->data, dest->rows * dest->cols * sizeof(double));
170                 }
171         }
172
173         dest->aliasedPtr = NULL;
174
175         omxMatrixLeadingLagging(dest);
176 }
177
178 void omxAliasMatrix(omxMatrix *dest, omxMatrix *src) {
179         omxCopyMatrix(dest, src);
180         dest->aliasedPtr = src;                                 // Alias now follows back matrix precisely.
181 }
182
183 void omxFreeMatrixData(omxMatrix * om) {
184
185         if(!om->owner && om->data != NULL) {
186                 Free(om->data);
187         }
188         om->owner = NULL;
189         om->data = NULL;
190 }
191
192 void omxFreeAllMatrixData(omxMatrix *om) {
193     
194     if(om == NULL) return;
195
196         omxFreeMatrixData(om);
197
198         if(om->algebra != NULL) {
199                 omxFreeAlgebraArgs(om->algebra);
200                 om->algebra = NULL;
201         }
202
203         if(om->fitFunction != NULL) {
204                 omxFreeFitFunctionArgs(om->fitFunction);
205                 om->fitFunction = NULL;
206         }
207         
208         if(om->isTemporary) {
209                 Free(om);
210         }
211 }
212
213 /**
214  * Copies an omxMatrix to a new R matrix object
215  *
216  * \param om the omxMatrix to copy
217  * \return a Rf_protect'd SEXP for the R matrix object
218  */
219 SEXP omxExportMatrix(omxMatrix *om) {
220         SEXP nextMat;
221         Rf_protect(nextMat = Rf_allocMatrix(REALSXP, om->rows, om->cols));
222         for(int row = 0; row < om->rows; row++) {
223                 for(int col = 0; col < om->cols; col++) {
224                         REAL(nextMat)[col * om->rows + row] =
225                                 omxMatrixElement(om, row, col);
226                 }
227         }
228         return nextMat;
229 }
230
231 void omxZeroByZeroMatrix(omxMatrix *om) {
232         if (om->rows > 0 || om->cols > 0) {
233                 omxResizeMatrix(om, 0, 0, FALSE);
234         }
235 }
236
237 omxMatrix* omxNewIdentityMatrix(int nrows, omxState* state) {
238         omxMatrix* newMat = NULL;
239         int l,k;
240
241         newMat = omxInitMatrix(NULL, nrows, nrows, TRUE, state);
242         for(k =0; k < newMat->rows; k++) {
243                 for(l = 0; l < newMat->cols; l++) {
244                         if(l == k) {
245                                 omxSetMatrixElement(newMat, k, l, 1);
246                         } else {
247                                 omxSetMatrixElement(newMat, k, l, 0);
248                         }
249                 }
250         }
251         return newMat;
252 }
253
254 omxMatrix* omxDuplicateMatrix(omxMatrix* src, omxState* newState) {
255         omxMatrix* newMat;
256     
257         if(src == NULL) return NULL;
258         newMat = omxInitMatrix(NULL, src->rows, src->cols, TRUE, newState);
259         omxCopyMatrix(newMat, src);
260         newMat->hasMatrixNumber = src->hasMatrixNumber;
261         newMat->matrixNumber    = src->matrixNumber;
262         newMat->name = src->name;
263     
264     return newMat;    
265 }
266
267 void omxResizeMatrix(omxMatrix *om, int nrows, int ncols, unsigned short keepMemory)
268 {
269         if (keepMemory) error("keepMemory must be false"); // remove parameter, TODO
270
271         // Always Recompute() before you Resize().
272         if(OMX_DEBUG_MATRIX) { 
273                 mxLog("Resizing matrix from (%d, %d) to (%d, %d) (keepMemory: %d)", 
274                         om->rows, om->cols, 
275                         nrows, ncols, keepMemory);
276         }
277
278         if( (om->rows != nrows || om->cols != ncols)) {
279                 omxFreeMatrixData(om);
280                 om->data = (double*) Calloc(nrows * ncols, double);
281         }
282
283         om->rows = nrows;
284         om->cols = ncols;
285         om->originalRows = om->rows;
286         om->originalCols = om->cols;
287
288         omxMatrixLeadingLagging(om);
289 }
290
291 void omxResetAliasedMatrix(omxMatrix *om) {
292         om->rows = om->originalRows;
293         om->cols = om->originalCols;
294         if(om->aliasedPtr != NULL) {
295                 memcpy(om->data, om->aliasedPtr->data, om->rows*om->cols*sizeof(double));
296                 om->colMajor = om->aliasedPtr->colMajor;
297         }
298         omxMatrixLeadingLagging(om);
299 }
300
301 double* omxLocationOfMatrixElement(omxMatrix *om, int row, int col) {
302         int index = 0;
303         if(om->colMajor) {
304                 index = col * om->rows + row;
305         } else {
306                 index = row * om->cols + col;
307         }
308         return om->data + index;
309 }
310
311 void vectorElementError(int index, int numrow, int numcol) {
312         char *errstr = (char*) calloc(250, sizeof(char));
313         if ((numrow > 1) && (numcol > 1)) {
314                 sprintf(errstr, "Requested improper index (%d) from a malformed vector of dimensions (%d, %d).", 
315                         index, numrow, numcol);
316         } else {
317                 int Rf_length = (numrow > 1) ? numrow : numcol;
318                 sprintf(errstr, "Requested improper index (%d) from vector of Rf_length (%d).", 
319                         index, Rf_length);
320         }
321         Rf_error(errstr);
322         free(errstr);  // TODO not reached
323 }
324
325 void setMatrixError(omxMatrix *om, int row, int col, int numrow, int numcol) {
326         char *errstr = (char*) calloc(250, sizeof(char));
327         static const char *matrixString = "matrix";
328         static const char *algebraString = "algebra";
329         static const char *fitString = "fit function";
330         const char *typeString;
331         if (om->algebra != NULL) {
332                 typeString = algebraString;
333         } else if (om->fitFunction != NULL) {
334                 typeString = fitString;
335         } else {
336                 typeString = matrixString;
337         }
338         if (om->name == NULL) {
339                 sprintf(errstr, "Attempted to set row and column (%d, %d) in %s with dimensions %d x %d.", 
340                         row, col, typeString, numrow, numcol);
341         } else {
342                 sprintf(errstr, "Attempted to set row and column (%d, %d) in %s \"%s\" with dimensions %d x %d.", 
343                         row, col, typeString, om->name, numrow, numcol);
344         }
345         Rf_error(errstr);
346         free(errstr);  // TODO not reached
347 }
348
349 void matrixElementError(int row, int col, int numrow, int numcol) {
350         Rf_error("Requested improper value (%d, %d) from (%d, %d) matrix", row, col, numrow, numcol);
351 }
352
353 void setVectorError(int index, int numrow, int numcol) {
354         char *errstr = (char*) calloc(250, sizeof(char));
355         if ((numrow > 1) && (numcol > 1)) {
356                 sprintf(errstr, "Attempting to set improper index (%d) from a malformed vector of dimensions (%d, %d).", 
357                         index, numrow, numcol);
358         } else {
359                 int Rf_length = (numrow > 1) ? numrow : numcol;
360                 sprintf(errstr, "Setting improper index (%d) from vector of Rf_length %d.", 
361                         index, Rf_length);
362         }
363         Rf_error(errstr);
364         free(errstr);  // TODO not reached
365 }
366
367 double omxAliasedMatrixElement(omxMatrix *om, int row, int col) {
368         int index = 0;
369         if(row >= om->originalRows || col >= om->originalCols) {
370                 char *errstr = (char*) calloc(250, sizeof(char));
371                 sprintf(errstr, "Requested improper value (%d, %d) from (%d, %d) matrix.", 
372                         row + 1, col + 1, om->originalRows, om->originalCols);
373                 Rf_error(errstr);
374                 free(errstr);  // TODO not reached
375         return (NA_REAL);
376         }
377         if(om->colMajor) {
378                 index = col * om->originalRows + row;
379         } else {
380                 index = row * om->originalCols + col;
381         }
382         return om->data[index];
383 }
384
385 void omxMarkDirty(omxMatrix *om) { om->version += 1; }
386
387 void omxMarkClean(omxMatrix *om) {
388         om->version += 1;
389         om->cleanVersion = om->version;
390         if (OMX_DEBUG_ALGEBRA) {
391                 const char *name = "?";
392                 if (om->name) name = om->name;
393                 mxLog("Marking matrix %s clean (version %d)", name, om->version);
394         }
395 }
396
397 omxMatrix* omxNewMatrixFromRPrimitive(SEXP rObject, omxState* state, 
398         unsigned short hasMatrixNumber, int matrixNumber) {
399 /* Creates and populates an omxMatrix with details from an R matrix object. */
400         omxMatrix *om = NULL;
401         om = omxInitMatrix(NULL, 0, 0, TRUE, state);
402         return omxFillMatrixFromRPrimitive(om, rObject, state, hasMatrixNumber, matrixNumber);
403 }
404
405 omxMatrix* omxFillMatrixFromRPrimitive(omxMatrix* om, SEXP rObject, omxState* state,
406         unsigned short hasMatrixNumber, int matrixNumber) {
407 /* Populates the fields of a omxMatrix with details from an R object. */
408         if(!Rf_isMatrix(rObject) && !Rf_isVector(rObject)) { // Sanity Check
409                 Rf_error("Recieved unknown matrix type in omxFillMatrixFromRPrimitive.");
410         }
411         return(fillMatrixHelperFunction(om, rObject, state, hasMatrixNumber, matrixNumber));
412 }
413
414
415
416 static omxMatrix* fillMatrixHelperFunction(omxMatrix* om, SEXP matrix, omxState* state,
417         unsigned short hasMatrixNumber, int matrixNumber) {
418
419         int* dimList;
420
421         if(OMX_DEBUG) { mxLog("Filling omxMatrix from R matrix."); }
422
423         if (!om) Rf_error("fillMatrixHelperFunction: matrix must be allocated already");
424
425         if(Rf_isMatrix(matrix)) {
426                 SEXP matrixDims;
427                 Rf_protect(matrixDims = Rf_getAttrib(matrix, R_DimSymbol));
428                 dimList = INTEGER(matrixDims);
429                 om->rows = dimList[0];
430                 om->cols = dimList[1];
431                 Rf_unprotect(1); // matrixDims
432         } else if (Rf_isVector(matrix)) {               // If it's a vector, assume it's a row vector. BLAS doesn't care.
433                 if(OMX_DEBUG) { mxLog("Vector discovered.  Assuming rowity."); }
434                 om->rows = 1;
435                 om->cols = Rf_length(matrix);
436         }
437         if(OMX_DEBUG) { mxLog("Matrix connected to (%d, %d) matrix or MxMatrix.", om->rows, om->cols); }
438
439         if (TYPEOF(matrix) != REALSXP) {
440                 // we could avoid a double copy here TODO
441                 SEXP copy;
442                 Rf_protect(copy = Rf_coerceVector(matrix, REALSXP));
443                 om->data = (double*) Realloc(NULL, om->rows * om->cols, double);
444                 memcpy(om->data, REAL(copy), om->rows * om->cols * sizeof(double));
445         } else {
446                 om->owner = matrix;
447                 om->data = REAL(om->owner);
448         }
449
450         om->colMajor = TRUE;
451         om->originalRows = om->rows;
452         om->originalCols = om->cols;
453         om->originalColMajor = TRUE;
454         om->aliasedPtr = NULL;
455         om->algebra = NULL;
456         om->fitFunction = NULL;
457         om->currentState = state;
458         om->hasMatrixNumber = hasMatrixNumber;
459         om->matrixNumber = matrixNumber;
460         om->version = 1;
461         omxMarkClean(om);
462
463         if(OMX_DEBUG) { mxLog("Pre-compute call.");}
464         omxMatrixLeadingLagging(om);
465         if(OMX_DEBUG) { mxLog("Post-compute call.");}
466
467         return om;
468 }
469
470 void omxProcessMatrixPopulationList(omxMatrix* matrix, SEXP matStruct) {
471
472         if(OMX_DEBUG) { mxLog("Processing Population List: %d elements.", Rf_length(matStruct) - 1); }
473
474         if(Rf_length(matStruct) > 1) {
475                 int numPopLocs = Rf_length(matStruct) - 1;
476                 matrix->numPopulateLocations = numPopLocs;
477                 matrix->populateFrom = (int*)R_alloc(numPopLocs, sizeof(int));
478                 matrix->populateFromRow = (int*)R_alloc(numPopLocs, sizeof(int));
479                 matrix->populateFromCol = (int*)R_alloc(numPopLocs, sizeof(int));
480                 matrix->populateToRow = (int*)R_alloc(numPopLocs, sizeof(int));
481                 matrix->populateToCol = (int*)R_alloc(numPopLocs, sizeof(int));
482         }
483
484         for(int i = 0; i < Rf_length(matStruct)-1; i++) {
485                 SEXP subList;
486                 Rf_protect(subList = VECTOR_ELT(matStruct, i+1));
487
488                 int* locations = INTEGER(subList);
489                 if(OMX_DEBUG) { mxLog("."); } //:::
490                 matrix->populateFrom[i] = locations[0];
491                 matrix->populateFromRow[i] = locations[1];
492                 matrix->populateFromCol[i] = locations[2];
493                 matrix->populateToRow[i] = locations[3];
494                 matrix->populateToCol[i] = locations[4];
495                 Rf_unprotect(1); //subList
496         }
497 }
498
499 void omxToggleRowColumnMajor(omxMatrix *mat) {
500
501         int i, j;
502         int nrows = mat->rows;
503         int ncols = mat->cols;
504         
505         double *newdata = (double*) Calloc(nrows * ncols, double);
506         double *olddata = mat->data;
507
508         if (mat->colMajor) {
509                 for(i = 0; i < ncols; i++) {
510                         for(j = 0; j < nrows; j++) {
511                                 newdata[i + ncols * j] = olddata[i * nrows + j];
512                         }
513                 }
514         } else {
515                 for(i = 0; i < nrows; i++) {
516                         for(j = 0; j < ncols; j++) {
517                                 newdata[i + nrows * j] = olddata[i * ncols + j];
518                         }
519                 }
520         }
521
522         omxFreeMatrixData(mat);
523         mat->data = newdata;
524         mat->colMajor = !mat->colMajor;
525 }
526
527 void omxTransposeMatrix(omxMatrix *mat) {
528         mat->colMajor = !mat->colMajor;
529         
530         if(mat->rows != mat->cols){
531         int mid = mat->rows;
532         mat->rows = mat->cols;
533         mat->cols = mid;
534         }
535         
536         omxMatrixLeadingLagging(mat);
537 }
538
539 void omxRemoveElements(omxMatrix *om, int numRemoved, int removed[]) {
540
541         if(numRemoved < 1) { return; }
542
543         int oldElements;
544
545         if (om->rows > 1) {
546                 if(om->aliasedPtr == NULL) {
547                         if(om->originalRows == 0) {
548                                 om->originalRows = om->rows;
549                         }
550                         oldElements = om->originalRows;
551                 } else {
552                         oldElements = om->aliasedPtr->rows;
553                 }
554                 om->rows = oldElements - numRemoved;
555         } else {
556                 if(om->aliasedPtr == NULL) {
557                         if(om->originalCols == 0) {
558                                 om->originalCols = om->cols;
559                         }
560                         oldElements = om->originalCols;
561                 } else {
562                         oldElements = om->aliasedPtr->cols;
563                 }
564                 om->cols = oldElements - numRemoved;
565         }
566
567         int nextElement = 0;
568
569         for(int j = 0; j < oldElements; j++) {
570                 if(!removed[j]) {
571                         if(om->aliasedPtr == NULL) {
572                                 omxUnsafeSetVectorElement(om, nextElement, omxUnsafeVectorElement(om, j));
573                         } else {
574                                 omxUnsafeSetVectorElement(om, nextElement, omxUnsafeVectorElement(om->aliasedPtr, j));
575                         }
576                         nextElement++;
577                 }
578         }
579
580         omxMatrixLeadingLagging(om);
581 }
582
583 void omxRemoveRowsAndColumns(omxMatrix *om, int numRowsRemoved, int numColsRemoved, int rowsRemoved[], int colsRemoved[])
584 {
585     // TODO: Create short-circuit form of omxRemoveRowsAndCols to remove just rows or just columns.
586
587         if(numRowsRemoved < 1 && numColsRemoved < 1) { return; }
588
589         int oldRows, oldCols;
590
591         if(om->aliasedPtr == NULL) {
592                 if(om->originalRows == 0 || om->originalCols == 0) {
593                         om->originalRows = om->rows;
594                         om->originalCols = om->cols;
595                 }
596                 oldRows = om->originalRows;
597                 oldCols = om->originalCols;
598         } else {
599                 oldRows = om->aliasedPtr->rows;
600                 oldCols = om->aliasedPtr->cols;
601         }
602
603         int nextCol = 0;
604         int nextRow = 0;
605
606         if(om->rows > om->originalRows || om->cols > om->originalCols) {        // sanity check.
607                 Rf_error("Aliased Matrix is too small for alias.");
608         }
609
610         om->rows = oldRows - numRowsRemoved;
611         om->cols = oldCols - numColsRemoved;
612
613         // Note:  This really aught to be done using a matrix multiply.  Why isn't it?
614         for(int j = 0; j < oldCols; j++) {
615                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Handling column %d/%d...", j, oldCols);}
616                 if(colsRemoved[j]) {
617                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Removed.");}
618                         continue;
619                 } else {
620                         nextRow = 0;
621                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Rows (max %d): ", oldRows); }
622                         for(int k = 0; k < oldRows; k++) {
623                                 if(rowsRemoved[k]) {
624                                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("%d removed....", k);}
625                                         continue;
626                                 } else {
627                                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("%d kept....", k);}
628                                         if(om->aliasedPtr == NULL) {
629                                                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Self-aliased matrix access.");}
630                                                 omxSetMatrixElement(om, nextRow, nextCol, omxAliasedMatrixElement(om, k, j));
631                                         } else {
632                                                 omxSetMatrixElement(om, nextRow, nextCol, omxMatrixElement(om->aliasedPtr, k,  j));
633                                         }
634                                         nextRow++;
635                                 }
636                         }
637                         nextCol++;
638                 }
639         }
640
641         omxMatrixLeadingLagging(om);
642 }
643
644 /* Function wrappers that switch based on inclusion of algebras */
645 void omxPrint(omxMatrix *source, const char* d) {                                       // Pretty-print a (small) matrix
646     if(source == NULL) mxLog("%s is NULL.", d);
647         else if(source->algebra != NULL) omxAlgebraPrint(source->algebra, d);
648         else if(source->fitFunction != NULL) omxFitFunctionPrint(source->fitFunction, d);
649         else omxPrintMatrix(source, d);
650 }
651
652 void omxPopulateSubstitutions(omxMatrix *om) {
653         for(int i = 0; i < om->numPopulateLocations; i++) {
654                 int index = om->populateFrom[i];
655                 omxMatrix* sourceMatrix;
656                 if (index < 0) {
657                         sourceMatrix = om->currentState->matrixList[~index];
658                 } else {
659                         sourceMatrix = om->currentState->algebraList[index];
660                 }
661                 if (sourceMatrix != NULL) {
662                         omxRecompute(sourceMatrix);                             // Make sure it's up to date
663                         double value = omxMatrixElement(sourceMatrix, om->populateFromRow[i], om->populateFromCol[i]);
664                         omxSetMatrixElement(om, om->populateToRow[i], om->populateToCol[i], value);
665                 }
666         }
667 }
668
669 void omxMatrixLeadingLagging(omxMatrix *om) {
670         om->majority = &(omxMatrixMajorityList[(om->colMajor?1:0)]);
671         om->minority = &(omxMatrixMajorityList[(om->colMajor?0:1)]);
672         om->leading = (om->colMajor?om->rows:om->cols);
673         om->lagging = (om->colMajor?om->cols:om->rows);
674 }
675
676 unsigned short omxNeedsUpdate(omxMatrix *matrix) {
677         bool yes;
678         if (matrix->hasMatrixNumber && omxMatrixIsClean(matrix)) {
679                 yes = FALSE;
680         } else {
681                 yes = TRUE;
682         }
683         if (OMX_DEBUG_ALGEBRA) {
684                 const char *name = "?";
685                 if (matrix->name) name = matrix->name;
686                 mxLog("Matrix %s %s update", name, yes? "needs" : "does not need");
687         }
688         return yes;
689 }
690
691 static void maybeCompute(omxMatrix *matrix, int want)
692 {
693         if(matrix->numPopulateLocations > 0) omxPopulateSubstitutions(matrix);
694         else if(!omxNeedsUpdate(matrix)) /* do nothing */;
695         else if(matrix->algebra != NULL) omxAlgebraRecompute(matrix->algebra);
696         else if(matrix->fitFunction != NULL) {
697                 omxFitFunctionCompute(matrix->fitFunction, want, NULL);
698         }
699 }
700
701 void omxRecompute(omxMatrix *matrix)
702 {
703         maybeCompute(matrix, FF_COMPUTE_FIT);
704 }
705
706 void omxInitialCompute(omxMatrix *matrix)
707 {
708         if(matrix->numPopulateLocations > 0) omxPopulateSubstitutions(matrix);
709         else if(!omxNeedsUpdate(matrix)) /* do nothing */;
710         else if(matrix->algebra != NULL) omxAlgebraInitialCompute(matrix->algebra);
711         else if(matrix->fitFunction != NULL) {
712                 omxFitFunctionCompute(matrix->fitFunction, 0, NULL);
713         }
714 }
715
716 void omxForceCompute(omxMatrix *matrix) {
717         if(matrix->numPopulateLocations > 0) omxPopulateSubstitutions(matrix);
718         else if (matrix->algebra != NULL) omxAlgebraForceCompute(matrix->algebra);
719         else if(matrix->fitFunction != NULL) {
720                 omxFitFunctionCompute(matrix->fitFunction, FF_COMPUTE_FIT, NULL);
721         }
722 }
723
724 /*
725  * omxShallowInverse
726  *                      Calculates the inverse of (I-A) using an n-step Neumann series
727  * Assumes that A reduces to all zeros after numIters steps
728  *
729  * params:
730  * omxMatrix *A                         : The A matrix.  I-A will be inverted.  Size MxM.
731  * omxMatrix *Z                         : On output: Computed (I-A)^-1. MxM.
732  * omxMatrix *Ax                        : Space for computation. MxM.
733  * omxMatrix *I                         : Identity matrix. Will not be changed on exit. MxM.
734  */
735
736 void omxShallowInverse(int numIters, omxMatrix* A, omxMatrix* Z, omxMatrix* Ax, omxMatrix* I ) {
737
738         omxMatrix* origZ = Z;
739     double oned = 1, minusOned = -1.0;
740
741         if(numIters == NA_INTEGER) {
742                 if(OMX_DEBUG_ALGEBRA) { mxLog("RAM Algebra (I-A) inversion using standard (general) inversion."); }
743
744                 /* Z = (I-A)^-1 */
745                 if(I->colMajor != A->colMajor) {
746                         omxTransposeMatrix(I);  // transpose I? Hm? TODO
747                 }
748                 omxCopyMatrix(Z, A);
749
750                 omxDGEMM(FALSE, FALSE, oned, I, I, minusOned, Z);
751
752                 Matrix Zmat(Z);
753                 int info = MatrixInvert1(Zmat);
754                 if (info) {
755                         omxRaiseErrorf(A->currentState, "(I-A) is exactly singular (info=%d)", info);
756                         return;
757                 }
758
759                 if(OMX_DEBUG_ALGEBRA) {omxPrint(Z, "Z");}
760
761         } else {
762
763                 if(OMX_DEBUG_ALGEBRA) { mxLog("RAM Algebra (I-A) inversion using optimized expansion."); }
764
765                 /* Taylor Expansion optimized I-A calculation */
766                 if(I->colMajor != A->colMajor) {
767                         omxTransposeMatrix(I);
768                 }
769
770                 if(I->colMajor != Ax->colMajor) {
771                         omxTransposeMatrix(Ax);
772                 }
773
774                 omxCopyMatrix(Z, A);
775
776                 /* Optimized I-A inversion: Z = (I-A)^-1 */
777                 // F77_CALL(omxunsafedgemm)(I->majority, A->majority, &(I->cols), &(I->rows), &(A->rows), &oned, I->data, &(I->cols), I->data, &(I->cols), &oned, Z->data, &(Z->cols));  // Z = I + A = A^0 + A^1
778                 // omxDGEMM(FALSE, FALSE, 1.0, I, I, 1.0, Z); // Z == A + I
779
780                 for(int i = 0; i < A->rows; i++)
781                         omxSetMatrixElement(Z, i, i, 1);
782
783                 for(int i = 1; i <= numIters; i++) { // TODO: Efficiently determine how many times to do this
784                         // The sequence goes like this: (I + A), I + (I + A) * A, I + (I + (I + A) * A) * A, ...
785                         // Which means only one DGEMM per iteration.
786                         if(OMX_DEBUG_ALGEBRA) { mxLog("....RAM: Iteration #%d/%d", i, numIters);}
787                         omxCopyMatrix(Ax, I);
788                         // F77_CALL(omxunsafedgemm)(A->majority, A->majority, &(Z->cols), &(Z->rows), &(A->rows), &oned, Z->data, &(Z->cols), A->data, &(A->cols), &oned, Ax->data, &(Ax->cols));  // Ax = Z %*% A + I
789                         omxDGEMM(FALSE, FALSE, oned, A, Z, oned, Ax);
790                         omxMatrix* m = Z; Z = Ax; Ax = m;       // Juggle to make Z equal to Ax
791                 }
792                 if(origZ != Z) {        // Juggling has caused Ax and Z to swap
793                         omxCopyMatrix(Z, Ax);
794                 }
795         }
796 }
797
798 double omxMaxAbsDiff(omxMatrix *m1, omxMatrix *m2)
799 {
800         if (m1->rows != m2->rows || m1->cols != m2->cols) Rf_error("Matrices are not the same size");
801
802         double mad = 0;
803         int size = m1->rows * m1->cols;
804         for (int dx=0; dx < size; ++dx) {
805                 double mad1 = fabs(m1->data[dx] - m2->data[dx]);
806                 if (mad < mad1) mad = mad1;
807         }
808         return mad;
809 }