Improved documentation of include/dai/bp_dual.h
[libdai.git] / include / dai / alldai.h
1 /* This file is part of libDAI - http://www.libdai.org/
2 *
3 * libDAI is licensed under the terms of the GNU General Public License version
4 * 2, or (at your option) any later version. libDAI is distributed without any
5 * warranty. See the file COPYING for more details.
6 *
7 * Copyright (C) 2006-2009 Joris Mooij [joris dot mooij at libdai dot org]
8 * Copyright (C) 2006-2007 Radboud University Nijmegen, The Netherlands
9 */
10
11
12 /// \file
13 /// \brief Main libDAI header file. It \#includes all other libDAI headers.
14
15
16 #ifndef __defined_libdai_alldai_h
17 #define __defined_libdai_alldai_h
18
19
20 #include <string>
21 #include <dai/daialg.h>
22 #include <dai/properties.h>
23 #include <dai/exactinf.h>
24 #include <dai/evidence.h>
25 #include <dai/emalg.h>
26 #ifdef DAI_WITH_BP
27 #include <dai/bp.h>
28 #endif
29 #ifdef DAI_WITH_MF
30 #include <dai/mf.h>
31 #endif
32 #ifdef DAI_WITH_HAK
33 #include <dai/hak.h>
34 #endif
35 #ifdef DAI_WITH_LC
36 #include <dai/lc.h>
37 #endif
38 #ifdef DAI_WITH_TREEEP
39 #include <dai/treeep.h>
40 #endif
41 #ifdef DAI_WITH_JTREE
42 #include <dai/jtree.h>
43 #endif
44 #ifdef DAI_WITH_MR
45 #include <dai/mr.h>
46 #endif
47 #ifdef DAI_WITH_GIBBS
48 #include <dai/gibbs.h>
49 #endif
50 #ifdef DAI_WITH_CBP
51 #include <dai/cbp.h>
52 #endif
53
54
55 /// Namespace for libDAI
56 namespace dai {
57
58
59 /// Constructs a new inference algorithm.
60 /** \param name The name of the inference algorithm (should be one of the names in DAINames).
61 * \param fg The FactorGraph that the algorithm should be applied to.
62 * \param opts A PropertySet specifying the options for the algorithm.
63 * \return Returns a pointer to the new InfAlg object; it is the responsibility of the caller to delete it later.
64 */
65 InfAlg *newInfAlg( const std::string &name, const FactorGraph &fg, const PropertySet &opts );
66
67
68 /// Constructs a new inference algorithm.
69 /** \param nameOpts The name and options of the inference algorithm (should be in the format "name[key1=val1,key2=val2,...,keyn=valn]").
70 * \param fg The FactorGraph that the algorithm should be applied to.
71 * \return Returns a pointer to the new InfAlg object; it is the responsibility of the caller to delete it later.
72 * \todo Support aliases like in testdai
73 */
74 InfAlg *newInfAlgFromString( const std::string &nameOpts, const FactorGraph &fg );
75
76
77 /// Contains the names of all inference algorithms compiled into libDAI.
78 static const char* DAINames[] = {
79 ExactInf::Name,
80 #ifdef DAI_WITH_BP
81 BP::Name,
82 #endif
83 #ifdef DAI_WITH_MF
84 MF::Name,
85 #endif
86 #ifdef DAI_WITH_HAK
87 HAK::Name,
88 #endif
89 #ifdef DAI_WITH_LC
90 LC::Name,
91 #endif
92 #ifdef DAI_WITH_TREEEP
93 TreeEP::Name,
94 #endif
95 #ifdef DAI_WITH_JTREE
96 JTree::Name,
97 #endif
98 #ifdef DAI_WITH_MR
99 MR::Name,
100 #endif
101 #ifdef DAI_WITH_GIBBS
102 Gibbs::Name,
103 #endif
104 #ifdef DAI_WITH_CBP
105 CBP::Name,
106 #endif
107 ""
108 };
109
110
111 } // end of namespace dai
112
113
114 #endif