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