Use full range of double
[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         int maxDims;
51         int maxAbilities;
52         int numSpecific;
53         int *Sgroup;              // item's specific group 0..numSpecific-1
54         omxMatrix *design;        // items * maxDims
55
56         // quadrature related
57         double Qwidth;
58         double targetQpoints;
59         long quadGridSize;
60         long totalQuadPoints;     // quadGridSize ^ maxDims
61         long totalPrimaryPoints;  // totalQuadPoints except for specific dim TODO
62         std::vector<double> Qpoint;           // quadGridSize
63         std::vector<double> priQarea;         // totalPrimaryPoints
64         std::vector<double> speQarea;         // quadGridSize * numSpecific
65
66         // estimation related
67         omxMatrix *customPrior;
68         omxMatrix *itemParam;
69         omxMatrix *EitemParam;    // E step version
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 computeRPF(BA81Expect *state, omxMatrix *itemParam, const int *quad,
98                 const bool wantlog, double *outcomeProb);
99 void cai2010(omxExpectation* oo, const int thrId, int recompute, const long qx);
100 double *ba81LikelihoodFast1(omxExpectation *oo, const int thrId, int specific, const long qx);
101
102 OMXINLINE static int
103 triangleLoc1(int diag)
104 {
105         //if (diag < 1) error("Out of domain");
106         return (diag) * (diag+1) / 2;   // 0 1 3 6 10 15 ..
107 }
108
109 OMXINLINE static int
110 triangleLoc0(int diag)
111 {
112         //if (diag < 0) error("Out of domain");
113         return triangleLoc1(diag+1) - 1;  // 0 2 5 9 14 ..
114 }
115
116 OMXINLINE static double *
117 eBase(BA81Expect *state, int thr)
118 {
119         return state->allElxk + thr * state->numUnique;
120 }
121
122 OMXINLINE static double *
123 esBase(BA81Expect *state, int thr)
124 {
125         return state->Eslxk + thr * state->numUnique * state->numSpecific;
126 }
127
128 OMXINLINE static void
129 pointToWhere(BA81Expect *state, const int *quad, double *where, int upto)
130 {
131         for (int dx=0; dx < upto; dx++) {
132                 where[dx] = state->Qpoint[quad[dx]];
133         }
134 }
135
136 OMXINLINE static void
137 decodeLocation(long qx, const int dims, const long grid, int *quad)
138 {
139         for (int dx=dims-1; dx >= 0; --dx) {
140                 quad[dx] = qx % grid;
141                 qx = qx / grid;
142         }
143 }
144
145 OMXINLINE static double
146 areaProduct(BA81Expect *state, long qx, int sx, const int sg)
147 {
148         if (state->numSpecific == 0) {
149                 return state->priQarea[qx];
150         } else {
151                 if (sx == -1) {
152                         sx = qx % state->quadGridSize;
153                         qx /= state->quadGridSize;
154                 }
155                 return (state->priQarea[qx] * state->speQarea[sg * state->quadGridSize + sx]);
156         }
157 }
158
159 OMXINLINE static void
160 gramProduct(double *vec, size_t len, double *out)
161 {
162         int cell = 0;
163         for (size_t v1=0; v1 < len; ++v1) {
164                 for (size_t v2=0; v2 <= v1; ++v2) {
165                         out[cell] = vec[v1] * vec[v2];
166                         ++cell;
167                 }
168         }
169 }
170
171 OMXINLINE static bool
172 validPatternLik(BA81Expect *state, double pl)
173 {
174         return isfinite(pl) && pl > state->SmallestPatternLik;
175 }
176
177 // debug tools
178 void pda(const double *ar, int rows, int cols);
179 void pia(const int *ar, int rows, int cols);
180
181 #endif