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