Merging the FitExpectation branch into the trunk.
[openmx:openmx.git] / src / omxData.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  *  omxData.h
21  *
22  *  Created: Timothy R. Brick   Date: 2009-07-15
23  *
24  *      Contains header information for the omxData class
25  *   omxData objects keep data objects in whatever form
26  *   they might take.
27  *
28  **********************************************************/
29
30 #ifndef _OMXDATA_H_
31 #define _OMXDATA_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
41 typedef struct omxData omxData;
42 typedef struct omxContiguousData omxContiguousData;
43
44 #include "omxAlgebra.h"
45 #include "omxFitFunction.h"
46 #include "omxState.h"
47
48 struct omxContiguousData {
49         int isContiguous;
50         int start;
51         int length;
52 };
53
54 struct omxData {                                                // A matrix
55                                                                                 //TODO: Improve encapsulation
56 /* The object itself */
57         SEXP dataObject;                                        // The R object
58         SEXP* columns;                                          // An array of column SEXPs
59         omxMatrix* dataMat;                                     // The data, as an omxMatrix Object
60         omxMatrix* meansMat;                            // The means, as an omxMatrixObject
61         double numObs;                                          // Number of observations
62         char type[250];                                         // The type of data object.
63         
64         int* location;                                          // Which of the following contains the data column
65         double** realData;                                      // The actual data objects if numeric
66         int** intData;                                          // The actual data objects if ordinal
67         int* indexVector;                                               // The "official" index into the data set
68         int* identicalDefs;                                     // Number of consecutive rows with identical def. vars
69         int* identicalMissingness;                      // Number of consecutive rows with identical missingness patterns
70         int* identicalRows;                                     // Number of consecutive rows with identical data
71   int numFactor, numNumeric;  // Number of ordinal and continuous columns
72   short isDynamic;             // Reserved for when there's actually dynamic data.
73 /* Useful Members */
74         int rows, cols;                                         // Matrix size 
75
76         omxState* currentState;                         // The Current Optimizer State  // Might not want this.
77 };
78
79 /* Initialize and Destroy */
80         omxData* omxInitData();                                         // Set up a data object
81         omxData* omxNewDataFromMxDataPtr(SEXP dataObject, omxState* state);     // Retrieves a data object from the state
82         omxData* omxNewDataFromMxData(omxData* od, SEXP dataObject, omxState* state);   // Fills the object from a data SEXP
83         void omxFreeData(omxData* od);                                  // Release any held data.
84         void omxSetContiguousDataColumns(omxContiguousData* contiguous, omxData* data, omxMatrix* colList);
85
86 /* Getters 'n Setters */
87         double omxDoubleDataElement(omxData *od, int row, int col);                                     // Returns one data object as a double
88         int omxIntDataElement(omxData *od, int row, int col);                                           // Returns one data object as an integer
89         omxMatrix* omxDataMatrix(omxData *od, omxMatrix* om);                                           // Populates a matrix with the data (use for covariance matrices)
90         omxMatrix* omxDataMeans(omxData *od, omxMatrix* colList, omxMatrix* om);        // Populates a matrix with data means
91         omxMatrix* omxDataRow(omxData *od, int row, omxMatrix* colList, omxMatrix* om);// Populates a matrix with a single data row
92         omxMatrix* omxContiguousDataRow(omxData *od, int row, int start, int length, omxMatrix* om);// Populates a matrix with a contiguous data row
93         int omxDataIndex(omxData *od, int row);                                                                         // Returns the unsorted (original) index of the current row
94         int omxDataNumIdenticalRows(omxData *od, int row);                                                      // Returns the number of rows identical to this one in the data set
95         int omxDataNumIdenticalMissingness(omxData *od, int row);                                       // Returns the number of rows with definition variables and missingness identical to this one in the data set
96     int omxDataNumIdenticalContinuousRows(omxData *od, int row);                // Number of rows with continuous variables remaining, or Inf if no continous vars
97     int omxDataNumIdenticalContinuousMissingness(omxData *od, int row);         // Number of rows with continuous variables remaining, or Inf if no continous vars
98     int omxDataNumIdenticalOrdinalRows(omxData *od, int row);
99     int omxDataNumIdenticalOrdinalMissingness(omxData *od, int row);
100         int omxDataNumIdenticalDefs(omxData *od, int row);                                                      // Returns the number of rows with definition variables identical to this one in the data set
101         
102         double omxDataNumObs(omxData *od);                                                                                      // Returns number of obs in the dataset
103         unsigned short int omxDataColumnIsFactor(omxData *od, int col);                         // Returns 0 if column is not a factor
104         char* omxDataType(omxData *od);                                                                                         // Returns the type field // TODO: Should this be an ENUM?
105         
106         int omxDataNumNumeric(omxData *od);                   // Number of numeric columns in the data set
107         int omxDataNumFactor(omxData *od);                    // Number of factor columns in the data set
108
109         void resetDefinitionVariables(double *oldDefs, int numDefs);
110
111 /* Function wrappers that switch based on inclusion of algebras */
112         void omxPrintData(omxData *source, char* d);                                                                    // Pretty-print a (hopefully small) data object
113
114 #endif /* _OMXDATA_H_ */