More changes to parallel FIML.
[openmx:openmx.git] / src / omxMatrix.c
1 /*
2  *  Copyright 2007-2009 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
30 // forward declarations
31 omxMatrix* fillMatrixHelperFunction(omxMatrix* om, SEXP matrix, omxState* state,
32         unsigned short hasMatrixNumber, int matrixNumber);
33
34 const char omxMatrixMajorityList[3] = "Tn";             // BLAS Column Majority.
35
36 void omxPrintMatrix(omxMatrix *source, char* header) {
37         int j, k;
38
39         Rprintf("%s: (%d x %d) [%s-major]\n", header, source->rows, source->cols, (source->colMajor?"col":"row"));
40         if(OMX_DEBUG_MATRIX) {Rprintf("Matrix Printing is at %0x\n", source);}
41
42         if(source->colMajor) {
43                 for(j = 0; j < source->rows; j++) {
44                         for(k = 0; k < source->cols; k++) {
45                                 Rprintf("\t%3.6f", source->data[k*source->rows+j]);
46                         }
47                         Rprintf("\n");
48                 }
49         } else {
50                 for(j = 0; j < source->cols; j++) {
51                         for(k = 0; k < source->rows; k++) {
52                                 Rprintf("\t%3.6f", source->data[k*source->cols+j]);
53                         }
54                         Rprintf("\n");
55                 }
56         }
57 }
58
59 omxMatrix* omxInitMatrix(omxMatrix* om, int nrows, int ncols, unsigned short isColMajor, omxState* os) {
60
61         if(om == NULL) om = (omxMatrix*) R_alloc(1, sizeof(omxMatrix));
62         if(OMX_DEBUG_MATRIX) { Rprintf("Initializing matrix 0x%0x to (%d, %d) with state at 0x%x.\n", om, nrows, ncols, os); }
63
64         om->rows = nrows;
65         om->cols = ncols;
66         om->colMajor = (isColMajor?1:0);
67
68         om->originalRows = om->rows;
69         om->originalCols = om->cols;
70         om->originalColMajor=om->colMajor;
71
72         if(om->rows == 0 || om->cols == 0) {
73                 om->data = NULL;
74                 om->localData = FALSE;
75         } else {
76                 om->data = (double*) Calloc(nrows * ncols, double);
77                 om->localData = TRUE;
78         }
79
80         om->populateFrom = NULL;
81         om->populateFromCol = NULL;
82         om->populateFromRow = NULL;
83         om->populateToCol = NULL;
84         om->populateToRow = NULL;
85
86         om->numPopulateLocations = 0;
87
88         om->aliasedPtr = NULL;
89         om->algebra = NULL;
90         om->objective = NULL;
91
92         om->currentState = os;
93         om->lastCompute = -2;
94         om->lastRow = -2;
95         om->isTemporary = FALSE;
96
97         omxMatrixCompute(om);
98
99         return om;
100
101 }
102
103 omxMatrix* omxInitTemporaryMatrix(omxMatrix* om, int nrows, int ncols, unsigned short isColMajor, omxState* os) {
104
105         if(om == NULL) {
106                 om = (omxMatrix*) Calloc(1, omxMatrix);
107         }
108
109         om = omxInitMatrix(om, nrows, ncols, isColMajor, os);
110         om->isTemporary = TRUE;
111         
112         return(om);
113
114 }
115
116 void omxCopyMatrix(omxMatrix *dest, omxMatrix *orig) {
117         /* Copy a matrix.  NOTE: Matrix maintains its algebra bindings. */
118
119         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("omxCopyMatrix"); }
120
121         int regenerateMemory = TRUE;
122
123         if(dest->localData && (dest->originalRows == orig->rows && dest->originalCols == orig->cols)) {
124                 regenerateMemory = FALSE;                               // If it's local data and the right size, we can keep memory.
125         }
126
127         dest->rows = orig->rows;
128         dest->cols = orig->cols;
129         dest->colMajor = orig->colMajor;
130         dest->originalRows = dest->rows;
131         dest->originalCols = dest->cols;
132         dest->originalColMajor = dest->colMajor;
133         dest->lastCompute = orig->lastCompute;
134         dest->lastRow = orig->lastRow;
135
136         if(dest->rows == 0 || dest->cols == 0) {
137                 omxFreeMatrixData(dest);
138                 dest->data = NULL;
139                 dest->localData=FALSE;
140         } else {
141                 if(regenerateMemory) {
142                         omxFreeMatrixData(dest);                                                                                        // Free and regenerate memory
143                         dest->data = (double*) Calloc(dest->rows * dest->cols, double);
144                 }
145                 memcpy(dest->data, orig->data, dest->rows * dest->cols * sizeof(double));
146                 dest->localData = TRUE;
147         }
148
149         dest->aliasedPtr = NULL;
150
151         omxMatrixCompute(dest);
152
153 }
154
155 void omxAliasMatrix(omxMatrix *dest, omxMatrix *src) {
156         omxCopyMatrix(dest, src);
157         dest->aliasedPtr = src;                                 // Alias now follows back matrix precisely.
158 }
159
160 void omxFreeMatrixData(omxMatrix * om) {
161
162         if(om->localData && om->data != NULL) {
163                 if(OMX_DEBUG_MATRIX) { Rprintf("Freeing matrix at 0x%0x. Localdata = %d.\n", om->data, om->localData); }
164                 Free(om->data);
165                 om->data = NULL;
166                 om->localData = FALSE;
167         }
168
169 }
170
171 void omxFreeAllMatrixData(omxMatrix *om) {
172     
173     if(om == NULL) return;
174
175         if(OMX_DEBUG) { 
176             Rprintf("Freeing matrix at 0x%0x with data = 0x%x, algebra 0x%x, and objective 0x%x.\n", 
177                 om, om->data, om->algebra); 
178         }
179
180         if(om->localData && om->data != NULL) {
181                 Free(om->data);
182                 om->data = NULL;
183                 om->localData = FALSE;
184         }
185
186         if(om->algebra != NULL) {
187                 omxFreeAlgebraArgs(om->algebra);
188                 om->algebra = NULL;
189         }
190
191         if(om->objective != NULL) {
192                 omxFreeObjectiveArgs(om->objective);
193                 om->objective = NULL;
194         }
195         
196         if(om->isTemporary) {
197                 Free(om);
198                 om = NULL;
199         }
200
201 }
202
203 void omxZeroByZeroMatrix(omxMatrix *om) {
204         if (om->rows > 0 || om->cols > 0) {
205                 omxResizeMatrix(om, 0, 0, FALSE);
206         }
207 }
208
209 omxMatrix* omxNewIdentityMatrix(int nrows, omxState* state) {
210         omxMatrix* newMat = NULL;
211         int l,k;
212
213         newMat = omxInitMatrix(newMat, nrows, nrows, FALSE, state);
214         for(k =0; k < newMat->rows; k++) {
215                 for(l = 0; l < newMat->cols; l++) {
216                         if(l == k) {
217                                 omxSetMatrixElement(newMat, k, l, 1);
218                         } else {
219                                 omxSetMatrixElement(newMat, k, l, 0);
220                         }
221                 }
222         }
223         return newMat;
224 }
225
226 void omxUpdateMatrix(omxMatrix* tgt, omxMatrix* src) {
227         tgt->isDirty     = src->isDirty;
228         tgt->lastCompute = src->lastCompute;
229         tgt->lastRow     = src->lastRow;
230 }
231
232
233 omxMatrix* omxDuplicateMatrix(omxMatrix* src, omxState* newState, short fullCopy) {
234     omxMatrix* newMat;
235     
236     if(src == NULL) return NULL;
237     newMat = omxInitMatrix(NULL, src->rows, src->cols, FALSE, newState);
238     omxCopyMatrix(newMat, src);
239         newMat->hasMatrixNumber = src->hasMatrixNumber;
240         newMat->matrixNumber    = src->matrixNumber;
241     
242     return newMat;    
243 }
244
245 void omxResizeMatrix(omxMatrix *om, int nrows, int ncols, unsigned short keepMemory) {
246         // Always Recompute() before you Resize().
247         if(OMX_DEBUG_MATRIX) { 
248                 Rprintf("Resizing matrix from (%d, %d) to (%d, %d) (keepMemory: %d)", 
249                         om->rows, om->cols, 
250                         nrows, ncols, keepMemory);
251         }
252         if((keepMemory == FALSE) && (om->rows != nrows || om->cols != ncols)) {
253                 if(OMX_DEBUG_MATRIX) { Rprintf(" and regenerating memory to do it"); }
254                 omxFreeMatrixData(om);
255                 om->data = (double*) Calloc(nrows * ncols, double);
256                 om->localData = TRUE;
257         } else if(om->originalRows * om->originalCols < nrows * ncols) {
258                 warning("Upsizing an existing matrix may cause undefined behavior.\n"); // TODO: Define this behavior?
259         }
260
261         if(OMX_DEBUG_MATRIX) { Rprintf(".\n"); }
262         om->rows = nrows;
263         om->cols = ncols;
264         if(keepMemory == FALSE) {
265                 om->originalRows = om->rows;
266                 om->originalCols = om->cols;
267         }
268
269         omxMatrixCompute(om);
270 }
271
272 void omxResetAliasedMatrix(omxMatrix *om) {
273         om->rows = om->originalRows;
274         om->cols = om->originalCols;
275         if(om->aliasedPtr != NULL) {
276                 memcpy(om->data, om->aliasedPtr->data, om->rows*om->cols*sizeof(double));
277                 om->colMajor = om->aliasedPtr->colMajor;
278         }
279         omxMatrixCompute(om);
280 }
281
282 void omxMatrixCompute(omxMatrix *om) {
283
284         if(OMX_DEBUG_MATRIX) { Rprintf("Matrix compute: 0x%0x, 0x%0x, algebra: 0x%x.\n", om, om->currentState, om->algebra); }
285         om->majority = &(omxMatrixMajorityList[(om->colMajor?1:0)]);
286         om->minority = &(omxMatrixMajorityList[(om->colMajor?0:1)]);
287         om->leading = (om->colMajor?om->rows:om->cols);
288         om->lagging = (om->colMajor?om->cols:om->rows);
289
290         for(int i = 0; i < om->numPopulateLocations; i++) {
291                 omxRecompute(om->populateFrom[i]);                              // Make sure it's up to date
292                 double value = omxMatrixElement(om->populateFrom[i], om->populateFromRow[i], om->populateFromCol[i]);
293                 omxSetMatrixElement(om, om->populateToRow[i], om->populateToCol[i], value);
294                 // And then fill in the details.  Use the Helper here in case of transposition/downsampling.
295         }
296
297         om->isDirty = FALSE;
298         om->lastCompute = om->currentState->computeCount;
299         om->lastRow = om->currentState->currentRow;
300
301 }
302
303 double* omxLocationOfMatrixElement(omxMatrix *om, int row, int col) {
304         int index = 0;
305         if(om->colMajor) {
306                 index = col * om->rows + row;
307         } else {
308                 index = row * om->cols + col;
309         }
310         return om->data + index;
311 }
312
313 void vectorElementError(int index, int numrow, int numcol) {
314         char *errstr = calloc(250, sizeof(char));
315         sprintf(errstr, "Requested improper index (%d) from (%d, %d) vector.", 
316                 index, numrow, numcol);
317         error(errstr);
318         free(errstr);
319 }
320
321 void setMatrixError(int row, int col, int numrow, int numcol) {
322         char *errstr = calloc(250, sizeof(char));
323         sprintf(errstr, "Attempted to set improper value (%d, %d) into (%d, %d) matrix.", 
324                 row, col, numrow, numcol);
325         error(errstr);
326         free(errstr);
327 }
328
329 void matrixElementError(int row, int col, int numrow, int numcol) {
330         char *errstr = calloc(250, sizeof(char));
331         sprintf(errstr, "Requested improper value (%d, %d) from (%d, %d) matrix.",
332                 row, col, numrow, numcol);
333         error(errstr);
334         free(errstr);
335 }
336
337 void setVectorError(int index, int numrow, int numcol) {
338         char *errstr = calloc(250, sizeof(char));
339         sprintf(errstr, "Setting improper index (%d) from (%d, %d) vector.", 
340                 index, numrow, numcol);
341         error(errstr);
342         free(errstr);
343 }
344
345 double omxAliasedMatrixElement(omxMatrix *om, int row, int col) {
346         int index = 0;
347         if(row >= om->originalRows || col >= om->originalCols) {
348                 char *errstr = calloc(250, sizeof(char));
349                 sprintf(errstr, "Requested improper value (%d, %d) from (%d, %d) matrix.", row+1, col+1, om->originalRows, om->originalCols);
350                 error(errstr);
351                 free(errstr);
352         return (NA_REAL);
353         }
354         if(om->colMajor) {
355                 index = col * om->originalRows + row;
356         } else {
357                 index = row * om->originalCols + col;
358         }
359         return om->data[index];
360 }
361
362 void omxMarkDirty(omxMatrix *om) { om->isDirty = TRUE; }
363
364 unsigned short omxMatrixNeedsUpdate(omxMatrix *om) {
365         for(int i = 0; i < om->numPopulateLocations; i++) {
366                 if(omxNeedsUpdate(om->populateFrom[i])) return TRUE;    // Make sure it's up to date
367         }
368     return FALSE;
369 };
370
371 omxMatrix* omxNewMatrixFromMxMatrix(SEXP mxMatrix, omxState* state) {
372 /* Creates and populates an omxMatrix with details from an R MxMatrix object. */
373         omxMatrix *om = NULL;
374         om = omxInitMatrix(NULL, 0, 0, FALSE, state);
375         return omxFillMatrixFromMxMatrix(om, mxMatrix, state);
376 }
377
378 omxMatrix* omxNewMatrixFromRPrimitive(SEXP rObject, omxState* state, 
379         unsigned short hasMatrixNumber, int matrixNumber) {
380 /* Creates and populates an omxMatrix with details from an R matrix object. */
381         omxMatrix *om = NULL;
382         om = omxInitMatrix(NULL, 0, 0, FALSE, state);
383         return omxFillMatrixFromRPrimitive(om, rObject, state, hasMatrixNumber, matrixNumber);
384 }
385
386 omxMatrix* omxFillMatrixFromMxMatrix(omxMatrix* om, SEXP mxMatrix, omxState* state) {
387 /* Populates the fields of a omxMatrix with details from an R Matrix. */
388         if(inherits(mxMatrix, "MxMatrix")) {
389                 if(OMX_DEBUG) { Rprintf("R matrix is Mx Matrix.  Processing.\n"); }
390                 SEXP matrix;
391                 PROTECT(matrix = GET_SLOT(mxMatrix,  install("values")));
392                 om = fillMatrixHelperFunction(om, matrix, state, 0, 0);
393                 UNPROTECT(1);
394         } else {
395                 error("Recieved unknown matrix type in omxFillMatrixFromMxMatrix.");
396         }
397         return(om);
398 }
399
400 omxMatrix* omxFillMatrixFromRPrimitive(omxMatrix* om, SEXP rObject, omxState* state,
401         unsigned short hasMatrixNumber, int matrixNumber) {
402 /* Populates the fields of a omxMatrix with details from an R object. */
403         if(!isMatrix(rObject) && !isVector(rObject)) { // Sanity Check
404                 error("Recieved unknown matrix type in omxFillMatrixFromRPrimitive.");
405         }
406         return(fillMatrixHelperFunction(om, rObject, state, hasMatrixNumber, matrixNumber));
407 }
408
409
410
411 omxMatrix* fillMatrixHelperFunction(omxMatrix* om, SEXP matrix, omxState* state,
412         unsigned short hasMatrixNumber, int matrixNumber) {
413
414         SEXP matrixDims;
415         int* dimList;
416
417         if(OMX_DEBUG) { Rprintf("Filling omxMatrix from R matrix.\n"); }
418
419         if(om == NULL) {
420                 om = omxInitMatrix(NULL, 0, 0, FALSE, state);
421         }
422
423         om->data = REAL(AS_NUMERIC(matrix));    // TODO: Class-check first?
424
425         if(isMatrix(matrix)) {
426                 PROTECT(matrixDims = getAttrib(matrix, R_DimSymbol));
427                 dimList = INTEGER(matrixDims);
428                 om->rows = dimList[0];
429                 om->cols = dimList[1];
430                 UNPROTECT(1);   // MatrixDims
431         } else if (isVector(matrix)) {          // If it's a vector, assume it's a row vector. BLAS doesn't care.
432                 if(OMX_DEBUG) { Rprintf("Vector discovered.  Assuming rowity.\n"); }
433                 om->rows = 1;
434                 om->cols = length(matrix);
435         }
436         if(OMX_DEBUG) { Rprintf("Matrix connected to (%d, %d) matrix or MxMatrix.\n", om->rows, om->cols); }
437
438         om->localData = FALSE;
439         om->colMajor = TRUE;
440         om->originalRows = om->rows;
441         om->originalCols = om->cols;
442         om->originalColMajor = TRUE;
443         om->aliasedPtr = NULL;
444         om->algebra = NULL;
445         om->objective = NULL;
446         om->currentState = state;
447         om->lastCompute = -1;
448         om->lastRow = -1;
449         om->hasMatrixNumber = hasMatrixNumber;
450         om->matrixNumber = matrixNumber;
451
452
453         if(OMX_DEBUG) { Rprintf("Pre-compute call.\n");}
454         omxMatrixCompute(om);
455         if(OMX_DEBUG) { Rprintf("Post-compute call.\n");}
456
457         if(OMX_DEBUG) {
458                 omxPrintMatrix(om, "Finished importing matrix");
459         }
460
461         return om;
462 }
463
464 void omxProcessMatrixPopulationList(omxMatrix* matrix, SEXP matStruct) {
465
466         if(OMX_DEBUG) { Rprintf("Processing Population List: %d elements.\n", length(matStruct) - 1); }
467         SEXP subList;
468
469         if(length(matStruct) > 1) {
470                 int numPopLocs = length(matStruct) - 1;
471                 matrix->numPopulateLocations = numPopLocs;
472                 matrix->populateFrom = (omxMatrix**)R_alloc(numPopLocs, sizeof(omxMatrix*));
473                 matrix->populateFromRow = (int*)R_alloc(numPopLocs, sizeof(int));
474                 matrix->populateFromCol = (int*)R_alloc(numPopLocs, sizeof(int));
475                 matrix->populateToRow = (int*)R_alloc(numPopLocs, sizeof(int));
476                 matrix->populateToCol = (int*)R_alloc(numPopLocs, sizeof(int));
477         }
478
479         for(int i = 0; i < length(matStruct)-1; i++) {
480                 PROTECT(subList = AS_INTEGER(VECTOR_ELT(matStruct, i+1)));
481
482                 int* locations = INTEGER(subList);
483                 int loc = locations[0];
484                 if(OMX_DEBUG) { Rprintf("."); } //:::
485                 if(loc < 0) {                   // NOTE: This duplicates some of the functionality of NewMatrixFromMxIndex
486                         matrix->populateFrom[i] = matrix->currentState->matrixList[(~loc)];
487                 } else {
488                         matrix->populateFrom[i] = matrix->currentState->algebraList[(loc)];
489                 }
490                 matrix->populateFromRow[i] = locations[1];
491                 matrix->populateFromCol[i] = locations[2];
492                 matrix->populateToRow[i] = locations[3];
493                 matrix->populateToCol[i] = locations[4];
494
495                 UNPROTECT(1); // subList
496         }
497 }
498
499 void omxToggleRowColumnMajor(omxMatrix *mat) {
500
501         int i, j;
502         int nrows = mat->rows;
503         int ncols = mat->cols;
504         
505         double *newdata = (double*) Calloc(nrows * ncols, double);
506         double *olddata = mat->data;
507
508         if (mat->colMajor) {
509                 for(i = 0; i < ncols; i++) {
510                         for(j = 0; j < nrows; j++) {
511                                 newdata[i + ncols * j] = olddata[i * nrows + j];
512                         }
513                 }
514         } else {
515                 for(i = 0; i < nrows; i++) {
516                         for(j = 0; j < ncols; j++) {
517                                 newdata[i + nrows * j] = olddata[i * ncols + j];
518                         }
519                 }
520         }
521
522         if (mat->localData) {
523                 Free(mat->data);
524         }
525
526         mat->localData = TRUE;
527         mat->data = newdata;
528         mat->colMajor = !mat->colMajor;
529 }
530
531 void omxTransposeMatrix(omxMatrix *mat) {
532         mat->colMajor = !mat->colMajor;
533         omxMatrixCompute(mat);
534 }
535
536 void omxRemoveRowsAndColumns(omxMatrix *om, int numRowsRemoved, int numColsRemoved, int rowsRemoved[], int colsRemoved[])
537 {
538     // TODO: Create short-circuit form of omxRemoveRowsAndCols to remove just rows or just columns.
539 //      if(OMX_DEBUG_MATRIX) { Rprintf("Removing %d rows and %d columns from 0x%0x.\n", numRowsRemoved, numColsRemoved, om);}
540
541         if(numRowsRemoved < 1 && numColsRemoved < 1) { return; }
542
543         int oldRows, oldCols;
544
545         if(om->aliasedPtr == NULL) {
546                 if(om->originalRows == 0 || om->originalCols == 0) {
547                         om->originalRows = om->rows;
548                         om->originalCols = om->cols;
549                 }
550                 oldRows = om->originalRows;
551                 oldCols = om->originalCols;
552         } else {
553                 oldRows = om->aliasedPtr->rows;
554                 oldCols = om->aliasedPtr->cols;
555         }
556
557         int nextCol = 0;
558         int nextRow = 0;
559
560         if(om->rows > om->originalRows || om->cols > om->originalCols) {        // sanity check.
561                 error("Aliased Matrix is too small for alias.");
562         }
563
564         om->rows = oldRows - numRowsRemoved;
565         om->cols = oldCols - numColsRemoved;
566
567         // Note:  This really aught to be done using a matrix multiply.  Why isn't it?
568         for(int j = 0; j < oldCols; j++) {
569                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("Handling column %d/%d...", j, oldCols);}
570                 if(colsRemoved[j]) {
571                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("Removed.\n");}
572                         continue;
573                 } else {
574                         nextRow = 0;
575                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("Rows (max %d): ", oldRows); }
576                         for(int k = 0; k < oldRows; k++) {
577                                 if(rowsRemoved[k]) {
578                                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("%d removed....", k);}
579                                         continue;
580                                 } else {
581                                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("%d kept....", k);}
582                                         if(om->aliasedPtr == NULL) {
583                                                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("Self-aliased matrix access.\n");}
584                                                 omxSetMatrixElement(om, nextRow, nextCol, omxAliasedMatrixElement(om, k, j));
585                                         } else {
586                                                 if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("Matrix 0x%x re-aliasing to 0x%x.\n", om, om->aliasedPtr);}
587                                                 omxSetMatrixElement(om, nextRow, nextCol, omxMatrixElement(om->aliasedPtr, k,  j));
588                                         }
589                                         nextRow++;
590                                 }
591                         }
592                         if(OMX_DEBUG_MATRIX || OMX_DEBUG_ALGEBRA) { Rprintf("\n");}
593                         nextCol++;
594                 }
595         }
596
597         omxMatrixCompute(om);
598 }
599
600 /* Function wrappers that switch based on inclusion of algebras */
601 void omxPrint(omxMatrix *source, char* d) {                                     // Pretty-print a (small) matrix
602         if(source->algebra != NULL) omxAlgebraPrint(source->algebra, d);
603         else if(source->objective != NULL) omxObjectivePrint(source->objective, d);
604         else omxPrintMatrix(source, d);
605 }
606
607 unsigned short omxNeedsUpdate(omxMatrix *matrix) {
608         unsigned short retval;
609         /* Simplest update check: If we're dirty or haven't computed this cycle (iteration or row), we need to. */
610         // TODO : Implement a dependency-tree-based dirtiness propagation system
611         if(OMX_DEBUG_MATRIX) {Rprintf("Matrix 0x%x NeedsUpdate?", matrix);}
612
613         if(matrix == NULL) {
614                 if(OMX_DEBUG_MATRIX) {Rprintf("matrix argument is NULL. ");}
615                 retval = FALSE;         // Not existing means never having to say you need to recompute.
616         } else if(matrix->isDirty) {
617                 if(OMX_DEBUG_MATRIX) {Rprintf("matrix is dirty. ");}
618                 retval = TRUE;
619         } else if(matrix->lastCompute < matrix->currentState->computeCount) {
620                 if(OMX_DEBUG_MATRIX) {Rprintf("matrix last compute is less than current compute count. ");}
621                 retval = TRUE;          // No need to check args if oa's dirty.
622         } else if(matrix->lastRow != matrix->currentState->currentRow) {
623                 if(OMX_DEBUG_MATRIX) {Rprintf("matrix last row is less than current row. ");}
624                 retval = TRUE;                  // Ditto.
625         } else if(matrix->algebra != NULL) {
626                 if(OMX_DEBUG_MATRIX) {Rprintf("checking algebra needs update. ");}
627                 retval = omxAlgebraNeedsUpdate(matrix->algebra);
628         } else if(matrix->objective != NULL) {
629                 if(OMX_DEBUG_MATRIX) {Rprintf("checking objective function needs update. ");}
630                 retval = omxObjectiveNeedsUpdate(matrix->objective);
631         } else {
632                 if(OMX_DEBUG_MATRIX) {Rprintf("checking matrix needs update. ");}
633                 retval = omxMatrixNeedsUpdate(matrix);
634         }
635         if(OMX_DEBUG_MATRIX && retval) {Rprintf("Yes.\n");}
636         if(OMX_DEBUG_MATRIX && !retval) {Rprintf("No.\n");}
637         return(retval);
638 }
639
640 void omxRecompute(omxMatrix *matrix) {
641         if(!omxNeedsUpdate(matrix)) return;
642         if(matrix->algebra != NULL) omxAlgebraCompute(matrix->algebra);
643         else if(matrix->objective != NULL) omxObjectiveCompute(matrix->objective);
644         else omxMatrixCompute(matrix);
645 }
646
647 void omxCompute(omxMatrix *matrix) {
648         if(matrix->algebra != NULL) omxAlgebraCompute(matrix->algebra);
649         else if(matrix->objective != NULL) omxObjectiveCompute(matrix->objective);
650         else omxMatrixCompute(matrix);
651 }