Remove non-reproducable pointer addresses from logs
[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) 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) error("All matrices should be column major"); // remove option TODO
64         if (om) 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) 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 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 PROTECT'd SEXP for the R matrix object
209  */
210 SEXP omxExportMatrix(omxMatrix *om) {
211         SEXP nextMat;
212         PROTECT(nextMat = 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         // Always Recompute() before you Resize().
260         if(OMX_DEBUG_MATRIX) { 
261                 mxLog("Resizing matrix from (%d, %d) to (%d, %d) (keepMemory: %d)", 
262                         om->rows, om->cols, 
263                         nrows, ncols, keepMemory);
264         }
265         if((keepMemory == FALSE) && (om->rows != nrows || om->cols != ncols)) {
266                 if(OMX_DEBUG_MATRIX) { mxLog(" and regenerating memory to do it"); }
267                 omxFreeMatrixData(om);
268                 om->data = (double*) Calloc(nrows * ncols, double);
269         } else if(om->originalRows * om->originalCols < nrows * ncols) {
270                 warning("Upsizing an existing matrix may cause undefined behavior.\n"); // TODO: Define this behavior?
271         }
272
273         if(OMX_DEBUG_MATRIX) { mxLog("."); }
274         om->rows = nrows;
275         om->cols = ncols;
276         if(keepMemory == FALSE) {
277                 om->originalRows = om->rows;
278                 om->originalCols = om->cols;
279         }
280
281         omxMatrixLeadingLagging(om);
282 }
283
284 void omxResetAliasedMatrix(omxMatrix *om) {
285         om->rows = om->originalRows;
286         om->cols = om->originalCols;
287         if(om->aliasedPtr != NULL) {
288                 memcpy(om->data, om->aliasedPtr->data, om->rows*om->cols*sizeof(double));
289                 om->colMajor = om->aliasedPtr->colMajor;
290         }
291         omxMatrixLeadingLagging(om);
292 }
293
294 double* omxLocationOfMatrixElement(omxMatrix *om, int row, int col) {
295         int index = 0;
296         if(om->colMajor) {
297                 index = col * om->rows + row;
298         } else {
299                 index = row * om->cols + col;
300         }
301         return om->data + index;
302 }
303
304 void vectorElementError(int index, int numrow, int numcol) {
305         char *errstr = (char*) calloc(250, sizeof(char));
306         if ((numrow > 1) && (numcol > 1)) {
307                 sprintf(errstr, "Requested improper index (%d) from a malformed vector of dimensions (%d, %d).", 
308                         index, numrow, numcol);
309         } else {
310                 int length = (numrow > 1) ? numrow : numcol;
311                 sprintf(errstr, "Requested improper index (%d) from vector of length (%d).", 
312                         index, length);
313         }
314         error(errstr);
315         free(errstr);  // TODO not reached
316 }
317
318 void setMatrixError(omxMatrix *om, int row, int col, int numrow, int numcol) {
319         char *errstr = (char*) calloc(250, sizeof(char));
320         static const char *matrixString = "matrix";
321         static const char *algebraString = "algebra";
322         static const char *fitString = "fit function";
323         const char *typeString;
324         if (om->algebra != NULL) {
325                 typeString = algebraString;
326         } else if (om->fitFunction != NULL) {
327                 typeString = fitString;
328         } else {
329                 typeString = matrixString;
330         }
331         if (om->name == NULL) {
332                 sprintf(errstr, "Attempted to set row and column (%d, %d) in %s with dimensions %d x %d.", 
333                         row, col, typeString, numrow, numcol);
334         } else {
335                 sprintf(errstr, "Attempted to set row and column (%d, %d) in %s \"%s\" with dimensions %d x %d.", 
336                         row, col, typeString, om->name, numrow, numcol);
337         }
338         error(errstr);
339         free(errstr);  // TODO not reached
340 }
341
342 void matrixElementError(int row, int col, int numrow, int numcol) {
343         error("Requested improper value (%d, %d) from (%d, %d) matrix", row, col, numrow, numcol);
344 }
345
346 void setVectorError(int index, int numrow, int numcol) {
347         char *errstr = (char*) calloc(250, sizeof(char));
348         if ((numrow > 1) && (numcol > 1)) {
349                 sprintf(errstr, "Attempting to set improper index (%d) from a malformed vector of dimensions (%d, %d).", 
350                         index, numrow, numcol);
351         } else {
352                 int length = (numrow > 1) ? numrow : numcol;
353                 sprintf(errstr, "Setting improper index (%d) from vector of length %d.", 
354                         index, length);
355         }
356         error(errstr);
357         free(errstr);  // TODO not reached
358 }
359
360 double omxAliasedMatrixElement(omxMatrix *om, int row, int col) {
361         int index = 0;
362         if(row >= om->originalRows || col >= om->originalCols) {
363                 char *errstr = (char*) calloc(250, sizeof(char));
364                 sprintf(errstr, "Requested improper value (%d, %d) from (%d, %d) matrix.", 
365                         row + 1, col + 1, om->originalRows, om->originalCols);
366                 error(errstr);
367                 free(errstr);  // TODO not reached
368         return (NA_REAL);
369         }
370         if(om->colMajor) {
371                 index = col * om->originalRows + row;
372         } else {
373                 index = row * om->originalCols + col;
374         }
375         return om->data[index];
376 }
377
378 void omxMarkDirty(omxMatrix *om) { om->version += 1; }
379 void omxMarkClean(omxMatrix *om) { om->version += 1; om->cleanVersion = om->version; }
380
381 omxMatrix* omxNewMatrixFromRPrimitive(SEXP rObject, omxState* state, 
382         unsigned short hasMatrixNumber, int matrixNumber) {
383 /* Creates and populates an omxMatrix with details from an R matrix object. */
384         omxMatrix *om = NULL;
385         om = omxInitMatrix(NULL, 0, 0, TRUE, state);
386         return omxFillMatrixFromRPrimitive(om, rObject, state, hasMatrixNumber, matrixNumber);
387 }
388
389 omxMatrix* omxFillMatrixFromRPrimitive(omxMatrix* om, SEXP rObject, omxState* state,
390         unsigned short hasMatrixNumber, int matrixNumber) {
391 /* Populates the fields of a omxMatrix with details from an R object. */
392         if(!isMatrix(rObject) && !isVector(rObject)) { // Sanity Check
393                 error("Recieved unknown matrix type in omxFillMatrixFromRPrimitive.");
394         }
395         return(fillMatrixHelperFunction(om, rObject, state, hasMatrixNumber, matrixNumber));
396 }
397
398
399
400 static omxMatrix* fillMatrixHelperFunction(omxMatrix* om, SEXP matrix, omxState* state,
401         unsigned short hasMatrixNumber, int matrixNumber) {
402
403         int* dimList;
404
405         if(OMX_DEBUG) { mxLog("Filling omxMatrix from R matrix."); }
406
407         if (!om) error("fillMatrixHelperFunction: matrix must be allocated already");
408
409         if(isMatrix(matrix)) {
410                 SEXP matrixDims;
411                 PROTECT(matrixDims = getAttrib(matrix, R_DimSymbol));
412                 dimList = INTEGER(matrixDims);
413                 om->rows = dimList[0];
414                 om->cols = dimList[1];
415                 UNPROTECT(1); // matrixDims
416         } else if (isVector(matrix)) {          // If it's a vector, assume it's a row vector. BLAS doesn't care.
417                 if(OMX_DEBUG) { mxLog("Vector discovered.  Assuming rowity."); }
418                 om->rows = 1;
419                 om->cols = length(matrix);
420         }
421         if(OMX_DEBUG) { mxLog("Matrix connected to (%d, %d) matrix or MxMatrix.", om->rows, om->cols); }
422
423         if (TYPEOF(matrix) != REALSXP) {
424                 // we could avoid a double copy here TODO
425                 SEXP copy;
426                 PROTECT(copy = coerceVector(matrix, REALSXP));
427                 om->data = (double*) Realloc(NULL, om->rows * om->cols, double);
428                 memcpy(om->data, REAL(copy), om->rows * om->cols * sizeof(double));
429         } else {
430                 om->owner = matrix;
431                 om->data = REAL(om->owner);
432         }
433
434         om->colMajor = TRUE;
435         om->originalRows = om->rows;
436         om->originalCols = om->cols;
437         om->originalColMajor = TRUE;
438         om->aliasedPtr = NULL;
439         om->algebra = NULL;
440         om->fitFunction = NULL;
441         om->currentState = state;
442         om->hasMatrixNumber = hasMatrixNumber;
443         om->matrixNumber = matrixNumber;
444         om->version = 1;
445         omxMarkClean(om);
446
447         if(OMX_DEBUG) { mxLog("Pre-compute call.");}
448         omxMatrixLeadingLagging(om);
449         if(OMX_DEBUG) { mxLog("Post-compute call.");}
450
451         if(OMX_DEBUG) {
452                 omxPrintMatrix(om, "Finished importing matrix");
453         }
454
455         return om;
456 }
457
458 void omxProcessMatrixPopulationList(omxMatrix* matrix, SEXP matStruct) {
459
460         if(OMX_DEBUG) { mxLog("Processing Population List: %d elements.", length(matStruct) - 1); }
461
462         if(length(matStruct) > 1) {
463                 int numPopLocs = length(matStruct) - 1;
464                 matrix->numPopulateLocations = numPopLocs;
465                 matrix->populateFrom = (int*)R_alloc(numPopLocs, sizeof(int));
466                 matrix->populateFromRow = (int*)R_alloc(numPopLocs, sizeof(int));
467                 matrix->populateFromCol = (int*)R_alloc(numPopLocs, sizeof(int));
468                 matrix->populateToRow = (int*)R_alloc(numPopLocs, sizeof(int));
469                 matrix->populateToCol = (int*)R_alloc(numPopLocs, sizeof(int));
470         }
471
472         for(int i = 0; i < length(matStruct)-1; i++) {
473                 SEXP subList;
474                 PROTECT(subList = AS_INTEGER(VECTOR_ELT(matStruct, i+1)));
475
476                 int* locations = INTEGER(subList);
477                 if(OMX_DEBUG) { mxLog("."); } //:::
478                 matrix->populateFrom[i] = locations[0];
479                 matrix->populateFromRow[i] = locations[1];
480                 matrix->populateFromCol[i] = locations[2];
481                 matrix->populateToRow[i] = locations[3];
482                 matrix->populateToCol[i] = locations[4];
483                 UNPROTECT(1); //subList
484         }
485 }
486
487 void omxToggleRowColumnMajor(omxMatrix *mat) {
488
489         int i, j;
490         int nrows = mat->rows;
491         int ncols = mat->cols;
492         
493         double *newdata = (double*) Calloc(nrows * ncols, double);
494         double *olddata = mat->data;
495
496         if (mat->colMajor) {
497                 for(i = 0; i < ncols; i++) {
498                         for(j = 0; j < nrows; j++) {
499                                 newdata[i + ncols * j] = olddata[i * nrows + j];
500                         }
501                 }
502         } else {
503                 for(i = 0; i < nrows; i++) {
504                         for(j = 0; j < ncols; j++) {
505                                 newdata[i + nrows * j] = olddata[i * ncols + j];
506                         }
507                 }
508         }
509
510         omxFreeMatrixData(mat);
511         mat->data = newdata;
512         mat->colMajor = !mat->colMajor;
513 }
514
515 void omxTransposeMatrix(omxMatrix *mat) {
516         mat->colMajor = !mat->colMajor;
517         
518         if(mat->rows != mat->cols){
519         int mid = mat->rows;
520         mat->rows = mat->cols;
521         mat->cols = mid;
522         }
523         
524         omxMatrixLeadingLagging(mat);
525 }
526
527 void omxRemoveElements(omxMatrix *om, int numRemoved, int removed[]) {
528
529         if(numRemoved < 1) { return; }
530
531         int oldElements;
532
533         if (om->rows > 1) {
534                 if(om->aliasedPtr == NULL) {
535                         if(om->originalRows == 0) {
536                                 om->originalRows = om->rows;
537                         }
538                         oldElements = om->originalRows;
539                 } else {
540                         oldElements = om->aliasedPtr->rows;
541                 }
542                 om->rows = oldElements - numRemoved;
543         } else {
544                 if(om->aliasedPtr == NULL) {
545                         if(om->originalCols == 0) {
546                                 om->originalCols = om->cols;
547                         }
548                         oldElements = om->originalCols;
549                 } else {
550                         oldElements = om->aliasedPtr->cols;
551                 }
552                 om->cols = oldElements - numRemoved;
553         }
554
555         int nextElement = 0;
556
557         for(int j = 0; j < oldElements; j++) {
558                 if(!removed[j]) {
559                         if(om->aliasedPtr == NULL) {
560                                 omxUnsafeSetVectorElement(om, nextElement, omxUnsafeVectorElement(om, j));
561                         } else {
562                                 omxUnsafeSetVectorElement(om, nextElement, omxUnsafeVectorElement(om->aliasedPtr, j));
563                         }
564                         nextElement++;
565                 }
566         }
567
568         omxMatrixLeadingLagging(om);
569 }
570
571 void omxRemoveRowsAndColumns(omxMatrix *om, int numRowsRemoved, int numColsRemoved, int rowsRemoved[], int colsRemoved[])
572 {
573     // TODO: Create short-circuit form of omxRemoveRowsAndCols to remove just rows or just columns.
574
575         if(numRowsRemoved < 1 && numColsRemoved < 1) { return; }
576
577         int oldRows, oldCols;
578
579         if(om->aliasedPtr == NULL) {
580                 if(om->originalRows == 0 || om->originalCols == 0) {
581                         om->originalRows = om->rows;
582                         om->originalCols = om->cols;
583                 }
584                 oldRows = om->originalRows;
585                 oldCols = om->originalCols;
586         } else {
587                 oldRows = om->aliasedPtr->rows;
588                 oldCols = om->aliasedPtr->cols;
589         }
590
591         int nextCol = 0;
592         int nextRow = 0;
593
594         if(om->rows > om->originalRows || om->cols > om->originalCols) {        // sanity check.
595                 error("Aliased Matrix is too small for alias.");
596         }
597
598         om->rows = oldRows - numRowsRemoved;
599         om->cols = oldCols - numColsRemoved;
600
601         // Note:  This really aught to be done using a matrix multiply.  Why isn't it?
602         for(int j = 0; j < oldCols; j++) {
603                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Handling column %d/%d...", j, oldCols);}
604                 if(colsRemoved[j]) {
605                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Removed.");}
606                         continue;
607                 } else {
608                         nextRow = 0;
609                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Rows (max %d): ", oldRows); }
610                         for(int k = 0; k < oldRows; k++) {
611                                 if(rowsRemoved[k]) {
612                                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("%d removed....", k);}
613                                         continue;
614                                 } else {
615                                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("%d kept....", k);}
616                                         if(om->aliasedPtr == NULL) {
617                                                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { mxLog("Self-aliased matrix access.");}
618                                                 omxSetMatrixElement(om, nextRow, nextCol, omxAliasedMatrixElement(om, k, j));
619                                         } else {
620                                                 omxSetMatrixElement(om, nextRow, nextCol, omxMatrixElement(om->aliasedPtr, k,  j));
621                                         }
622                                         nextRow++;
623                                 }
624                         }
625                         nextCol++;
626                 }
627         }
628
629         omxMatrixLeadingLagging(om);
630 }
631
632 /* Function wrappers that switch based on inclusion of algebras */
633 void omxPrint(omxMatrix *source, const char* d) {                                       // Pretty-print a (small) matrix
634     if(source == NULL) mxLog("%s is NULL.", d);
635         else if(source->algebra != NULL) omxAlgebraPrint(source->algebra, d);
636         else if(source->fitFunction != NULL) omxFitFunctionPrint(source->fitFunction, d);
637         else omxPrintMatrix(source, d);
638 }
639
640 void omxPopulateSubstitutions(omxMatrix *om) {
641         for(int i = 0; i < om->numPopulateLocations; i++) {
642                 int index = om->populateFrom[i];
643                 omxMatrix* sourceMatrix;
644                 if (index < 0) {
645                         sourceMatrix = om->currentState->matrixList[~index];
646                 } else {
647                         sourceMatrix = om->currentState->algebraList[index];
648                 }
649                 if (sourceMatrix != NULL) {
650                         omxRecompute(sourceMatrix);                             // Make sure it's up to date
651                         double value = omxMatrixElement(sourceMatrix, om->populateFromRow[i], om->populateFromCol[i]);
652                         omxSetMatrixElement(om, om->populateToRow[i], om->populateToCol[i], value);
653                 }
654         }
655 }
656
657 void omxMatrixLeadingLagging(omxMatrix *om) {
658         om->majority = &(omxMatrixMajorityList[(om->colMajor?1:0)]);
659         om->minority = &(omxMatrixMajorityList[(om->colMajor?0:1)]);
660         om->leading = (om->colMajor?om->rows:om->cols);
661         om->lagging = (om->colMajor?om->cols:om->rows);
662 }
663
664 unsigned short omxNeedsUpdate(omxMatrix *matrix) {
665         bool yes;
666         if (matrix->hasMatrixNumber && omxMatrixIsClean(matrix)) {
667                 yes = FALSE;
668         } else {
669                 yes = TRUE;
670         }
671         const char *name = "?";
672         if (matrix->name) name = matrix->name;
673         if (OMX_DEBUG_ALGEBRA) {
674                 mxLog("Matrix %s %s update", name, yes? "needs" : "does not need");
675         }
676         return yes;
677 }
678
679 static void maybeCompute(omxMatrix *matrix, int want)
680 {
681         if(matrix->numPopulateLocations > 0) omxPopulateSubstitutions(matrix);
682         else if(!omxNeedsUpdate(matrix)) /* do nothing */;
683         else if(matrix->algebra != NULL) omxAlgebraRecompute(matrix->algebra);
684         else if(matrix->fitFunction != NULL) {
685                 omxFitFunctionCompute(matrix->fitFunction, want, NULL);
686         }
687 }
688
689 void omxRecompute(omxMatrix *matrix)
690 {
691         maybeCompute(matrix, FF_COMPUTE_FIT);
692 }
693
694 void omxInitialCompute(omxMatrix *matrix)
695 {
696         maybeCompute(matrix, 0);
697 }
698
699 void omxForceCompute(omxMatrix *matrix) {
700         if(matrix->numPopulateLocations > 0) omxPopulateSubstitutions(matrix);
701         else if (matrix->algebra != NULL) omxAlgebraForceCompute(matrix->algebra);
702         else if(matrix->fitFunction != NULL) {
703                 omxFitFunctionCompute(matrix->fitFunction, FF_COMPUTE_FIT, NULL);
704         }
705 }
706
707 /*
708  * omxShallowInverse
709  *                      Calculates the inverse of (I-A) using an n-step Neumann series
710  * Assumes that A reduces to all zeros after numIters steps
711  *
712  * params:
713  * omxMatrix *A                         : The A matrix.  I-A will be inverted.  Size MxM.
714  * omxMatrix *Z                         : On output: Computed (I-A)^-1. MxM.
715  * omxMatrix *Ax                        : Space for computation. MxM.
716  * omxMatrix *I                         : Identity matrix. Will not be changed on exit. MxM.
717  */
718
719 void omxShallowInverse(int numIters, omxMatrix* A, omxMatrix* Z, omxMatrix* Ax, omxMatrix* I ) {
720
721         omxMatrix* origZ = Z;
722     double oned = 1, minusOned = -1.0;
723
724         if(numIters == NA_INTEGER) {
725                 if(OMX_DEBUG_ALGEBRA) { mxLog("RAM Algebra (I-A) inversion using standard (general) inversion."); }
726
727                 /* Z = (I-A)^-1 */
728                 if(I->colMajor != A->colMajor) {
729                         omxTransposeMatrix(I);  // transpose I? Hm? TODO
730                 }
731                 omxCopyMatrix(Z, A);
732
733                 omxDGEMM(FALSE, FALSE, oned, I, I, minusOned, Z);
734
735                 Matrix Zmat(Z);
736                 int info = MatrixInvert1(Zmat);
737                 if (info) {
738                         omxRaiseErrorf(A->currentState, "(I-A) is exactly singular (info=%d)", info);
739                         return;
740                 }
741
742                 if(OMX_DEBUG_ALGEBRA) {omxPrint(Z, "Z");}
743
744         } else {
745
746                 if(OMX_DEBUG_ALGEBRA) { mxLog("RAM Algebra (I-A) inversion using optimized expansion."); }
747
748                 /* Taylor Expansion optimized I-A calculation */
749                 if(I->colMajor != A->colMajor) {
750                         omxTransposeMatrix(I);
751                 }
752
753                 if(I->colMajor != Ax->colMajor) {
754                         omxTransposeMatrix(Ax);
755                 }
756
757                 omxCopyMatrix(Z, A);
758
759                 /* Optimized I-A inversion: Z = (I-A)^-1 */
760                 // 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
761                 // omxDGEMM(FALSE, FALSE, 1.0, I, I, 1.0, Z); // Z == A + I
762
763                 for(int i = 0; i < A->rows; i++)
764                         omxSetMatrixElement(Z, i, i, 1);
765
766                 for(int i = 1; i <= numIters; i++) { // TODO: Efficiently determine how many times to do this
767                         // The sequence goes like this: (I + A), I + (I + A) * A, I + (I + (I + A) * A) * A, ...
768                         // Which means only one DGEMM per iteration.
769                         if(OMX_DEBUG_ALGEBRA) { mxLog("....RAM: Iteration #%d/%d", i, numIters);}
770                         omxCopyMatrix(Ax, I);
771                         // 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
772                         omxDGEMM(FALSE, FALSE, oned, A, Z, oned, Ax);
773                         omxMatrix* m = Z; Z = Ax; Ax = m;       // Juggle to make Z equal to Ax
774                 }
775                 if(origZ != Z) {        // Juggling has caused Ax and Z to swap
776                         omxCopyMatrix(Z, Ax);
777                 }
778         }
779 }
780
781 double omxMaxAbsDiff(omxMatrix *m1, omxMatrix *m2)
782 {
783         if (m1->rows != m2->rows || m1->cols != m2->cols) error("Matrices are not the same size");
784
785         double mad = 0;
786         int size = m1->rows * m1->cols;
787         for (int dx=0; dx < size; ++dx) {
788                 double mad1 = fabs(m1->data[dx] - m2->data[dx]);
789                 if (mad < mad1) mad = mad1;
790         }
791         return mad;
792 }