Auto-tune Newton-Raphson
[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 maxDims;
48         int maxAbilities;
49         int numSpecific;
50         int *Sgroup;              // item's specific group 0..numSpecific-1
51         omxMatrix *design;        // items * maxDims
52
53         // quadrature related
54         double Qwidth;
55         double targetQpoints;
56         long quadGridSize;
57         long totalQuadPoints;     // quadGridSize ^ maxDims
58         long totalPrimaryPoints;  // totalQuadPoints except for specific dim TODO
59         std::vector<double> Qpoint;           // quadGridSize
60         std::vector<double> priQarea;         // totalPrimaryPoints
61         std::vector<double> speQarea;         // quadGridSize * numSpecific
62
63         // estimation related
64         omxMatrix *customPrior;
65         omxMatrix *itemParam;
66         omxMatrix *EitemParam;    // E step version
67         int cacheLXK;
68         bool LXKcached;
69         double *lxk;              // wo/cache, numUnique * thread
70         double *allElxk;          // numUnique * thread
71         double *Eslxk;            // numUnique * #specific dimensions * thread
72         double *patternLik;       // numUnique
73         int excludedPatterns;
74         int totalOutcomes;
75         double *outcomeProb;      // totalOutcomes * totalQuadPoints
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         double *EiCache;          // totalPrimaryPoints * numUnique (two-tier only)
82
83         int itemParamVersion;
84         int latentParamVersion;
85         enum expectation_type type;
86         enum score_option scores;
87         bool verbose;
88 } BA81Expect;
89
90 extern const struct rpf *rpf_model;
91 extern int rpf_numModels;
92
93 void computeRPF(BA81Expect *state, omxMatrix *itemParam, const int *quad,
94                 const bool wantlog, double *outcomeProb);
95 void cai2010(omxExpectation* oo, const int thrId, int recompute, const long qx);
96 double *ba81LikelihoodFast1(omxExpectation *oo, const int thrId, int specific, const long qx);
97
98 OMXINLINE static int
99 triangleLoc1(int diag)
100 {
101         //if (diag < 1) error("Out of domain");
102         return (diag) * (diag+1) / 2;   // 0 1 3 6 10 15 ..
103 }
104
105 OMXINLINE static int
106 triangleLoc0(int diag)
107 {
108         //if (diag < 0) error("Out of domain");
109         return triangleLoc1(diag+1) - 1;  // 0 2 5 9 14 ..
110 }
111
112 OMXINLINE static double *
113 eBase(BA81Expect *state, int thr)
114 {
115         return state->allElxk + thr * state->numUnique;
116 }
117
118 OMXINLINE static double *
119 esBase(BA81Expect *state, int thr)
120 {
121         return state->Eslxk + thr * state->numUnique * state->numSpecific;
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 void
133 decodeLocation(long qx, const int dims, const long grid, int *quad)
134 {
135         for (int dx=dims-1; dx >= 0; --dx) {
136                 quad[dx] = qx % grid;
137                 qx = qx / grid;
138         }
139 }
140
141 OMXINLINE static double
142 areaProduct(BA81Expect *state, long qx, int sx, const int sg)
143 {
144         if (state->numSpecific == 0) {
145                 return state->priQarea[qx];
146         } else {
147                 if (sx == -1) {
148                         sx = qx % state->quadGridSize;
149                         qx /= state->quadGridSize;
150                 }
151                 return (state->priQarea[qx] * state->speQarea[sg * state->quadGridSize + sx]);
152         }
153 }
154
155 OMXINLINE static void
156 gramProduct(double *vec, size_t len, double *out)
157 {
158         int cell = 0;
159         for (size_t v1=0; v1 < len; ++v1) {
160                 for (size_t v2=0; v2 <= v1; ++v2) {
161                         out[cell] = vec[v1] * vec[v2];
162                         ++cell;
163                 }
164         }
165 }
166
167 OMXINLINE static bool
168 validPatternLik(double pl)
169 {
170         return isfinite(pl) && pl > 1e-300;
171 }
172
173 // debug tools
174 void pda(const double *ar, int rows, int cols);
175 void pia(const int *ar, int rows, int cols);
176
177 #endif