include/dai/alldai.h

   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 /// \file
  24 /// \brief Main libDAI header file
  25 /// \todo Improve documentation
  26
  27
  28 #ifndef __defined_libdai_alldai_h
  29 #define __defined_libdai_alldai_h
  30
  31
  32 #include <string>
  33 #include <dai/daialg.h>
  34 #include <dai/properties.h>
  35 #include <dai/exactinf.h>
  36 #ifdef DAI_WITH_BP
  37     #include <dai/bp.h>
  38 #endif
  39 #ifdef DAI_WITH_MF
  40     #include <dai/mf.h>
  41 #endif
  42 #ifdef DAI_WITH_HAK
  43     #include <dai/hak.h>
  44 #endif
  45 #ifdef DAI_WITH_LC
  46     #include <dai/lc.h>
  47 #endif
  48 #ifdef DAI_WITH_TREEEP
  49     #include <dai/treeep.h>
  50 #endif
  51 #ifdef DAI_WITH_JTREE
  52     #include <dai/jtree.h>
  53 #endif
  54 #ifdef DAI_WITH_MR
  55     #include <dai/mr.h>
  56 #endif
  57 #ifdef DAI_WITH_GIBBS
  58     #include <dai/gibbs.h>
  59 #endif
  60
  61
  62 /// Namespace for libDAI
  63 namespace dai {
  64
  65
  66 /// Constructs a new approximate inference algorithm.
  67 /** \param name The name of the approximate inference algorithm (should be one of the names in DAINames).
  68  *  \param fg The FactorGraph that the algorithm should be applied to.
  69  *  \param opts A PropertySet specifying the options for the algorithm.
  70  *  \return Returns a pointer to the new InfAlg object; it is the responsibility of the caller to delete it later.
  71  */
  72 InfAlg *newInfAlg( const std::string &name, const FactorGraph &fg, const PropertySet &opts );
  73
  74
  75 /// Contains the names of all approximate inference algorithms compiled into libDAI.
  76 static const char* DAINames[] = {
  77     ExactInf::Name,
  78 #ifdef DAI_WITH_BP
  79     BP::Name,
  80 #endif
  81 #ifdef DAI_WITH_MF
  82     MF::Name,
  83 #endif
  84 #ifdef DAI_WITH_HAK
  85     HAK::Name,
  86 #endif
  87 #ifdef DAI_WITH_LC
  88     LC::Name,
  89 #endif
  90 #ifdef DAI_WITH_TREEEP
  91     TreeEP::Name,
  92 #endif
  93 #ifdef DAI_WITH_JTREE
  94     JTree::Name,
  95 #endif
  96 #ifdef DAI_WITH_MR
  97     MR::Name,
  98 #endif
  99 #ifdef DAI_WITH_GIBBS
 100     Gibbs::Name,
 101 #endif
 102     ""
 103 };
 104
 105
 106 } // end of namespace dai
 107
 108
 109 #endif