Reorg E step 7/9
[openmx:openmx.git] / src / omxExpectationBA81.h
1 /*
2   Copyright 2012-2013 Joshua Nathaniel Pritikin and contributors
3
4   This is free software: you can redistribute it and/or modify
5   it under the terms of the GNU General Public License as published by
6   the Free Software Foundation, either version 3 of the License, or
7   (at your option) any later version.
8
9   This program is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   GNU General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 */
17
18 #ifndef _OMX_EXPECTATIONBA81_H_
19 #define _OMX_EXPECTATIONBA81_H_
20
21 #include "omxExpectation.h"
22 #include "omxOpenmpWrap.h"
23
24 enum score_option {
25         SCORES_OMIT,
26         SCORES_UNIQUE,
27         SCORES_FULL
28 };
29
30 enum expectation_type {
31         EXPECTATION_UNINITIALIZED,
32         EXPECTATION_AUGMENTED, // E-M
33         EXPECTATION_OBSERVED,  // regular
34 };
35
36 typedef struct {
37
38         // data characteristics
39         omxData *data;
40         int numUnique;
41         int *numIdentical;        // length numUnique
42         int *rowMap;              // length numUnique, index of first instance of pattern
43
44         // item description related
45         std::vector<const double*> itemSpec;
46         std::vector<int> itemOutcomes;
47         int maxDims;
48         int maxAbilities;
49         int numSpecific;
50         int *Sgroup;              // item's specific group 0..numSpecific-1
51         omxMatrix *design;        // items * maxDims
52
53         // quadrature related
54         double Qwidth;
55         double targetQpoints;
56         long quadGridSize;
57         long totalQuadPoints;     // quadGridSize ^ maxDims
58         long totalPrimaryPoints;  // totalQuadPoints except for specific dim TODO
59         std::vector<double> Qpoint;           // quadGridSize
60         std::vector<double> priQarea;         // totalPrimaryPoints
61         std::vector<double> speQarea;         // quadGridSize * numSpecific
62
63         // estimation related
64         omxMatrix *customPrior;
65         omxMatrix *itemParam;
66         omxMatrix *EitemParam;    // E step version
67         int cacheLXK;
68         bool LXKcached;
69         double *lxk;              // wo/cache, numUnique * thread
70         double *allElxk;          // numUnique * thread
71         double *Eslxk;            // numUnique * #specific dimensions * thread
72         double *patternLik;       // numUnique
73         int totalOutcomes;
74         double *outcomeProb;      // totalOutcomes * totalQuadPoints
75         double *expected;         // totalOutcomes * totalQuadPoints
76         std::vector<double> ElatentMean;      // maxAbilities
77         std::vector<double> ElatentCov;       // maxAbilities * maxAbilities
78         omxMatrix *latentMeanOut;
79         omxMatrix *latentCovOut;
80
81         int itemParamVersion;
82         int latentParamVersion;
83         enum expectation_type type;
84         enum score_option scores;
85         bool verbose;
86 } BA81Expect;
87
88 extern const struct rpf *rpf_model;
89 extern int rpf_numModels;
90
91 void computeRPF(BA81Expect *state, omxMatrix *itemParam, const int *quad,
92                 const bool wantlog, double *outcomeProb);
93 void cai2010(omxExpectation* oo, const int thrId, int recompute, const long qx);
94 double *ba81LikelihoodFast(omxExpectation *oo, const int thrId, int specific, const long qx);
95
96 OMXINLINE static int
97 triangleLoc1(int diag)
98 {
99         //if (diag < 1) error("Out of domain");
100         return (diag) * (diag+1) / 2;   // 0 1 3 6 10 15 ..
101 }
102
103 OMXINLINE static int
104 triangleLoc0(int diag)
105 {
106         //if (diag < 0) error("Out of domain");
107         return triangleLoc1(diag+1) - 1;  // 0 2 5 9 14 ..
108 }
109
110 OMXINLINE static double *
111 eBase(BA81Expect *state, int thr)
112 {
113         return state->allElxk + thr * state->numUnique;
114 }
115
116 OMXINLINE static double *
117 esBase(BA81Expect *state, int thr)
118 {
119         return state->Eslxk + thr * state->numUnique * state->numSpecific;
120 }
121
122 OMXINLINE static void
123 pointToWhere(BA81Expect *state, const int *quad, double *where, int upto)
124 {
125         for (int dx=0; dx < upto; dx++) {
126                 where[dx] = state->Qpoint[quad[dx]];
127         }
128 }
129
130 OMXINLINE static void
131 decodeLocation(long qx, const int dims, const long grid, int *quad)
132 {
133         for (int dx=dims-1; dx >= 0; --dx) {
134                 quad[dx] = qx % grid;
135                 qx = qx / grid;
136         }
137 }
138
139 OMXINLINE static double
140 areaProduct(BA81Expect *state, long qx, int sx, const int sg)
141 {
142         if (state->numSpecific == 0) {
143                 return state->priQarea[qx];
144         } else {
145                 if (sx == -1) {
146                         sx = qx % state->quadGridSize;
147                         qx /= state->quadGridSize;
148                 }
149                 return (state->priQarea[qx] * state->speQarea[sg * state->quadGridSize + sx]);
150         }
151 }
152
153 OMXINLINE static void
154 gramProduct(double *vec, size_t len, double *out)
155 {
156         int cell = 0;
157         for (size_t v1=0; v1 < len; ++v1) {
158                 for (size_t v2=0; v2 <= v1; ++v2) {
159                         out[cell] = vec[v1] * vec[v2];
160                         ++cell;
161                 }
162         }
163 }
164
165 // debug tools
166 void pda(const double *ar, int rows, int cols);
167 void pia(const int *ar, int rows, int cols);
168
169 #endif