Corrections to state duplication.
[openmx:openmx.git] / src / omxMatrix.h
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  *
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 "omxObjective.h"
46 #include "omxState.h"
47
48
49 struct omxMatrix {                                              // A matrix
50                                                                                 //TODO: Improve encapsulation
51 /* Actually Useful Members */
52         int rows, cols;                                         // Matrix size  (specifically, its leading edge)
53         double* data;                                           // Actual Data Pointer
54         unsigned short colMajor;                        // and column-majority.
55         unsigned short hasMatrixNumber;         // is this object in the matrix or algebra arrays?
56         int matrixNumber;                                       // the offset into the matrices or algebras arrays
57
58 /* For Memory Administrivia */
59         unsigned short localData;                       // If data has been malloc'd, and must be freed.
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;                         // Retained, for historical purposes.
76         unsigned short isTemporary;                     // Whether or not to destroy the omxMatrix Structure when omxFreeAllMatrixData is called.
77         int lastCompute;                                        // Compute Count Number at last computation
78         int lastRow;                                            // Compute Count Number at last row update (Used for row-by-row computation only)
79
80 /* For Algebra Functions */                             // At most, one of these may be non-NULL.
81         omxAlgebra* algebra;                            // If it's not an algebra, this is NULL.
82         omxObjective* objective;                        // If it's not an objective function, this is NULL.
83
84 /* For inclusion in(or of) other matrices */
85         int numPopulateLocations;
86         omxMatrix** populateFrom;
87         int *populateFromRow, *populateFromCol;
88         int *populateToRow, *populateToCol;
89
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, short fullCopy);
106
107 /* Getters 'n Setters (static functions declared below) */
108         // static OMXINLINE double omxMatrixElement(omxMatrix *om, int row, int col);
109         // static OMXINLINE double omxVectorElement(omxMatrix *om, int index);
110         // static OMXINLINE void omxSetMatrixElement(omxMatrix *om, int row, int col, double value);
111         // static OMXINLINE void omxSetVectorElement(omxMatrix *om, int index, double value);
112
113         double omxAliasedMatrixElement(omxMatrix *om, int row, int col);                        // Element from unaliased form of the same matrix
114         double* omxLocationOfMatrixElement(omxMatrix *om, int row, int col);
115         void omxMarkDirty(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* omxFillMatrixFromMxMatrix(omxMatrix* om, SEXP matrix, omxState *state);      // Populate an omxMatrix from an R MxMatrix
122         omxMatrix* omxFillMatrixFromRPrimitive(omxMatrix* om, SEXP rObject, omxState *state,
123                 unsigned short hasMatrixNumber, int matrixNumber);                                                              // Populate an omxMatrix from an R object
124         void omxProcessMatrixPopulationList(omxMatrix *matrix, SEXP matStruct);
125         void omxCopyMatrix(omxMatrix *dest, omxMatrix *src);                                                            // Copy across another matrix.
126         void omxTransposeMatrix(omxMatrix *mat);                                                                                        // Transpose a matrix in place.
127         void omxToggleRowColumnMajor(omxMatrix *mat);                                                                           // Transform row-major into col-major and vice versa 
128
129 /* Function wrappers that switch based on inclusion of algebras */
130         void omxPrint(omxMatrix *source, char* d);                                                                                      // Pretty-print a (small) matrix
131         unsigned short int omxNeedsUpdate(omxMatrix *matrix);                                                           // Does this need to be recomputed?
132         void omxRecompute(omxMatrix *matrix);                                                                                           // Recompute the matrix if needed.
133         void omxCompute(omxMatrix *matrix);                                                                                                     // Recompute the matrix no matter what.
134
135 /* Aliased Matrix Functions */
136         void omxAliasMatrix(omxMatrix *alias, omxMatrix* const source);         // Allows aliasing for faster reset.
137         void omxResetAliasedMatrix(omxMatrix *matrix);                                          // Reset to the original matrix
138         void omxRemoveRowsAndColumns(omxMatrix* om, int numRowsRemoved, int numColsRemoved, int rowsRemoved[], int colsRemoved[]);
139
140 /* Matrix-Internal Helper functions */
141         void omxMatrixCompute(omxMatrix *matrix);
142         void omxPrintMatrix(omxMatrix *source, char* d);                    // Pretty-print a (small) matrix
143         unsigned short int omxMatrixNeedsUpdate(omxMatrix *matrix);
144
145 /* OMXINLINE functions and helper functions */
146
147 void setMatrixError(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
153 /* BLAS Wrappers */
154
155 static OMXINLINE void omxSetMatrixElement(omxMatrix *om, int row, int col, double value) {
156         if(row >= om->rows || col >= om->cols) {
157                 setMatrixError(row + 1, col + 1, om->rows, om->cols);
158         }
159         int index = 0;
160         if(om->colMajor) {
161                 index = col * om->rows + row;
162         } else {
163                 index = row * om->cols + col;
164         }
165         om->data[index] = value;
166 }
167
168 static OMXINLINE double omxMatrixElement(omxMatrix *om, int row, int col) {
169         int index = 0;
170         if(row >= om->rows || col >= om->cols) {
171                 matrixElementError(row + 1, col + 1, om->rows, om->cols);
172         }
173         if(om->colMajor) {
174                 index = col * om->rows + row;
175         } else {
176                 index = row * om->cols + col;
177         }
178         return om->data[index];
179 }
180
181 static OMXINLINE void omxSetVectorElement(omxMatrix *om, int index, double value) {
182         if(index < om->rows * om->cols) {
183                 om->data[index] = value;
184         } else {
185                 setVectorError(index, om->rows, om->cols);
186     }
187 }
188
189 static OMXINLINE double omxVectorElement(omxMatrix *om, int index) {
190         if(index < om->rows * om->cols) {
191                 return om->data[index];
192         } else {
193                 vectorElementError(index, om->rows, om->cols);
194         return (NA_REAL);
195     }
196 }
197
198 static OMXINLINE void omxDGEMM(unsigned short int transposeA, unsigned short int transposeB,            // result <- alpha * A %*% B + beta * C
199                                 double alpha, omxMatrix* a, omxMatrix *b, double beta, omxMatrix* result) {
200         int nrow = (transposeA?a->cols:a->rows);
201         int nmid = (transposeA?a->rows:a->cols);
202         int ncol = (transposeB?b->rows:b->cols);
203         F77_CALL(omxunsafedgemm)((transposeA?a->minority:a->majority), (transposeB?b->minority:b->majority), 
204                                                         &(nrow), &(ncol), &(nmid),
205                                                         &alpha, a->data, &(a->leading), 
206                                                         b->data, &(b->leading),
207                                                         &beta, result->data, &(result->leading));
208
209         if(!result->colMajor) omxToggleRowColumnMajor(result);
210 }
211
212 static OMXINLINE void omxDGEMV(unsigned short int transposeMat, double alpha, omxMatrix* mat,   // result <- alpha * A %*% B + beta * C
213                                 omxMatrix* vec, double beta, omxMatrix*result) {                                                        // where B is treated as a vector
214         int onei = 1;
215         int nrows = (transposeMat?mat->cols:mat->rows);
216         int ncols = (transposeMat?mat->rows:mat->cols);
217         F77_CALL(omxunsafedgemv)((transposeMat?mat->minority:mat->majority), &(nrows), &(ncols), &alpha, mat->data, &(mat->leading), vec->data, &onei, &beta, result->data, &onei);
218         if(!result->colMajor) omxToggleRowColumnMajor(result);
219 }
220
221 static OMXINLINE void omxDSYMV(unsigned short int transposeMat, double* alpha, omxMatrix* mat,  // result <- alpha * A %*% B + beta * C
222                                 omxMatrix* vec, double* beta, omxMatrix*result){                                                        // only A is symmetric, and B is a vector
223
224         if(!result->colMajor) omxToggleRowColumnMajor(result);
225 }
226
227 static OMXINLINE void omxDSYMM(unsigned short int symmOnLeft, double alpha, omxMatrix* a,               // result <- alpha * A %*% B + beta * C
228                                 omxMatrix *b, double beta, omxMatrix* result, unsigned short int fillMat) {     // One of A or B is symmetric
229
230         char r='R', l = 'L';
231         char u='U';
232         F77_CALL(dsymm)((symmOnLeft?&l:&r), &u, &(result->rows), &(result->cols),
233                                         &alpha, a->data, &(a->leading),
234                                         b->data, &(b->leading),
235                                         &beta, result->data, &(result->leading));
236
237         if(!result->colMajor) omxToggleRowColumnMajor(result);
238         
239         if(fillMat) {
240                 for(int j = 0; j < result->rows; j++)
241                         for(int k = j+1; k < result->cols; k++)
242                                 omxSetMatrixElement(result, j, k, omxMatrixElement(result, k, j));
243         }
244 }
245
246 static OMXINLINE int omxDGETRF(omxMatrix* mat, int* ipiv) {                                                                             // LUP decomposition of mat
247         int info = 0;
248         F77_CALL(dgetrf)(&(mat->rows), &(mat->cols), mat->data, &(mat->leading), ipiv, &info);
249         return info;
250 }
251
252 static OMXINLINE int omxDGETRI(omxMatrix* mat, int* ipiv, double* work, int lwork) {                            // Invert mat from LUP decomposition
253         int info = 0;
254         F77_CALL(dgetri)(&(mat->rows), mat->data, &(mat->leading), ipiv, work, &lwork, &info);
255         return info;
256 }
257
258 static OMXINLINE void omxDPOTRF(omxMatrix* mat, int* info) {                                                                            // Cholesky decomposition of mat
259         // ERROR: NYI.
260 }
261 static OMXINLINE void omxDPOTRI(omxMatrix* mat, int* info) {                                                                            // Invert mat from Cholesky
262         // ERROR: NYI
263 }
264
265
266 #endif /* _OMXMATRIX_H_ */