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  *  \throw UNKNOWN_DAI_ALGORITHM if the requested name is not known/compiled in.
  65  */
  66 InfAlg *newInfAlg( const std::string &name, const FactorGraph &fg, const PropertySet &opts );
  67
  68
  69 /// Constructs a new inference algorithm.
  70 /** \param nameOpts The name and options of the inference algorithm (should be in the format "name[key1=val1,key2=val2,...,keyn=valn]").
  71  *  \param fg The FactorGraph that the algorithm should be applied to.
  72  *  \return Returns a pointer to the new InfAlg object; it is the responsibility of the caller to delete it later.
  73  *  \throw UNKNOWN_DAI_ALGORITHM if the requested name is not known/compiled in.
  74  *  \todo Support aliases like in testdai.cpp
  75  */
  76 InfAlg *newInfAlgFromString( const std::string &nameOpts, const FactorGraph &fg );
  77
  78
  79 /// Contains the names of all inference algorithms compiled into libDAI.
  80 static const char* DAINames[] = {
  81     ExactInf::Name,
  82 #ifdef DAI_WITH_BP
  83     BP::Name,
  84 #endif
  85 #ifdef DAI_WITH_MF
  86     MF::Name,
  87 #endif
  88 #ifdef DAI_WITH_HAK
  89     HAK::Name,
  90 #endif
  91 #ifdef DAI_WITH_LC
  92     LC::Name,
  93 #endif
  94 #ifdef DAI_WITH_TREEEP
  95     TreeEP::Name,
  96 #endif
  97 #ifdef DAI_WITH_JTREE
  98     JTree::Name,
  99 #endif
 100 #ifdef DAI_WITH_MR
 101     MR::Name,
 102 #endif
 103 #ifdef DAI_WITH_GIBBS
 104     Gibbs::Name,
 105 #endif
 106 #ifdef DAI_WITH_CBP
 107     CBP::Name,
 108 #endif
 109     ""
 110 };
 111
 112
 113 } // end of namespace dai
 114
 115
 116 #endif