Rewrite EM fit for new loop order
[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 struct BA81Expect {
37         double LogLargestDouble;       // should be const but need constexpr
38         double LargestDouble;          // should be const but need constexpr
39         double OneOverLargestDouble;   // should be const but need constexpr
40
41         // data characteristics
42         omxData *data;
43         int numUnique;
44         int *numIdentical;        // length numUnique
45         int *rowMap;              // length numUnique, index of first instance of pattern
46
47         // item description related
48         std::vector<const double*> itemSpec;
49         std::vector<int> itemOutcomes;
50         std::vector<int> cumItemOutcomes;
51         int maxDims;
52         int maxAbilities;
53         int numSpecific;
54         int *Sgroup;              // item's specific group 0..numSpecific-1
55         omxMatrix *design;        // items * maxDims
56
57         // quadrature related
58         double Qwidth;
59         double targetQpoints;
60         long quadGridSize;
61         long totalQuadPoints;     // quadGridSize ^ maxDims
62         long totalPrimaryPoints;  // totalQuadPoints except for specific dim TODO
63         std::vector<double> Qpoint;           // quadGridSize
64         std::vector<double> priQarea;         // totalPrimaryPoints
65         std::vector<double> speQarea;         // quadGridSize * numSpecific
66
67         // estimation related
68         omxMatrix *customPrior;
69         omxMatrix *itemParam;
70         int cacheLXK;
71         bool LXKcached;
72         double *lxk;              // wo/cache, numUnique * thread
73         double *allElxk;          // numUnique * thread
74         double *Eslxk;            // numUnique * #specific dimensions * thread
75         double *patternLik;       // numUnique
76         double SmallestPatternLik;
77         int excludedPatterns;
78         int totalOutcomes;
79         double *outcomeProb;      // totalOutcomes * totalQuadPoints
80         double *expected;         // totalOutcomes * totalQuadPoints
81         std::vector<double> ElatentMean;      // maxAbilities
82         std::vector<double> ElatentCov;       // maxAbilities * maxAbilities
83         omxMatrix *latentMeanOut;
84         omxMatrix *latentCovOut;
85         double *EiCache;          // totalPrimaryPoints * numUnique (two-tier only)
86
87         int itemParamVersion;
88         int latentParamVersion;
89         enum expectation_type type;
90         enum score_option scores;
91         bool verbose;
92 };
93
94 extern const struct rpf *rpf_model;
95 extern int rpf_numModels;
96
97 void ba81OutcomeProb(BA81Expect *state, bool wantLog);
98
99 template<typename _Tp> class omxBuffer {
100         typedef _Tp value_type;
101         typedef _Tp *pointer;
102         typedef _Tp &reference;
103         typedef const _Tp &const_reference;
104         pointer _M_start;
105  public:
106         omxBuffer(size_t size) {
107                 _M_start = new _Tp[size];
108         }
109         omxBuffer(size_t size, const value_type &value) {
110                 _M_start = new _Tp[size];
111                 std::fill_n(_M_start, size, value);
112         }
113         ~omxBuffer() {
114                 delete [] _M_start;
115         }
116         reference operator[](size_t __n)
117         { return *(_M_start + __n); }
118         const_reference operator[](size_t __n) const
119         { return *(_M_start + __n); }
120         pointer data() const
121         { return _M_start; }
122 };
123
124 OMXINLINE static int
125 triangleLoc1(int diag)
126 {
127         //if (diag < 1) error("Out of domain");
128         return (diag) * (diag+1) / 2;   // 0 1 3 6 10 15 ..
129 }
130
131 OMXINLINE static int
132 triangleLoc0(int diag)
133 {
134         //if (diag < 0) error("Out of domain");
135         return triangleLoc1(diag+1) - 1;  // 0 2 5 9 14 ..
136 }
137
138 OMXINLINE static double *
139 eBase(BA81Expect *state, int thr)
140 {
141         return state->allElxk + thr * state->numUnique;
142 }
143
144 OMXINLINE static double *
145 esBase(BA81Expect *state, int thr)
146 {
147         return state->Eslxk + thr * state->numUnique * state->numSpecific;
148 }
149
150 OMXINLINE static void
151 pointToWhere(BA81Expect *state, const int *quad, double *where, int upto)
152 {
153         for (int dx=0; dx < upto; dx++) {
154                 where[dx] = state->Qpoint[quad[dx]];
155         }
156 }
157
158 OMXINLINE static void
159 decodeLocation(long qx, const int dims, const long grid, int *quad)
160 {
161         for (int dx=dims-1; dx >= 0; --dx) {
162                 quad[dx] = qx % grid;
163                 qx = qx / grid;
164         }
165 }
166
167 OMXINLINE static double
168 areaProduct(BA81Expect *state, long qx, int sx, const int sg)
169 {
170         if (state->numSpecific == 0) {
171                 return state->priQarea[qx];
172         } else {
173                 if (sx == -1) {
174                         sx = qx % state->quadGridSize;
175                         qx /= state->quadGridSize;
176                 }
177                 return (state->priQarea[qx] * state->speQarea[sg * state->quadGridSize + sx]);
178         }
179 }
180
181 OMXINLINE static void
182 gramProduct(double *vec, size_t len, double *out)
183 {
184         int cell = 0;
185         for (size_t v1=0; v1 < len; ++v1) {
186                 for (size_t v2=0; v2 <= v1; ++v2) {
187                         out[cell] = vec[v1] * vec[v2];
188                         ++cell;
189                 }
190         }
191 }
192
193 OMXINLINE static bool
194 validPatternLik(BA81Expect *state, double pl)
195 {
196         return isfinite(pl) && pl > state->SmallestPatternLik;
197 }
198
199 // debug tools
200 void pda(const double *ar, int rows, int cols);
201 void pia(const int *ar, int rows, int cols);
202
203 #endif