Updated ChangeLog
[libdai.git] / ChangeLog
1 git ae0fc30e10be6683cbfc209dcee56f34234a6cb8
2 --------------------------------------------
3 * Added work-around for bug in Boost Graph Library
4 * Improvements of TFactor<T>:
5 - Extended functionality of TFactor<T>::operators +,-,+=,-= to handle different VarSets
6 - Added TFactor<T>::maxMarginal (similar to marginal but with max instead of sum)
7 * Added BipartiteGraph::eraseEdge
8 * Removed all the virtual default constructors *::create(), as they are not used.
9 * Fixed bug in MaxSpanningTree (it wrongly assumed that the tree was not empty).
10 * [Charlie Vaske] Added Expectation Maximization code.
11 * Added MatLab QuickStart to README.
12 * MEX file dai now also returns variable and factor beliefs.
13 * Cleanups and extra documentation of the code contributed by Frederik Eaton
14 * Removed erroneous 'inline' directives in gibbs.cpp
15 * [Frederik Eaton] Added script for automatically generating properties code (used by CBP and BBP)
16 * [Frederik Eaton] Updated doxygen.conf to version 1.5.9
17 * [Frederik Eaton] Added newInfAlgFromString to alldai.h/cpp
18 * [Frederik Eaton] Added FactorGraph::clampVar and FactorGraph::clampFactor
19 * [Frederik Eaton] Changed BP to be able to record order in which messages are sent (for use by BBP)
20 * [Frederik Eaton] Improved documentation of BipartiteGraph::Neighbor
21 * [Frederik Eaton]: Extended InfAlg interface with beliefV() and beliefF() methods;
22 * [Frederik Eaton]: Improved PropertySet class:
23 - Added default constructor
24 - Allow construction from string
25 - Added method allKeys() to produce list of keys
26 - In getStringAs(), check for typeid(ValueType) before typeid(std::string)
27 (this fixes a strange bug for empty string property)
28 * [Frederik Eaton]: Added some utility macros (DAI_PV, DAI_DMSG, DAI_ACCMUT, DAI_IFVERB)
29 and functions (concat(),rnd()) to include/dai/util.h
30 * [Frederik Eaton] Added backwards compatibility layer for edge interface to
31 BipartiteGraph and FactorGraph (which will be obsoleted soon)
32 * [Frederik Eaton] Added BP_dual, BBP and CBP algorithms
33 * [Frederik Eaton] Added Gibbs::state() accessors/mutators
34 * [Frederik Eaton] Fixed Gibbs::getVarDist(size_t) to return uniform
35 distribution if no state is allowed
36 * [Frederik Eaton] Improved parsing code in tests/testdai to allow recursive
37 alias substitutions
38 * Interface changes:
39 TProb<T>::minVal() -> TProb<T>::min()
40 TFactor<T>::minVal() -> TFactor<T>::min()
41 TProb<T>::maxVal() -> TProb<T>::max()
42 TFactor<T>::maxVal() -> TFactor<T>::max()
43 TProb<T>::totalSum() -> TProb<T>sum()
44 TFactor<T>::totalSum() -> TFactor<T>::sum()
45 * [Frederik Eaton] Added methods setUniform (), sumAbs(), argmax() to TProb<T>
46 * [Frederik Eaton] Added TAGS, lib targets to Makefile
47 * [Frederik Eaton] Add useful aliases to aliases.conf
48 * [Frederik Eaton] Removed unnecessary copy constructors and assignment
49 operators
50 * [Frederik Eaton] Change cout to cerr in warnings and error messages
51 * [Giuseppe Passino] Optimised maximum-residual BP by using a reversed ordered
52 set instead of the linear search (which can yield enormous speedups - a
53 factor 500 has been measured on a binary Ising grid with 128x128 variables!)
54 * Added debug assertions to Var which check for inconsistent dimensions of
55 variables with the same labels
56 * [Giuseppe Passino] Added prefix ++ operator to State (State::operator++())
57 * [Giuseppe Passino] Added iterators to FactorGraph (FactorGraph::begin,
58 FactorGraph::end)
59 * [Giuseppe Passino] Added iterators to TFactor (TFactor::begin, TFactor::end)
60 * [Giuseppe Passino] Added iterators to TProb (TProb::begin, TProb::end)
61 * [Giuseppe Passino] Added BP::findMaximum(), which can be used after running
62 max-product BP to construct a global state with maximum probability
63 * Improved Makefile (libDAI now also builds out-of-the-box on MacOSX,
64 thanks to Dan Preston; merged Makefile.win and Makefile.shared into Makefile)
65 * Fixed bug in calcMarginal, calcPairBeliefs, calcPairBeliefsNew where
66 states with zero probability mass were clamped, leading to NaNs or assertion
67 errors (thanks to Dan Preston for reporting this)
68 * toc() now returns POSIX system time with maximum accuracy of microseconds
69 * Exception objects now remember their error code
70 * Added examples/example_sprinkler.cpp
71 * [Peter Gober] Made libDAI build out-of-the-box on Cygwin.
72 * [Frederik Eaton] Added Gibbs sampler to algorithms
73 * Improved documentation of include/dai/{bipgraph.h, prob.h, smallset.h,
74 var.h, varset.h, factor.h, enum.h} and of examples/example.cpp
75 Merged TODO and FILEFORMAT into doxygen documentation
76 * examples/
77 - Moved example.cpp to examples/
78 - Added examples/example_bipgraph.cpp
79 - Added examples/example_varset.cpp
80 * Interface changes:
81 - Replaced TProb<T>::log0() by TProb<T>::log(true)
82 - Replaced TProb<T>::takeLog0() by TProb<T>::takeLog(true)
83 - Replaced TFactor<T>::log0() by TFactor<T>::log(true)
84 - Removed TProb<T>::hasNonPositives()
85 - Renamed smallSet<T> to SmallSet<T>
86 - Removed TFactor<T>::divided_by, use operator/ instead
87 - Removed TFactor<T>::divide, use operator/= instead
88 - Removed TFactor<T>::partSum(const VarSet&), use marginal(const VarSet&,true) instead
89 - Improved constructors of TProb and TFactor to use iterators instead of pointers
90 * Miscellaneous small changes and cleanups:
91 - Changed regression test so that it also works under Windows
92 - Changed output stream operator<< for Var and VarSet
93 - Added TProb::draw() function, which draws a random index
94 - Cleanup of matlab interface code
95 - Small improvement of utils/fginfo
96 - Small cleanup of BP code
97 - Switched Makefile.win to GNU Make syntax
98
99
100 libDAI-0.2.2 (2008-09-30)
101 -------------------------
102
103 New features:
104 * Approximate inference methods now report the number of iterations needed.
105 * Added damping to various algorithms to improve convergence properties.
106 * Added more features to utils/createfg for creating factor graphs.
107 * Added ExactInf class for brute force exact inference.
108 * [Giuseppe Pasino] Added "logdomain" property to BP, a boolean that controls
109 whether calculations are done in the log-domain or in the linear domain;
110 doing calculations in the log-domain may help if the numerical range
111 of a double is too small.
112 * [Claudio Lima] Added Max-Product functionality to BP.
113 * Improved documentation.
114
115 Improved architecture:
116 * Added Exceptions framework.
117 * Pervasive change of BipartiteGraph implementation (based on an idea by
118 Giuseppe Passino). BipartiteGraph no longer stores the node properties
119 (former _V1 and _V2), nor does it store a dense adjacency matrix anymore,
120 nor an edge list. Instead, it stores the graph structure as lists of
121 neighboring nodes. This yields a significant memory/speed improvement for
122 large factor graphs, and is more elegant as well. Iterating over neighbors is
123 made easy by using boost::foreach.
124 * Added conditional compilation of inference methods.
125 * VarSet is now implemented using a std::vector<Var> instead of a
126 std::set<Var>, which yields a significant speed improvement. Furthermore,
127 the implementation has been generalized, resulting in the small_set<T> class
128 which can be used to represent sets of small cardinality; VarSet is the
129 specialization with T = Var.
130 * Improved ClusterGraph implementation, yielding significant speedups
131 for the JunctionTree algorithm on large factorgraphs.
132
133 Code cleanup:
134 * Moved everything into namespace "dai".
135 * Renamed DEBUG to DAI_DEBUG to avoid conflicts.
136 * Replaced ENUM2,ENUM3,ENUM4,ENUM5,ENUM6 by single DAI_ENUM macro.
137 * Removed utils/remove_short_loops and matlab/remove_short_loops.
138 * Replaced sub_nb class in mr.h by boost::dynamic_bitset.
139 * Improved index.h:
140 - Renamed Index -> IndexFor
141 - Added some .reserve()'s to IndexFor methods which yields a
142 25% speedup of testregression
143 - Replaced multind by Permute
144 - Added MultiFor
145 - Added State
146 * New funcstionality of factor.h.
147 * Moved Properties and MaxDiff frameworks from InfAlg to each individual
148 inference algorithm, because the Properties framework was not as
149 convenient as I hoped, and not every inference algorithm needs a maxdiff
150 variable. Also, replaced some FactorGraph functionality in InfAlg by a
151 function that returns the FactorGraph. The result is cleaner (less
152 entangled) code.
153 * Removed x2x.
154 * Replaced Complex with real numbers (negative potentials are just too rare
155 to warrant the additional "complexity" :)).
156
157 Miscellaneous improvements:
158 * Now compiles also with MS Visual C++ (thanks to Jiuxiang Hu) and with
159 GCC under cygwin.
160 * Contributions by Peter Gober:
161 - Renamed variable _N in mr.* for compatibility with g++ under cygwin.
162 * Misc contributions by Giuseppe Passino:
163 - removed "using namespace std;" from header files - bad practice;
164 - moved header files in include/dai and sources in src;
165 - changed #ifndefs to GNU style;
166 - added extra warning checks (-W -Wextra) and fixed resulting warnings;
167 - dai::TProb:
168 o removed copy constructor and assignment operators (redundant);
169 o implementation of some methods via STL algorithms;
170 o added methods takeExp, takeLog, takeLog0 for transformation in-place;
171 o explicit constructor (prevents implicit conversion from size_t to TProb);
172 o added operator+,+=,-,-=, with argument T (for calculations in log-scale);
173 * Misc contributions by Christian Wojek:
174 - New FactorGraph constructor that constructs from given ranges of factors
175 and variables;
176 - Optimization of FactorGraph constructors using tr1::unordered_map.
177 * FactorGraph constructors no longer check for short loops (huge speed
178 increase for large factor graphs), nor for negative entries. Also, the
179 normtype is now Prob::NORMPROB by default.
180 * Improved MaxSpanningTreePrims algorithm (uses boost::graph).
181
182 Interface changes:
183 * VarSet::
184 - VarSet::stateSpace() -> nrStates(const VarSet &)
185 - VarSet( const std::set<Var> ) -> VarSet( begin, end, sizeHint=0 )
186 - VarSet( const std::vector<Var> ) -> VarSet( begin, end, sizeHint=0 )
187 - removed bool operator||
188 - operator&&(const VarSet&) -> intersects(const VarSet&)
189 - operator&&(const Var&) -> contains(const Var&)
190 * FactorGraph::
191 - delta(const Var &) -> delta(size_t)
192 - Delta(const Var &) -> Delta(size_t)
193 - makeCavity(const Var &) -> makeCavity(size_t)
194 - vars() -> vars
195 - factors() -> factors
196 - removed MakeFactorCavity(size_t)
197 - removed ExactMarginal(const VarSet &)
198 - removed ExactlogZ()
199 - removed updatedFactor(size_t)
200 - removed _normtype and NormType()
201 - removed hasShortLoops(...) and removeShortLoops(...)
202 - WriteToDotFile(const char *filename) -> printDot( std::ostream& os )
203 - undoProb(size_t) -> restoreFactor(size_t)
204 - saveProb(size_t) -> backupFactor(size_t)
205 - undoProbs(const VarSet &) -> restoreFactors(const VarSet &)
206 - saveProbs(const VarSet &) -> backupFactors(const VarSet &)
207 - ReadFromFile(const char*) returns void (throws on error)
208 - WriteToFile(const char*) returns void (throws on error)
209 - removed hasNegatives()
210 * RegionGraph::
211 - nr_ORs() -> nrORs()
212 - nr_IRs() -> nrIRs()
213 - ORs() -> ORs
214 - IRs() -> IRs
215 * *::Regenerate() -> *::construct()
216 * Renamed Index -> IndexFor
217 * Diffs:
218 - max() -> maxDiff()
219 - max_size() -> maxSize()
220 * Prob::max() -> Prob::maxVal()
221 * Factor::
222 - max() -> maxVal()
223 - part_sum() -> partSum()
224 * toc() in util.h now returns seconds as a double
225 * VarSet::operator&&
226 * Properties -> PropertySet
227
228
229 libDAI-0.2.1 (2008-05-26)
230 -------------------------
231
232 Bugfix release.
233 * added missing cstdio header in util.h
234 * fixed Properties in MR_CLAMPING_* and MR_EXACT_*
235 * added description of the factor graph fileformat
236 * improved Makefile
237
238
239 libDAI-0.2.0 (2006-11-30)
240 -------------------------
241
242 First public release.
243
244
245 0.1.5 (2006-11-30)
246 ------------------
247
248 Regressions
249
250 - tests/testlcbp and tests/testlcbp are broken.
251 - EXACT method does not work anymore.
252 - The Properties framework gives a speed penalty because of the lookup
253 costs involved; inner loops should be optimized.
254
255 General framework
256
257 - DAIAlg is now a template class; typedefs for DAIAlg<FactorGraph> and for
258 DAIAlg<RegionGraph> are provided. In this way, we do not have to write "wrapper"
259 functions to forward functionality from either FactorGraph or RegionGraph
260 to DAIAlg. Functionality like clamping can be implemented in FactorGraph
261 and in RegionGraph and no explicit interface is needed in descendants.
262 - New abstract base class InfAlg added, representing an inference algorithm,
263 from which DAIAlg<T> inherits. This solves the incompatibility problems of
264 DAIAlg<T> for different T (e.g. DAIAlg<FactorGraph> was incompatible with
265 DAIAlg<RegionGraph>). More work is required to reduce code duplication
266 (make FactorGraph part of InfAlg).
267 - Added generic interface (nrVars(), Vars(), nrFactors(), factor(size_t),
268 beliefs(), belief(VarSet &), ...) to InfAlg and descendants.
269 - Added a saveProbs/undoProbs interface to InfAlg and descendants that enables
270 one to save a few factors, modify them (e.g. clamp them), and then restore them
271 to their old values. Undo should also init the corresponding messages / beliefs.
272 This can be used if a given factor graph repeatedly needs to be clamped in
273 different ways and an approximation method is run for each clamping; using the
274 saveProbs/undoProbs can give a significant speed increase.
275 - Switched to a general Properties framework that handles the parameters of
276 all inference methods in a uniform manner. The Properties class is a map of
277 several properties in boost::any objects, indexed by their names (strings).
278 It can read from a stream and write to a stream. It is recursive, in the sense
279 that a Properties object can hold a variable of type Properties as well.
280 - Added a generic way of constructing inference algorithms from a factor graph,
281 name and properties object. Added the newInfAlg function which constructs
282 the requested object. This is used by LCBP, the Matlab interface and the
283 command line (test) interface.
284 - Added a generic enum framework for enum parameters. Although implemented as a
285 hack, it is quite useful in that it drastically simplifies and reduces the
286 amount of code for handling enum parameters.
287 - Provided generic functions for calculating marginals in different ways that
288 work for all approximate inference methods.
289
290 Bugfixes
291
292 - Fixed GBP free energy.
293 - Fixed bug in junctiontree (it didn't init the _vars variable).
294 - Corrected two bugs in operator&& and operator|| in VarSet (they returned
295 the logical NOT of what they should return).
296 - Fixed bug in RegionGraph::RecomputeOR(s).
297 - Fixed bug in utils/create_dreg_fg:
298 graph structure was not random for given parameters (forgot to call srand()).
299 - TreeEP bug workaround: use the complete junction tree instead of a subtree.
300 - Fixed bug in JTree::HUGIN() and JTree:ShaferShenoy() in case of junction tree
301 that consists of one outer region only.
302 - Fixed INIT bug in LCBP2::UpdatePancake().
303 - Fixed MaxDiffs flow (except for MR).
304
305 New functionality
306
307 - HAK supports several default cluster choices:
308 minimal (only factors)
309 delta (Markov blankets)
310 loop (all loops consisting of loops consisting of <loopdepth> or less variables)
311 Only the maximal clusters are used as outer clusters.
312 - Implemented TreeEP. It generalizes the heuristic method described in the
313 Minka & Qi paper for obtaining a tree with the most relevant interactions to
314 higher order interactions. Almost all optimizations described in the Minka & Qi
315 paper are used, except that evidence is passed over the whole tree instead of
316 relevant subsets (the latter is almost implemented but buggy). Also added
317 alternative (worst-case) algorithm that uses a maximum spanning tree on the
318 weighted graph where the weight between neighbours i and j is given by
319 N(psi,i,j), where psi is the product of all the factors involving both i and j
320 (which is an upper bound on the effective interaction between i and j).
321 - Implemented MR (MontanariRizzo) based on Bastian's code, but extended it
322 to be able to handle connectivities larger than 3 (in principle, up to 32).
323 It supports different initialization methods (the original RESPPROP,
324 the CLAMPING method and EXACT which uses JTree) and different update methods
325 (FULL and LINEAR).
326 - Implemented LCBP2, an analogon of LCBP which represents pancakes as little
327 networks and uses some approximate inference method on them for calculating
328 marginals.
329 - Now there are several LCBP variants (LCBP, LCBPI, LCBPJ, LCBPK, LCBPL);
330 LCBPJ works only for pairwise, LCBPK is LCBP improved for higher order
331 interactions and LCBPL is LCBPI improved for higher-order interactions.
332 - Wrote one single program utils/createfg for creating various types of
333 random factor graphs.
334 - Wrote utility to visualize factor graphs using graphviz.
335 (it uses the BOOST Program Options library)
336 - Added fginfo utility that displays some info about a .fg file.
337 - Implemented Factor::strength function that calculates the potential strength
338 N(psi,i,j) between variables i and j as described in cs.IT:0504030
339 - Wrote a general MatLab interface matlab/dai (similar to tests/test);
340 this unified the matlab functions dai, dai_bp, dai_mf, dai_jt, dai_tep, dai_cvm.
341 - Added MATLAB routine that returns contraction matrix A for BP convergence analysis.
342 - Implemented a MATLAB interface ai_potstrength for Factor::strength
343 - Added Martijn's x2x
344
345 Improvements of existing code
346
347 - Reimplemented RegionGraph and descendants: a RegionGraph ISA FactorGraph
348 and also a BipartiteGraph<FRegion,Region>. It now also keeps a map that
349 associates outer region indices to factor indices (no powers yet, this
350 is deemed superfluous) and provides functions to recompute (some of) the
351 outer regions from the factors.
352 - InfAlg descendants run() methods now stop immediately and return NAN in case
353 they detect NANs. Only BP does not do NAN checking for performance reasons.
354 - LCBP now works with factors containing zeroes (by defining x/0 = 0).
355 - HAK, GBP and DoubleLoop now conform to the standards for verbose reporting,
356 timing and convergence criteria.
357 - Implemented logZ() for JTree. It does the calculation during message-passing.
358 - Marginal2ndO now optionally divides by the single node beliefs (to the power n-2);
359 hopefully this will give more accurate approximations.
360 - Marginal and Marginal2ndO (optionally) use the new saveProbs/undoProbs functionality
361 for a faster way of calculating marginals, which does not require a call to init()
362 nor cloning the whole object for each clamping. This leads to a significant speedup.
363 - LCBP (and LCBP2) now have complete flexibility in the specification of the
364 inner method, i.e. the method used to generate the initial cavity approximations.
365 One can pass two strings, a name and a properties string, and LCBP simply invokes
366 newInfAlg to construct the corresponding inference algorithm and uses the generic
367 marginal functions to approximate cavity marginals.
368 - Replaced the global "method" variable by local properties and removed ai.h
369 - Added some methods to Factor (operators *, *=, /, /= with doubles as
370 second argument, operators -, +=, -= with other Factors as second
371 arguments, randomize(), RemoveFirstOrderInteractions) and similar
372 operations to Prob
373 - Moving towards boost::program_options for handling command line arguments
374 (tests/test is done).
375 - Renamed some FactorGraph methods:
376 nr_vars -> nrVars
377 nr_factors -> nrFactors
378 varind -> findVar
379 factorind -> findFactor
380 makeFacCavity -> makeFactorCavity
381 - LCBP_SEQMAXRES has been removed because it did strange things.
382 - Implemented RandomDRegularGraph
383 - Implemented JTree::calcMarginal for marginals that are not confined
384 within one cluster (using cut-set conditioning).
385 - Added isConnected() method to FactorGraph (some methods do not work with
386 disconnected factor graphs).
387 - Pair beliefs are now calculated in a symmetrical way by calcPairBeliefs
388 - Removed single node interaction "correction" code from clamping methods
389 - Removed calcCavityDist and calcCavityDist2ndO
390 - No longer depends on GSL.
391 - Increased portability by combining platform dependant utility functions
392 in util.{h,cpp}.
393 - Wrote *.m files providing help
394
395 Testing framework
396
397 - Made a new and significantly improved testing framework that provides most
398 functionality from the command line.
399 - The basis is provided by tests/test, which uses the newInfAlg functionality
400 and enables the user to easily compare from the command line different
401 inference methods on a given factorgraph. All parameters can be specified.
402 Output consists of CPU time, average and maximum single variable marginal
403 errors, relative logZ error and MaxDiff().
404 - tests/aliases.conf contains aliases for standard combinations of methods
405 and their options (which can be used in tests/test).
406 - tests/large contains several bash/python scripts that create random factor
407 graphs, compare several approximate inference algorithms (using tests/test) and
408 allow for easy visualization of the results using PyX.
409 - Added several .fg files for test purposes to /tests (e.g. two ALARM versions
410 alarm.fg and alarm_bnt.fg; testfast.fg, a 4x4 periodic Ising grid for
411 regression testing).
412 - Added a regression test to the Makefile which is included in the standard
413 target. It compares all inference methods on tests/testfast.fg with the
414 results stored in tests/testfast.out
415
416 Miscellaneous
417
418 - Expanded all tabs to spaces (":set tabstop 4\n:set expandtab\n:retab" in vim)
419 - Experimental MATLAB code added for StarEP approximation on cavity
420 - Renamed project to libDAI and changed directory name accordingly.
421 - Renamed JunctionTree to JTree.
422 - Fixed licensing (now it's officially GPL).
423 - Improved README
424
425
426 revision 252
427 ------------
428
429 Functionality
430 - Added RegionGraph, GBP, CVM and HAK (double-loop).
431 - Added JunctionTree (with two update algorithms, HUGIN and Shafer-Shenoy), which is a
432 RegionGraph.
433 - NormType is now chosen automatically (in case of negative factors, Prob::NORMLINF is used,
434 otherwise the default Prob::NORMPROB is used). Also, in case of negative factors, the
435 RegionGraph constructors assign each Factor to a unique outer region instead of dividing
436 it over all subsuming outer regions. See README for when negative factors are known to work
437 and when not.
438 - FactorGraph::FactorGraph(const vector<Factor>) only gives a warning in case of short loops,
439 it does not automatically merge factors anymore.
440 - Removed BP_SEQMAXRESNOCLEAR (all cavity initialization methods now are implicitly NOCLEAR)
441 - Added MATLAB interface functions ai_readfg, ai_removeshortloops and ai_bp
442 - Added LCBP-III type that should be equivalent to LCBP-II, but can handle zeroes
443 in potentials. Note that it is significantly slower than LCBP-II (and has to be reimplemented
444 such that it does not store the complete pancakes, but represents them as little factor graphs).
445
446 Implementation / code
447 - Made a seperate type WeightedGraph, which until now only implements Prim's
448 maximal spanning tree algorithm and is only used by the junction tree code. It might
449 be good to make it a class somewhere in the future and extend it's interface.
450 - Made a seperate class ClusterGraph, which is only used by the junction tree
451 code. It's main purpose is a graph-theoretical variable elimination algorithm.
452 - Implemented the heuristic "minimum-new-edges-in-clique-graph" for variable elimination.
453 - Massive code cleanup, moving towards "generic" programming style, using
454 multiple inheritance and polymorphism.
455 o BP, LCBP, MF, HAK and JunctionTree now inherit from a common DAIAlg class
456 o Made generic functions Marginal, Marginal2ndO, calcCavityDist, calcCavityDist2ndO, clamp
457 that can be used by FactorGraph-based DAIAlgs.
458 o Created TProb<T> class, which stores a probability vector (without the accompanying indexing
459 and VarSet) and provides functionality for it (which is used by TFactor<T>).
460 o Rewrote the VarSet class. It now caches its statespace(). It now privately inherits from set<Var>.
461 I had to overload the insert methods of set<Var> so that they calculate the new statespace.
462 o Rewrote the TFactor class. The TFactor class now HAS a TProb and HAS a VarSet.
463 - Rewrote BP to use the new TProb<T> interface. Performance of BP improved up to a factor 6 by:
464 o using Prob's instead of Factor's;
465 o splitting the multiplication of the messages into two parts (thanks to Vicenc!);
466 o optimizing the calculation of the beliefs (only the message calculations were optimized till now).
467 o replacing FactorGraph::_nb1 and _nb2 (which were set<size_t>) by vector<size_t>
468 - LCBP now seperately stores cavitydists and pancakes. Added InitPancakes() method
469 that takes the cavitydists and multiplies them with the relevant factors. This
470 resulted in an API change in AI which now accepts and returns initial cavitydists
471 instead of initial pancakes.
472
473 Minor changes
474 - Started writing DoxyGen documentation
475 - Renamed lcptab2fg.m matlab/ai_writefg.m
476 - Moved all matlab stuff to matlab/
477 - More detailed reporting (also reports clocks used).
478 - Marginal and Marginal2ndO now use *differences* in logZ to avoid NaNs.
479 - Improved testing suite.
480 - Removed logreal support.
481 - FactorGraph now also supports input streams and ignores comment lines in .fg files.
482 - Added tests/create_full_fg.cpp and tests/create_ising_fg.cpp which create
483 full and periodic 2D Ising networks according to some command line parameters.
484 - Now logZ really returns logZ instead of -logZ.
485 - Added FactorGraph::WriteToDotFile
486
487
488 0.1.4 (2006-04-13)
489 ------------------
490 - Added file IO routines to read and write factorgraphs.
491 - Added L-infinity normalization for use with (partially) negative factors.
492 - Renamed BetheF, MFF to logZ, which now use complex numbers to be able to
493 handle (partially) negative factors.
494 - Added test suite.
495 - All probabilities are now represented using double instead of LogReal<double>.
496 - Combined Alg and Alg3 into LCBP. Several update schemes possible.
497 - Combined several variants of BP into doBP. Several update schemes possible.
498 Now uses precalculated indices for optimization.
499 - Renamed Node -> Var and Potential -> Factor.
500 - Extensive code cleanup. More use of OO techniques. Changed API.
501 - MaxIter now means maximum number of passes (corresponding to number of
502 _parallel_ updates).
503 - MaxDiff now means the maximum L-infinity distance between the updated and
504 original single variable beliefs, for all AI methods.
505 - Implemented RBP which converges faster than BP for difficult problems.
506 - Now uses method parameter which is a bitmask combining outmethod and inmethod
507 (see ai.h).
508
509
510 0.1.3 (2006-03-22)
511 --------------------
512 - All AI methods now return maxdiff
513 - ai.cpp:
514 o Now returns maxdiffinner and maxdiffouter
515 o New BP2ndO innermethod (estimate only 2nd order cavity interactions)
516 o New InitCav outermethod (only create initial cavity distributions)
517 - bp.cpp:
518 o New CavityDist2ndO which estimates 2nd order cavity interactions
519 - Makefile:
520 o Bugfix: removed dependencies on algwim.*
521
522
523 0.1.2 (2006-02-28)
524 --------------------
525 - Cleaned up alg.cpp (removed Alg2 and its corresponding data structures).
526 - Added the possibility to provide initial cavity distributions as an input
527 argument to ai (not much error checking is done, so be careful).
528 - Potentials2mx now correctly sets the dimensions of the P field (i.e. for
529 the output arguments Q, Q0 of ai).
530 - Removed algwim.* since it does not work.
531
532
533 0.1.1 (2006-02-28)
534 --------------------
535 - The constructors of (Log)FactorGraph and LogFactorGraph from a
536 vector<(Log)Potential> now merge potentials to prevent short loops (of length
537 4) in the factor graph. These are used in ai to construct the factor graphs
538 from the psi argument. If compiled with DEBUG defined, the method calc_nb()
539 of BipGraph checks for the existence of short loops.
540 - Changed calling syntax of ai (now the actual syntax *does* correspond to its
541 description in the help).
542 - ai does not hook cout anymore (which caused weird segfaults).
543 - Fixed a bug in an assert statement in the matlab interface code in ai.cpp.
544 - Removed network.* since it is not useful.
545
546
547 0.1.0 (2006-02-28)
548 --------------------
549 First version worthy a version number.