Fail if an outcome is entirely unendorsed
[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 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         double *allElxk;          // numUnique * thread
72         double *Eslxk;            // numUnique * #specific dimensions * thread
73         double *patternLik;       // numUnique
74         int totalOutcomes;
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         bool checkedBadData;
87 } BA81Expect;
88
89 extern const struct rpf *rpf_model;
90 extern int rpf_numModels;
91
92 double *computeRPF(BA81Expect *state, omxMatrix *itemParam, const int *quad, const bool wantlog);
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
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 long
131 encodeLocation(const int dims, const long grid, const int *quad)
132 {
133         long qx = 0;
134         for (int dx=dims-1; dx >= 0; dx--) {
135                 qx = qx * grid;
136                 qx += quad[dx];
137         }
138         return qx;
139 }
140
141 OMXINLINE static void
142 decodeLocation(long qx, const int dims, const long grid, int *quad)
143 {
144         for (int dx=0; dx < dims; dx++) {
145                 quad[dx] = qx % grid;
146                 qx = qx / grid;
147         }
148 }
149
150 OMXINLINE static double
151 areaProduct(BA81Expect *state, const int *quad, const int sg)
152 {
153         int maxDims = state->maxDims;
154         if (state->numSpecific == 0) {
155                 long qloc = encodeLocation(maxDims, state->quadGridSize, quad);
156                 return state->priQarea[qloc];
157         } else {
158                 long priloc = encodeLocation(maxDims-1, state->quadGridSize, quad);
159                 return (state->priQarea[priloc] *
160                         state->speQarea[sg * state->quadGridSize + quad[maxDims - 1]]);
161         }
162 }
163
164 OMXINLINE static void
165 gramProduct(double *vec, size_t len, double *out)
166 {
167         int cell = 0;
168         for (size_t v1=0; v1 < len; ++v1) {
169                 for (size_t v2=0; v2 <= v1; ++v2) {
170                         out[cell] = vec[v1] * vec[v2];
171                         ++cell;
172                 }
173         }
174 }
175
176 // debug tools
177 void pda(const double *ar, int rows, int cols);
178 void pia(const int *ar, int rows, int cols);
179
180 #endif