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