Gradients for 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> priLogQarea;      // totalPrimaryPoints
62         std::vector<double> speLogQarea;      // quadGridSize * numSpecific
63
64         // estimation related
65         omxMatrix *EitemParam;    // E step version
66         int cacheLXK;
67         bool LXKcached;
68         double *lxk;              // wo/cache, numUnique * thread
69         std::vector<double> allElxk;          // numUnique * thread
70         std::vector<double> Eslxk;            // numUnique * #specific dimensions * thread
71         double *patternLik;       // numUnique
72         double *_logPatternLik;   // numUnique
73         int totalOutcomes;
74         double *expected;         // totalOutcomes * totalQuadPoints
75         double *ElatentMean;      // maxAbilities * numUnique
76         double *ElatentCov;       // maxAbilities * maxAbilities * numUnique ; only lower triangle is used
77         omxMatrix *latentMeanOut;
78         omxMatrix *latentCovOut;
79
80         enum expectation_type type;
81         enum score_option scores;
82 } BA81Expect;
83
84 extern const struct rpf *rpf_model;
85 extern int rpf_numModels;
86
87 void ba81buildLXKcache(omxExpectation *oo);
88 double *computeRPF(BA81Expect *state, omxMatrix *itemParam, const int *quad);
89 void ba81SetupQuadrature(omxExpectation* oo, int gridsize, int flat);
90 void ba81Estep1(omxExpectation *oo);
91 void cai2010(omxExpectation* oo, int recompute, const int *primaryQuad);
92 double *ba81LikelihoodFast(omxExpectation *oo, int specific, const int *quad);
93 double *getLogPatternLik(omxExpectation* oo);
94
95 OMXINLINE static int
96 triangleLoc1(int diag)
97 {
98         //if (diag < 1) error("Out of domain");
99         return (diag) * (diag+1) / 2;   // 0 1 3 6 10 15 ..
100 }
101
102 OMXINLINE static int
103 triangleLoc0(int diag)
104 {
105         //if (diag < 0) error("Out of domain");
106         return triangleLoc1(diag+1) - 1;  // 0 2 5 9 14 ..
107 }
108
109 // state->allElxk[eIndex(state, px)]
110 OMXINLINE static int
111 eIndex(BA81Expect *state, int px)
112 {
113         return omx_absolute_thread_num() * state->numUnique + px;
114 }
115
116 // state->Eslxk[esIndex(state, sx, px)]
117 OMXINLINE static int
118 esIndex(BA81Expect *state, int sx, int px)
119 {
120         return (omx_absolute_thread_num() * state->numUnique * state->numSpecific +
121                 state->numUnique * sx + px);
122 }
123
124 OMXINLINE static void
125 pointToWhere(BA81Expect *state, const int *quad, double *where, int upto)
126 {
127         for (int dx=0; dx < upto; dx++) {
128                 where[dx] = state->Qpoint[quad[dx]];
129         }
130 }
131
132 OMXINLINE static long
133 encodeLocation(const int dims, const long grid, const int *quad)
134 {
135         long qx = 0;
136         for (int dx=dims-1; dx >= 0; dx--) {
137                 qx = qx * grid;
138                 qx += quad[dx];
139         }
140         return qx;
141 }
142
143 OMXINLINE static void
144 decodeLocation(long qx, const int dims, const long grid, int *quad)
145 {
146         for (int dx=0; dx < dims; dx++) {
147                 quad[dx] = qx % grid;
148                 qx = qx / grid;
149         }
150 }
151
152 OMXINLINE static double
153 logAreaProduct(BA81Expect *state, const int *quad, const int sg)
154 {
155         int maxDims = state->maxDims;
156         if (state->numSpecific == 0) {
157                 long qloc = encodeLocation(maxDims, state->quadGridSize, quad);
158                 return state->priLogQarea[qloc];
159         } else {
160                 long priloc = encodeLocation(maxDims-1, state->quadGridSize, quad);
161                 return (state->priLogQarea[priloc] +
162                         state->speLogQarea[sg * state->quadGridSize + quad[maxDims - 1]]);
163         }
164 }
165
166 // debug tools
167 void pda(const double *ar, int rows, int cols);
168 void pia(const int *ar, int rows, int cols);
169
170 #endif