Add thread-safe logging functions
[openmx:openmx.git] / src / omxMatrix.h
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  *
20  *  omxMatrix.h
21  *
22  *  Created: Timothy R. Brick   Date: 2008-11-13 12:33:06
23  *
24  *      Contains header information for the omxMatrix class
25  *   omxDataMatrices hold necessary information to simplify
26  *      dealings between the OpenMX back end and BLAS.
27  *
28  **********************************************************/
29
30 #ifndef _OMXMATRIX_H_
31 #define _OMXMATRIX_H_
32
33 #include <R.h>
34 #include <Rinternals.h>
35 #include <Rdefines.h>
36 #include <R_ext/Rdynload.h>
37 #include <R_ext/BLAS.h>
38 #include <R_ext/Lapack.h>
39 #include "omxDefines.h"
40 #include "omxBLAS.h"
41
42 #include "types.h"
43
44 #include "omxAlgebra.h"
45 #include "omxFitFunction.h"
46 #include "omxExpectation.h"
47 #include "omxState.h"
48
49
50 struct omxMatrix {                                              // A matrix
51                                                                                 //TODO: Improve encapsulation
52 /* Actually Useful Members */
53         int rows, cols;                                         // Matrix size  (specifically, its leading edge)
54         double* data;                                           // Actual Data Pointer
55         unsigned short colMajor;                        // and column-majority.
56         unsigned short hasMatrixNumber;         // is this object in the matrix or algebra arrays?
57         int matrixNumber;                                       // the offset into the matrices or algebras arrays
58
59         SEXP owner;     // The R object owning data or NULL if we own it.
60
61 /* For aliased matrices */                              // Maybe this should be a subclass, as well.
62         omxMatrix* aliasedPtr;                          // For now, assumes outside data if aliased.
63         unsigned short originalColMajor;        // Saved for reset of aliased matrix.
64         unsigned short originalRows;            // Saved for reset of aliased matrix.
65         unsigned short originalCols;            // Saved for reset of aliased matrix.
66
67 /* For BLAS Multiplication Speedup */   // TODO: Replace some of these with inlines or macros.
68         const char* majority;                           // Filled by compute(), included for speed
69         const char* minority;                           // Filled by compute(), included for speed
70         int leading;                                            // Leading edge; depends on original majority
71         int lagging;                                            // Non-leading edge.
72
73 /* Curent State */
74         omxState* currentState;                         // Optimizer State
75         unsigned short isDirty;                         // Whether or not the matrix requires recomputation.
76         unsigned short isTemporary;                     // Whether or not to destroy the omxMatrix Structure when omxFreeAllMatrixData is called.
77
78 /* For Algebra Functions */                             // At most, one of these may be non-NULL.
79         omxAlgebra* algebra;                            // If it's not an algebra, this is NULL.
80         omxFitFunction* fitFunction;            // If it's not a fit function, this is NULL.
81
82 /* For inclusion in(or of) other matrices */
83         int numPopulateLocations;
84         int *populateFrom;
85         int *populateFromRow, *populateFromCol;
86         int *populateToRow, *populateToCol;
87
88         const char* name;
89 };
90
91 /* Initialize and Destroy */
92         omxMatrix* omxInitMatrix(omxMatrix* om, int nrows, int ncols, unsigned short colMajor, omxState* os);                   // Set up matrix 
93         omxMatrix* omxInitTemporaryMatrix(omxMatrix* om, int nrows, int ncols, unsigned short colMajor, omxState* os);  // Set up matrix that can be freed
94         void omxFreeMatrixData(omxMatrix* om);                                                  // Release any held data.
95         void omxFreeAllMatrixData(omxMatrix* om);                                               // Ditto, traversing argument trees
96
97 /* Matrix Creation Functions */
98         omxMatrix* omxNewMatrixFromRPrimitive(SEXP rObject, omxState *state,
99         unsigned short hasMatrixNumber, int matrixNumber);                                                      // Create an omxMatrix from an R object
100         omxMatrix* omxNewIdentityMatrix(int nrows, omxState* state);                            // Creates an Identity Matrix of a given size
101         extern omxMatrix* omxMatrixLookupFromState1(SEXP matrix, omxState* os); // Create a matrix/algebra from a matrix pointer
102
103         omxMatrix* omxDuplicateMatrix(omxMatrix* src, omxState* newState);
104         SEXP omxExportMatrix(omxMatrix *om);
105
106 /* Getters 'n Setters (static functions declared below) */
107         // static OMXINLINE double omxMatrixElement(omxMatrix *om, int row, int col);
108         // static OMXINLINE double omxVectorElement(omxMatrix *om, int index);
109         // static OMXINLINE void omxSetMatrixElement(omxMatrix *om, int row, int col, double value);
110         // static OMXINLINE void omxSetVectorElement(omxMatrix *om, int index, double value);
111
112         double omxAliasedMatrixElement(omxMatrix *om, int row, int col);                        // Element from unaliased form of the same matrix
113         double* omxLocationOfMatrixElement(omxMatrix *om, int row, int col);
114         void omxMarkDirty(omxMatrix *om);
115         void omxMarkClean(omxMatrix *om);
116
117 /* Matrix Modification Functions */
118         void omxZeroByZeroMatrix(omxMatrix *source);
119         void omxResizeMatrix(omxMatrix *source, int nrows, int ncols,
120                                                         unsigned short keepMemory);                                                                     // Resize, with or without re-initialization
121         omxMatrix* omxFillMatrixFromRPrimitive(omxMatrix* om, SEXP rObject, omxState *state,
122                 unsigned short hasMatrixNumber, int matrixNumber);                                                              // Populate an omxMatrix from an R object
123         void omxProcessMatrixPopulationList(omxMatrix *matrix, SEXP matStruct);
124         void omxCopyMatrix(omxMatrix *dest, omxMatrix *src);                                                            // Copy across another matrix.
125         void omxTransposeMatrix(omxMatrix *mat);                                                                                                // Transpose a matrix in place.
126         void omxToggleRowColumnMajor(omxMatrix *mat);                                                                           // Transform row-major into col-major and vice versa 
127
128 /* Function wrappers that switch based on inclusion of algebras */
129         void omxPrint(omxMatrix *source, const char* d);
130         unsigned short int omxNeedsUpdate(omxMatrix *matrix);                                                           // Does this need to be recomputed?
131         void omxRecompute(omxMatrix *matrix);                                                                                           // Recompute the matrix if needed.
132         void omxForceCompute(omxMatrix *matrix);
133
134 /* Aliased Matrix Functions */
135         void omxAliasMatrix(omxMatrix *alias, omxMatrix* const source);         // Allows aliasing for faster reset.
136         void omxResetAliasedMatrix(omxMatrix *matrix);                                          // Reset to the original matrix
137         void omxRemoveElements(omxMatrix *om, int numRemoved, int removed[]);
138         void omxRemoveRowsAndColumns(omxMatrix* om, int numRowsRemoved, int numColsRemoved, int rowsRemoved[], int colsRemoved[]);
139
140 /* Matrix-Internal Helper functions */
141         void omxMatrixLeadingLagging(omxMatrix *matrix);
142 void omxPrintMatrix(omxMatrix *source, const char* header);
143         unsigned short int omxMatrixNeedsUpdate(omxMatrix *matrix);
144
145 /* OMXINLINE functions and helper functions */
146
147 void setMatrixError(omxMatrix *om, int row, int col, int numrow, int numcol);
148 void setVectorError(int index, int numrow, int numcol);
149 void matrixElementError(int row, int col, int numrow, int numcol);
150 void vectorElementError(int index, int numrow, int numcol);
151
152 static OMXINLINE int omxIsMatrix(omxMatrix *mat) {
153     return (mat->algebra == NULL && mat->fitFunction == NULL);
154 }
155
156 /* BLAS Wrappers */
157
158 static OMXINLINE void omxSetMatrixElement(omxMatrix *om, int row, int col, double value) {
159         if((row < 0) || (col < 0) || (row >= om->rows) || (col >= om->cols)) {
160                 setMatrixError(om, row + 1, col + 1, om->rows, om->cols);
161                 return;
162         }
163         int index = 0;
164         if(om->colMajor) {
165                 index = col * om->rows + row;
166         } else {
167                 index = row * om->cols + col;
168         }
169         om->data[index] = value;
170 }
171
172 static OMXINLINE void omxAccumulateMatrixElement(omxMatrix *om, int row, int col, double value) {
173         if((row < 0) || (col < 0) || (row >= om->rows) || (col >= om->cols)) {
174                 setMatrixError(om, row + 1, col + 1, om->rows, om->cols);
175                 return;
176         }
177         int index = 0;
178         if(om->colMajor) {
179                 index = col * om->rows + row;
180         } else {
181                 index = row * om->cols + col;
182         }
183         om->data[index] += value;
184 }
185
186 static OMXINLINE double omxMatrixElement(omxMatrix *om, int row, int col) {
187         int index = 0;
188         if((row < 0) || (col < 0) || (row >= om->rows) || (col >= om->cols)) {
189                 matrixElementError(row + 1, col + 1, om->rows, om->cols);
190         return (NA_REAL);
191         }
192         if(om->colMajor) {
193                 index = col * om->rows + row;
194         } else {
195                 index = row * om->cols + col;
196         }
197         return om->data[index];
198 }
199
200 static OMXINLINE void omxAccumulateVectorElement(omxMatrix *om, int index, double value) {
201         if (index < 0 || index >= (om->rows * om->cols)) {
202                 setVectorError(index + 1, om->rows, om->cols);
203                 return;
204         } else {
205                 om->data[index] += value;
206     }
207 }
208
209 static OMXINLINE void omxSetVectorElement(omxMatrix *om, int index, double value) {
210         if (index < 0 || index >= (om->rows * om->cols)) {
211                 setVectorError(index + 1, om->rows, om->cols);
212                 return;
213         } else {
214                 om->data[index] = value;
215     }
216 }
217
218 static OMXINLINE double omxVectorElement(omxMatrix *om, int index) {
219         if (index < 0 || index >= (om->rows * om->cols)) {
220                 vectorElementError(index + 1, om->rows, om->cols);
221         return (NA_REAL);
222         } else {
223                 return om->data[index];
224     }
225 }
226
227 static OMXINLINE void omxUnsafeSetVectorElement(omxMatrix *om, int index, double value) {
228         om->data[index] = value;
229 }
230
231 static OMXINLINE double omxUnsafeVectorElement(omxMatrix *om, int index) {
232         return om->data[index];
233 }
234
235
236 static OMXINLINE void omxDGEMM(unsigned short int transposeA, unsigned short int transposeB,            // result <- alpha * A %*% B + beta * C
237                                 double alpha, omxMatrix* a, omxMatrix *b, double beta, omxMatrix* result) {
238         int nrow = (transposeA?a->cols:a->rows);
239         int nmid = (transposeA?a->rows:a->cols);
240         int ncol = (transposeB?b->rows:b->cols);
241
242         F77_CALL(omxunsafedgemm)((transposeA?a->minority:a->majority), (transposeB?b->minority:b->majority), 
243                                                         &(nrow), &(ncol), &(nmid),
244                                                         &alpha, a->data, &(a->leading), 
245                                                         b->data, &(b->leading),
246                                                         &beta, result->data, &(result->leading));
247
248         if(!result->colMajor) omxToggleRowColumnMajor(result);
249 }
250
251 static OMXINLINE void omxDGEMV(unsigned short int transposeMat, double alpha, omxMatrix* mat,   // result <- alpha * A %*% B + beta * C
252                                 omxMatrix* vec, double beta, omxMatrix*result) {                                                        // where B is treated as a vector
253         int onei = 1;
254         int nrows = mat->rows;
255         int ncols = mat->cols;
256         if(OMX_DEBUG_DEVELOPER) {
257                 int nVecEl = vec->rows * vec->cols;
258                 // mxLog("DGEMV: %c, %d, %d, %f, 0x%x, %d, 0x%x, %d, 0x%x, %d\n", *(transposeMat?mat->minority:mat->majority), (nrows), (ncols), 
259                 // alpha, mat->data, (mat->leading), vec->data, onei, beta, result->data, onei); //:::DEBUG:::
260                 if((transposeMat && nrows != nVecEl) || (!transposeMat && ncols != nVecEl)) {
261                         error("Mismatch in vector/matrix multiply: %s (%d x %d) * (%d x 1).\n", (transposeMat?"transposed":""), mat->rows, mat->cols, nVecEl); // :::DEBUG:::
262                 }
263         }
264         F77_CALL(omxunsafedgemv)((transposeMat?mat->minority:mat->majority), &(nrows), &(ncols), 
265                 &alpha, mat->data, &(mat->leading), vec->data, &onei, &beta, result->data, &onei);
266         if(!result->colMajor) omxToggleRowColumnMajor(result);
267 }
268
269 static OMXINLINE void omxDSYMV(double alpha, omxMatrix* mat,            // result <- alpha * A %*% B + beta * C
270                                 omxMatrix* vec, double beta, omxMatrix* result) {       // only A is symmetric, and B is a vector
271         char u='U';
272     int onei = 1;
273
274         if(OMX_DEBUG_DEVELOPER) {
275                 int nVecEl = vec->rows * vec->cols;
276                 // mxLog("DSYMV: %c, %d, %f, 0x%x, %d, 0x%x, %d, %f, 0x%x, %d\n", u, (mat->cols),alpha, mat->data, (mat->leading), 
277                             // vec->data, onei, beta, result->data, onei); //:::DEBUG:::
278                 if(mat->cols != nVecEl) {
279                         error("Mismatch in symmetric vector/matrix multiply: %s (%d x %d) * (%d x 1).\n", "symmetric", mat->rows, mat->cols, nVecEl); // :::DEBUG:::
280                 }
281         }
282
283     F77_CALL(dsymv)(&u, &(mat->cols), &alpha, mat->data, &(mat->leading), 
284                     vec->data, &onei, &beta, result->data, &onei);
285
286     // if(!result->colMajor) omxToggleRowColumnMajor(result);
287 }
288
289 static OMXINLINE void omxDSYMM(unsigned short int symmOnLeft, double alpha, omxMatrix* symmetric,               // result <- alpha * A %*% B + beta * C
290                                 omxMatrix *other, double beta, omxMatrix* result) {                                 // One of A or B is symmetric
291
292         char r='R', l = 'L';
293         char u='U';
294         F77_CALL(dsymm)((symmOnLeft?&l:&r), &u, &(result->rows), &(result->cols),
295                                         &alpha, symmetric->data, &(symmetric->leading),
296                                         other->data, &(other->leading),
297                                         &beta, result->data, &(result->leading));
298
299         if(!result->colMajor) omxToggleRowColumnMajor(result);
300 }
301
302 static OMXINLINE int omxDGETRF(omxMatrix* mat, int* ipiv) {                                                                             // LUP decomposition of mat
303         int info = 0;
304         F77_CALL(dgetrf)(&(mat->rows), &(mat->cols), mat->data, &(mat->leading), ipiv, &info);
305         return info;
306 }
307
308 static OMXINLINE int omxDGETRI(omxMatrix* mat, int* ipiv, double* work, int lwork) {                            // Invert mat from LUP decomposition
309         int info = 0;
310         F77_CALL(dgetri)(&(mat->rows), mat->data, &(mat->leading), ipiv, work, &lwork, &info);
311         return info;
312 }
313
314 static OMXINLINE void omxDAXPY(double alpha, omxMatrix* lhs, omxMatrix* rhs) {              // RHS += alpha*lhs  
315     // N.B.  Not fully tested.                                                              // Assumes common majority or vectordom.
316     if(lhs->colMajor != rhs->colMajor) { omxToggleRowColumnMajor(rhs);}
317     int len = lhs->rows * lhs->cols;
318     int onei = 1;
319     F77_CALL(daxpy)(&len, &alpha, lhs->data, &onei, rhs->data, &onei);
320
321 }
322
323 static OMXINLINE double omxDDOT(omxMatrix* lhs, omxMatrix* rhs) {              // returns dot product, as if they were vectors
324     // N.B.  Not fully tested.                                                  // Assumes common majority or vectordom.
325     if(lhs->colMajor != rhs->colMajor) { omxToggleRowColumnMajor(rhs);}
326     int len = lhs->rows * lhs->cols;
327     int onei = 1;
328     return(F77_CALL(ddot)(&len, lhs->data, &onei, rhs->data, &onei));
329 }
330
331 static OMXINLINE void omxDPOTRF(omxMatrix* mat, int* info) {                                                                            // Cholesky decomposition of mat
332         // TODO: Add error checking, and/or adjustments for row vs. column majority.
333         // N.B. Not fully tested.
334         char u = 'U'; //l = 'L'; //U for storing upper triangle
335         F77_CALL(dpotrf)(&u, &(mat->rows), mat->data, &(mat->cols), info);
336 }
337 static OMXINLINE void omxDPOTRI(omxMatrix* mat, int* info) {                                                                            // Invert mat from Cholesky
338         // TODO: Add error checking, and/or adjustments for row vs. column majority.
339         // N.B. Not fully tested.
340         char u = 'U'; //l = 'L'; // U for storing upper triangle
341         F77_CALL(dpotri)(&u, &(mat->rows), mat->data, &(mat->cols), info);
342 }
343
344 void omxShallowInverse(int numIters, omxMatrix* A, omxMatrix* Z, omxMatrix* Ax, omxMatrix* I );
345
346 #endif /* _OMXMATRIX_H_ */