Fixed exception handling in tests/testdai
[libdai.git] / tests / testdai.cpp
1 /* Copyright (C) 2006-2008 Joris Mooij [joris dot mooij at tuebingen dot mpg dot de]
2 Radboud University Nijmegen, The Netherlands /
3 Max Planck Institute for Biological Cybernetics, Germany
4
5 This file is part of libDAI.
6
7 libDAI is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 libDAI is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with libDAI; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22
23 #include <iostream>
24 #include <fstream>
25 #include <map>
26 #include <numeric>
27 #include <cmath>
28 #include <cstdlib>
29 #include <cstring>
30 #include <boost/program_options.hpp>
31 #include <dai/util.h>
32 #include <dai/alldai.h>
33
34
35 using namespace std;
36 using namespace dai;
37 namespace po = boost::program_options;
38
39
40 class TestDAI {
41 protected:
42 InfAlg *obj;
43 string name;
44 vector<double> err;
45
46 public:
47 vector<Factor> q;
48 double logZ;
49 double maxdiff;
50 double time;
51 size_t iters;
52 bool has_logZ;
53 bool has_maxdiff;
54 bool has_iters;
55
56 TestDAI( const FactorGraph &fg, const string &_name, const PropertySet &opts ) : obj(NULL), name(_name), err(), q(), logZ(0.0), maxdiff(0.0), time(0), iters(0U), has_logZ(false), has_maxdiff(false), has_iters(false) {
57 double tic = toc();
58 if( name == "LDPC" ) {
59 double zero[2] = {1.0, 0.0};
60 q.clear();
61 for( size_t i = 0; i < fg.nrVars(); i++ )
62 q.push_back( Factor(Var(i,2), zero) );
63 logZ = 0.0;
64 maxdiff = 0.0;
65 iters = 1;
66 has_logZ = false;
67 has_maxdiff = false;
68 has_iters = false;
69 } else
70 obj = newInfAlg( name, fg, opts );
71 time += toc() - tic;
72 }
73
74 ~TestDAI() {
75 if( obj != NULL )
76 delete obj;
77 }
78
79 string identify() {
80 if( obj != NULL )
81 return obj->identify();
82 else
83 return "NULL";
84 }
85
86 vector<Factor> allBeliefs() {
87 vector<Factor> result;
88 for( size_t i = 0; i < obj->fg().nrVars(); i++ )
89 result.push_back( obj->belief( obj->fg().var(i) ) );
90 return result;
91 }
92
93 void doDAI() {
94 double tic = toc();
95 if( obj != NULL ) {
96 obj->init();
97 obj->run();
98 time += toc() - tic;
99
100 try {
101 logZ = obj->logZ();
102 has_logZ = true;
103 } catch( Exception &e ) {
104 if( e.code() == Exception::NOT_IMPLEMENTED )
105 has_logZ = false;
106 else
107 throw;
108 }
109
110 try {
111 maxdiff = obj->maxDiff();
112 has_maxdiff = true;
113 } catch( Exception &e ) {
114 if( e.code() == Exception::NOT_IMPLEMENTED )
115 has_maxdiff = false;
116 else
117 throw;
118 }
119
120 try {
121 iters = obj->Iterations();
122 has_iters = true;
123 } catch( Exception &e ) {
124 if( e.code() == Exception::NOT_IMPLEMENTED )
125 has_iters = false;
126 else
127 throw;
128 }
129
130 q = allBeliefs();
131 };
132 }
133
134 void calcErrs( const TestDAI &x ) {
135 err.clear();
136 err.reserve( q.size() );
137 for( size_t i = 0; i < q.size(); i++ )
138 err.push_back( dist( q[i], x.q[i], Prob::DISTTV ) );
139 }
140
141 void calcErrs( const vector<Factor> &x ) {
142 err.clear();
143 err.reserve( q.size() );
144 for( size_t i = 0; i < q.size(); i++ )
145 err.push_back( dist( q[i], x[i], Prob::DISTTV ) );
146 }
147
148 double maxErr() {
149 return( *max_element( err.begin(), err.end() ) );
150 }
151
152 double avgErr() {
153 return( accumulate( err.begin(), err.end(), 0.0 ) / err.size() );
154 }
155 };
156
157
158 pair<string, PropertySet> parseMethod( const string &_s, const map<string,string> & aliases ) {
159 // s = first part of _s, until '['
160 string::size_type pos = _s.find_first_of('[');
161 string s;
162 if( pos == string::npos )
163 s = _s;
164 else
165 s = _s.substr(0,pos);
166
167 // if the first part is an alias, substitute
168 if( aliases.find(s) != aliases.end() )
169 s = aliases.find(s)->second;
170
171 // attach second part, merging properties if necessary
172 if( pos != string::npos ) {
173 if( s.at(s.length()-1) == ']' ) {
174 s = s.erase(s.length()-1,1) + ',' + _s.substr(pos+1);
175 } else
176 s = s + _s.substr(pos);
177 }
178
179 pair<string, PropertySet> result;
180 string & name = result.first;
181 PropertySet & opts = result.second;
182
183 pos = s.find_first_of('[');
184 if( pos == string::npos )
185 throw "Malformed method";
186 name = s.substr( 0, pos );
187 size_t n = 0;
188 for( ; strlen( DAINames[n] ) != 0; n++ )
189 if( name == DAINames[n] )
190 break;
191 if( strlen( DAINames[n] ) == 0 && (name != "LDPC") )
192 DAI_THROW(UNKNOWN_DAI_ALGORITHM);
193
194 stringstream ss;
195 ss << s.substr(pos,s.length());
196 ss >> opts;
197
198 return result;
199 }
200
201
202 double clipdouble( double x, double minabs ) {
203 if( fabs(x) < minabs )
204 return minabs;
205 else
206 return x;
207 }
208
209
210 int main( int argc, char *argv[] ) {
211 string filename;
212 string aliases;
213 vector<string> methods;
214 double tol;
215 size_t maxiter;
216 size_t verbose;
217 bool marginals = false;
218 bool report_iters = true;
219 bool report_time = true;
220
221 po::options_description opts_required("Required options");
222 opts_required.add_options()
223 ("filename", po::value< string >(&filename), "Filename of FactorGraph")
224 ("methods", po::value< vector<string> >(&methods)->multitoken(), "DAI methods to test")
225 ;
226
227 po::options_description opts_optional("Allowed options");
228 opts_optional.add_options()
229 ("help", "produce help message")
230 ("aliases", po::value< string >(&aliases), "Filename for aliases")
231 ("tol", po::value< double >(&tol), "Override tolerance")
232 ("maxiter", po::value< size_t >(&maxiter), "Override maximum number of iterations")
233 ("verbose", po::value< size_t >(&verbose), "Override verbosity")
234 ("marginals", po::value< bool >(&marginals), "Output single node marginals?")
235 ("report-time", po::value< bool >(&report_time), "Report calculation time")
236 ("report-iters", po::value< bool >(&report_iters), "Report iterations needed")
237 ;
238
239 po::options_description cmdline_options;
240 cmdline_options.add(opts_required).add(opts_optional);
241
242 po::variables_map vm;
243 po::store(po::parse_command_line(argc, argv, cmdline_options), vm);
244 po::notify(vm);
245
246 if( vm.count("help") || !(vm.count("filename") && vm.count("methods")) ) {
247 cout << "Reads factorgraph <filename.fg> and performs the approximate" << endl;
248 cout << "inference algorithms <method*>, reporting calculation time, max and average" << endl;
249 cout << "error and relative logZ error (comparing with the results of" << endl;
250 cout << "<method0>, the base method, for which one can use JTREE_HUGIN)." << endl << endl;
251 cout << opts_required << opts_optional << endl;
252 return 1;
253 }
254
255 // Read aliases
256 map<string,string> Aliases;
257 if( !aliases.empty() ) {
258 ifstream infile;
259 infile.open (aliases.c_str());
260 if (infile.is_open()) {
261 while( true ) {
262 string line;
263 getline(infile,line);
264 if( infile.fail() )
265 break;
266 if( (!line.empty()) && (line[0] != '#') ) {
267 string::size_type pos = line.find(':',0);
268 if( pos == string::npos )
269 throw "Invalid alias";
270 else {
271 string::size_type posl = line.substr(0, pos).find_last_not_of(" \t");
272 string key = line.substr(0, posl + 1);
273 string::size_type posr = line.substr(pos + 1, line.length()).find_first_not_of(" \t");
274 string val = line.substr(pos + 1 + posr, line.length());
275 Aliases[key] = val;
276 }
277 }
278 }
279 infile.close();
280 } else
281 throw "Error opening aliases file";
282 }
283
284 FactorGraph fg;
285 fg.ReadFromFile( filename.c_str() );
286
287 vector<Factor> q0;
288 double logZ0 = 0.0;
289
290 cout.setf( ios_base::scientific );
291 cout.precision( 3 );
292
293 cout << "# " << filename << endl;
294 cout.width( 39 );
295 cout << left << "# METHOD" << "\t";
296 if( report_time )
297 cout << right << "SECONDS " << "\t";
298 if( report_iters )
299 cout << "ITERS" << "\t";
300 cout << "MAX ERROR" << "\t";
301 cout << "AVG ERROR" << "\t";
302 cout << "LOGZ ERROR" << "\t";
303 cout << "MAXDIFF" << "\t";
304 cout << endl;
305
306 for( size_t m = 0; m < methods.size(); m++ ) {
307 pair<string, PropertySet> meth = parseMethod( methods[m], Aliases );
308
309 if( vm.count("tol") )
310 meth.second.Set("tol",tol);
311 if( vm.count("maxiter") )
312 meth.second.Set("maxiter",maxiter);
313 if( vm.count("verbose") )
314 meth.second.Set("verbose",verbose);
315 TestDAI piet(fg, meth.first, meth.second );
316 piet.doDAI();
317 if( m == 0 ) {
318 q0 = piet.q;
319 logZ0 = piet.logZ;
320 }
321 piet.calcErrs(q0);
322
323 cout.width( 39 );
324 cout << left << methods[m] << "\t";
325 if( report_time )
326 cout << right << piet.time << "\t";
327 if( report_iters ) {
328 if( piet.has_iters ) {
329 cout << piet.iters << "\t";
330 } else {
331 cout << "N/A \t";
332 }
333 }
334
335 if( m > 0 ) {
336 cout.setf( ios_base::scientific );
337 cout.precision( 3 );
338
339 double me = clipdouble( piet.maxErr(), 1e-9 );
340 cout << me << "\t";
341
342 double ae = clipdouble( piet.avgErr(), 1e-9 );
343 cout << ae << "\t";
344
345 if( piet.has_logZ ) {
346 cout.setf( ios::showpos );
347 double le = clipdouble( piet.logZ / logZ0 - 1.0, 1e-9 );
348 cout << le << "\t";
349 cout.unsetf( ios::showpos );
350 } else
351 cout << "N/A \t";
352
353 if( piet.has_maxdiff ) {
354 double md = clipdouble( piet.maxdiff, 1e-9 );
355 if( isnan( me ) )
356 md = me;
357 if( isnan( ae ) )
358 md = ae;
359 cout << md << "\t";
360 } else
361 cout << "N/A \t";
362 }
363 cout << endl;
364
365 if( marginals ) {
366 for( size_t i = 0; i < piet.q.size(); i++ )
367 cout << "# " << piet.q[i] << endl;
368 }
369 }
370
371 return 0;
372 }