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