Merge branch 'master' of git@git.tuebingen.mpg.de:libdai
[libdai.git] / include / dai / mr.h
1 /* Copyright (C) 2006-2008 Joris Mooij [j dot mooij at science dot ru dot nl]
2 Radboud University Nijmegen, The Netherlands
3
4 This file is part of libDAI.
5
6 libDAI is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 libDAI is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with libDAI; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21
22 #ifndef __defined_libdai_mr_h
23 #define __defined_libdai_mr_h
24
25
26 #include <vector>
27 #include <string>
28 #include <dai/factorgraph.h>
29 #include <dai/daialg.h>
30 #include <dai/enum.h>
31 #include <dai/properties.h>
32 #include <dai/exceptions.h>
33
34
35 namespace dai {
36
37
38 class sub_nb;
39
40
41 class MR : public DAIAlgFG {
42 private:
43 bool supported; // is the underlying factor graph supported?
44
45 std::vector<size_t> con; // con[i] = connectivity of spin i
46 std::vector<std::vector<size_t> > nb; // nb[i] are the neighbours of spin i
47 std::vector<std::vector<double> > tJ; // tJ[i][_j] is the tanh of the interaction between spin i and its neighbour nb[i][_j]
48 std::vector<double> theta; // theta[i] is the local field on spin i
49 std::vector<std::vector<double> > M; // M[i][_j] is M^{(i)}_j
50 std::vector<std::vector<size_t> > kindex; // the _j'th neighbour of spin i has spin i as its kindex[i][_j]'th neighbour
51 std::vector<std::vector<std::vector<double> > > cors;
52
53 static const size_t kmax = 31;
54
55 size_t N;
56
57 std::vector<double> Mag;
58
59 public:
60 struct Properties {
61 size_t verbose;
62 double tol;
63 ENUM2(UpdateType,FULL,LINEAR)
64 ENUM3(InitType,RESPPROP,CLAMPING,EXACT)
65 UpdateType updates;
66 InitType inits;
67 } props;
68 double maxdiff;
69
70 public:
71 MR( const FactorGraph & fg, const PropertySet &opts );
72 void init(size_t Nin, double *_w, double *_th);
73 void makekindex();
74 void read_files();
75 void init_cor();
76 double init_cor_resp();
77 void solvemcav();
78 void solveM();
79 double run();
80 Factor belief( const Var &n ) const;
81 Factor belief( const VarSet &/*ns*/ ) const {
82 DAI_THROW(NOT_IMPLEMENTED);
83 return Factor();
84 }
85 std::vector<Factor> beliefs() const;
86 Real logZ() const {
87 DAI_THROW(NOT_IMPLEMENTED);
88 return 0.0;
89 }
90 void init() {}
91 static const char *Name;
92 std::string identify() const;
93 double _tJ(size_t i, sub_nb A);
94
95 double Omega(size_t i, size_t _j, size_t _l);
96 double T(size_t i, sub_nb A);
97 double T(size_t i, size_t _j);
98 double Gamma(size_t i, size_t _j, size_t _l1, size_t _l2);
99 double Gamma(size_t i, size_t _l1, size_t _l2);
100
101 double appM(size_t i, sub_nb A);
102 void sum_subs(size_t j, sub_nb A, double *sum_even, double *sum_odd);
103
104 double sign(double a) { return (a >= 0) ? 1.0 : -1.0; }
105 MR* clone() const { return new MR(*this); }
106
107 void setProperties( const PropertySet &opts );
108 PropertySet getProperties() const;
109 double maxDiff() const { return maxdiff; }
110 };
111
112
113 // represents a subset of nb[i] as a binary number
114 // the elements of a subset should be thought of as indices in nb[i]
115 class sub_nb {
116 private:
117 size_t s;
118 size_t bits;
119
120 public:
121 // construct full subset containing nr_elmt elements
122 sub_nb(size_t nr_elmt) {
123 #ifdef DAI_DEBUG
124 assert( nr_elmt < sizeof(size_t) / sizeof(char) * 8 );
125 #endif
126 bits = nr_elmt;
127 s = (1U << bits) - 1;
128 }
129
130 // copy constructor
131 sub_nb( const sub_nb & x ) : s(x.s), bits(x.bits) {}
132
133 // assignment operator
134 sub_nb & operator=( const sub_nb &x ) {
135 if( this != &x ) {
136 s = x.s;
137 bits = x.bits;
138 }
139 return *this;
140 }
141
142 // returns number of elements
143 size_t size() {
144 size_t size = 0;
145 for(size_t bit = 0; bit < bits; bit++)
146 if( s & (1U << bit) )
147 size++;
148 return size;
149 }
150
151 // increases s by one (for enumeration in lexicographical order)
152 sub_nb operator++() {
153 s++;
154 if( s >= (1U << bits) )
155 s = 0;
156 return *this;
157 }
158
159 // return i'th element of this subset
160 size_t operator[](size_t i) {
161 size_t bit;
162 for(bit = 0; bit < bits; bit++ )
163 if( s & (1U << bit) ) {
164 if( i == 0 )
165 break;
166 else
167 i--;
168 }
169 #ifdef DAI_DEBUG
170 assert( bit < bits );
171 #endif
172 return bit;
173 }
174
175 // add index _j to this subset
176 sub_nb &operator +=(size_t _j) {
177 s |= (1U << _j);
178 return *this;
179 }
180
181 // return copy with index _j
182 sub_nb operator+(size_t _j) {
183 sub_nb x = *this;
184 x += _j;
185 return x;
186 }
187
188 // delete index _j from this subset
189 sub_nb &operator -=(size_t _j) {
190 s &= ~(1U << _j);
191 return *this;
192 }
193
194 // return copy without index _j
195 sub_nb operator-(size_t _j) {
196 sub_nb x = *this;
197 x -= _j;
198 return x;
199 }
200
201 // empty this subset
202 sub_nb & clear() {
203 s = 0;
204 return *this;
205 }
206
207 // returns true if subset is empty
208 bool empty() { return (s == 0); }
209
210 // return 1 if _j is contained, 0 otherwise ("is element of")
211 size_t operator&(size_t _j) { return s & (1U << _j); }
212
213 friend std::ostream& operator<< (std::ostream& os, const sub_nb x) {
214 if( x.bits == 0 )
215 os << "empty";
216 else {
217 for(size_t bit = x.bits; bit > 0; bit-- )
218 if( x.s & (1U << (bit-1)) )
219 os << "1";
220 else
221 os << "0";
222 }
223 return os;
224 }
225 };
226
227
228 } // end of namespace dai
229
230
231 #endif