Multigroup two-tier
[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
23 enum score_option {
24         SCORES_OMIT,
25         SCORES_UNIQUE,
26         SCORES_FULL
27 };
28
29 typedef struct {
30
31         // data characteristics
32         omxData *data;
33         int numUnique;
34         int *numIdentical;        // length numUnique
35         double *logNumIdentical;  // length numUnique
36         int *rowMap;              // length numUnique, index of first instance of pattern
37
38         // item description related
39         omxMatrix *itemSpec;
40         int maxOutcomes;
41         int maxDims;
42         int maxAbilities;
43         int numSpecific;
44         int *Sgroup;              // item's specific group 0..numSpecific-1
45         omxMatrix *design;        // items * maxDims
46
47         // quadrature related
48         double Qwidth;
49         double targetQpoints;
50         long quadGridSize;
51         long totalQuadPoints;     // quadGridSize ^ maxDims
52         long totalPrimaryPoints;  // totalQuadPoints except for specific dim TODO
53         std::vector<double> Qpoint;           // quadGridSize
54         std::vector<double> priLogQarea;      // totalPrimaryPoints
55         std::vector<double> speLogQarea;      // quadGridSize * numSpecific
56
57         // estimation related
58         omxMatrix *EitemParam;    // E step version
59         int cacheLXK;
60         double *lxk;              // wo/cache, numUnique * thread
61         std::vector<double> allElxk;          // numUnique * thread
62         std::vector<double> Eslxk;            // numUnique * #specific dimensions * thread
63         double *patternLik;       // numUnique
64         int totalOutcomes;
65         double *expected;         // totalOutcomes * totalQuadPoints
66         double *ElatentMean;      // maxAbilities * numUnique
67         double *ElatentCov;       // maxAbilities * maxAbilities * numUnique ; only lower triangle is used
68         omxMatrix *latentMeanOut;
69         omxMatrix *latentCovOut;
70
71         bool validExpectation;
72         enum score_option scores;
73 } BA81Expect;
74
75 extern const struct rpf *rpf_model;
76 extern int rpf_numModels;
77
78 double *
79 computeRPF(BA81Expect *state, omxMatrix *itemSpec, omxMatrix *design, omxMatrix *itemParam,
80            int maxDims, int maxOutcomes, const int *quad);
81
82 OMXINLINE static void
83 pointToWhere(BA81Expect *state, const int *quad, double *where, int upto)
84 {
85         for (int dx=0; dx < upto; dx++) {
86                 where[dx] = state->Qpoint[quad[dx]];
87         }
88 }
89
90 OMXINLINE static long
91 encodeLocation(const int dims, const long grid, const int *quad)
92 {
93         long qx = 0;
94         for (int dx=dims-1; dx >= 0; dx--) {
95                 qx = qx * grid;
96                 qx += quad[dx];
97         }
98         return qx;
99 }
100
101 OMXINLINE static void
102 decodeLocation(long qx, const int dims, const long grid, int *quad)
103 {
104         for (int dx=0; dx < dims; dx++) {
105                 quad[dx] = qx % grid;
106                 qx = qx / grid;
107         }
108 }
109
110 OMXINLINE static double
111 logAreaProduct(BA81Expect *state, const int *quad, const int sg)
112 {
113         int maxDims = state->maxDims;
114         if (state->numSpecific == 0) {
115                 long qloc = encodeLocation(maxDims, state->quadGridSize, quad);
116                 return state->priLogQarea[qloc];
117         } else {
118                 long priloc = encodeLocation(maxDims-1, state->quadGridSize, quad);
119                 return (state->priLogQarea[priloc] +
120                         state->speLogQarea[sg * state->quadGridSize + quad[maxDims - 1]]);
121         }
122 }
123
124 // debug tools
125 void pda(const double *ar, int rows, int cols);
126 void pia(const int *ar, int rows, int cols);
127
128 #endif