Optimize estimation of the latent distribution
[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         double *logNumIdentical;  // length numUnique
43         int *rowMap;              // length numUnique, index of first instance of pattern
44
45         // item description related
46         std::vector<const double*> itemSpec;
47         int maxOutcomes;
48         int maxDims;
49         int maxAbilities;
50         int numSpecific;
51         int *Sgroup;              // item's specific group 0..numSpecific-1
52         omxMatrix *design;        // items * maxDims
53
54         // quadrature related
55         double Qwidth;
56         double targetQpoints;
57         long quadGridSize;
58         long totalQuadPoints;     // quadGridSize ^ maxDims
59         long totalPrimaryPoints;  // totalQuadPoints except for specific dim TODO
60         std::vector<double> Qpoint;           // quadGridSize
61         std::vector<double> priQarea;         // totalPrimaryPoints
62         std::vector<double> speQarea;         // quadGridSize * numSpecific
63
64         // estimation related
65         omxMatrix *customPrior;
66         omxMatrix *itemParam;
67         omxMatrix *EitemParam;    // E step version
68         int cacheLXK;
69         bool LXKcached;
70         double *lxk;              // wo/cache, numUnique * thread
71         std::vector<double> allElxk;          // numUnique * thread
72         std::vector<double> Eslxk;            // numUnique * #specific dimensions * thread
73         double *patternLik;       // numUnique
74         double *_logPatternLik;   // numUnique
75         int totalOutcomes;
76         double *expected;         // totalOutcomes * totalQuadPoints
77         std::vector<double> ElatentMean;      // maxAbilities
78         std::vector<double> ElatentCov;       // maxAbilities * maxAbilities
79         omxMatrix *latentMeanOut;
80         omxMatrix *latentCovOut;
81
82         enum expectation_type type;
83         enum score_option scores;
84 } BA81Expect;
85
86 extern const struct rpf *rpf_model;
87 extern int rpf_numModels;
88
89 void ba81buildLXKcache(omxExpectation *oo);
90 double *computeRPF(BA81Expect *state, omxMatrix *itemParam, const int *quad, const bool wantlog);
91 void ba81SetupQuadrature(omxExpectation* oo, int gridsize, int flat);
92 void ba81Estep1(omxExpectation *oo);
93 void cai2010(omxExpectation* oo, const int thrId, int recompute, const int *primaryQuad);
94 double *ba81LikelihoodFast(omxExpectation *oo, const int thrId, int specific, const int *quad);
95 double *getLogPatternLik(omxExpectation* oo);
96
97 OMXINLINE static int
98 triangleLoc1(int diag)
99 {
100         //if (diag < 1) error("Out of domain");
101         return (diag) * (diag+1) / 2;   // 0 1 3 6 10 15 ..
102 }
103
104 OMXINLINE static int
105 triangleLoc0(int diag)
106 {
107         //if (diag < 0) error("Out of domain");
108         return triangleLoc1(diag+1) - 1;  // 0 2 5 9 14 ..
109 }
110
111 // state->allElxk[eIndex(state, px)]
112 OMXINLINE static int
113 eIndex(BA81Expect *state, int thr, int px)
114 {
115         return thr * state->numUnique + px;
116 }
117
118 // state->Eslxk[esIndex(state, sx, px)]
119 OMXINLINE static int
120 esIndex(BA81Expect *state, int thr, int sx, int px)
121 {
122         return (thr * state->numUnique * state->numSpecific +
123                 state->numUnique * sx + px);
124 }
125
126 OMXINLINE static void
127 pointToWhere(BA81Expect *state, const int *quad, double *where, int upto)
128 {
129         for (int dx=0; dx < upto; dx++) {
130                 where[dx] = state->Qpoint[quad[dx]];
131         }
132 }
133
134 OMXINLINE static long
135 encodeLocation(const int dims, const long grid, const int *quad)
136 {
137         long qx = 0;
138         for (int dx=dims-1; dx >= 0; dx--) {
139                 qx = qx * grid;
140                 qx += quad[dx];
141         }
142         return qx;
143 }
144
145 OMXINLINE static void
146 decodeLocation(long qx, const int dims, const long grid, int *quad)
147 {
148         for (int dx=0; dx < dims; dx++) {
149                 quad[dx] = qx % grid;
150                 qx = qx / grid;
151         }
152 }
153
154 OMXINLINE static double
155 areaProduct(BA81Expect *state, const int *quad, const int sg)
156 {
157         int maxDims = state->maxDims;
158         if (state->numSpecific == 0) {
159                 long qloc = encodeLocation(maxDims, state->quadGridSize, quad);
160                 return state->priQarea[qloc];
161         } else {
162                 long priloc = encodeLocation(maxDims-1, state->quadGridSize, quad);
163                 return (state->priQarea[priloc] *
164                         state->speQarea[sg * state->quadGridSize + quad[maxDims - 1]]);
165         }
166 }
167
168 OMXINLINE static void
169 gramProduct(double *vec, size_t len, double *out)
170 {
171         int cell = 0;
172         for (size_t v1=0; v1 < len; ++v1) {
173                 for (size_t v2=0; v2 <= v1; ++v2) {
174                         out[cell] = vec[v1] * vec[v2];
175                         ++cell;
176                 }
177         }
178 }
179
180 // debug tools
181 void pda(const double *ar, int rows, int cols);
182 void pia(const int *ar, int rows, int cols);
183
184 #endif