include/dai/bp.h

   1 /*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
   2     Radboud University Nijmegen, The Netherlands
   3
   4     This file is part of libDAI.
   5
   6     libDAI is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libDAI is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libDAI; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19 */
  20
  21
  22 #ifndef __defined_libdai_bp_h
  23 #define __defined_libdai_bp_h
  24
  25
  26 #include <string>
  27 #include <dai/daialg.h>
  28 #include <dai/factorgraph.h>
  29 #include <dai/properties.h>
  30 #include <dai/enum.h>
  31
  32
  33 namespace dai {
  34
  35
  36 class BP : public DAIAlgFG {
  37     protected:
  38         typedef std::vector<size_t> ind_t;
  39         struct EdgeProp {
  40             ind_t  index;
  41             Prob   message;
  42             Prob   newMessage;
  43             double residual;
  44         };
  45         std::vector<std::vector<EdgeProp> > edges;
  46
  47     public:
  48         struct Properties {
  49             size_t verbose;
  50             size_t maxiter;
  51             double tol;
  52             bool logdomain;
  53             DAI_ENUM(UpdateType,SEQFIX,SEQRND,SEQMAX,PARALL)
  54             UpdateType updates;
  55         } props;
  56         double maxdiff;
  57
  58     public:
  59         /// Default constructor
  60         BP() : DAIAlgFG(), edges(), props(), maxdiff(0.0) {};
  61         /// Copy constructor
  62         BP( const BP & x ) : DAIAlgFG(x), edges(x.edges), props(x.props), maxdiff(x.maxdiff) {};
  63         /// Clone *this
  64         BP* clone() const { return new BP(*this); }
  65         /// Construct from FactorGraph fg and PropertySet opts
  66         BP( const FactorGraph & fg, const PropertySet &opts ) : DAIAlgFG(fg), edges(), props(), maxdiff(0.0) {
  67             setProperties( opts );
  68             create();
  69         }
  70         /// Assignment operator
  71         BP& operator=( const BP & x ) {
  72             if( this != &x ) {
  73                 DAIAlgFG::operator=( x );
  74                 edges = x.edges;
  75                 props = x.props;
  76                 maxdiff = x.maxdiff;
  77             }
  78             return *this;
  79         }
  80
  81         static const char *Name;
  82
  83         Prob & message(size_t i, size_t _I) { return edges[i][_I].message; }
  84         const Prob & message(size_t i, size_t _I) const { return edges[i][_I].message; }
  85         Prob & newMessage(size_t i, size_t _I) { return edges[i][_I].newMessage; }
  86         const Prob & newMessage(size_t i, size_t _I) const { return edges[i][_I].newMessage; }
  87         ind_t & index(size_t i, size_t _I) { return edges[i][_I].index; }
  88         const ind_t & index(size_t i, size_t _I) const { return edges[i][_I].index; }
  89         double & residual(size_t i, size_t _I) { return edges[i][_I].residual; }
  90         const double & residual(size_t i, size_t _I) const { return edges[i][_I].residual; }
  91
  92         std::string identify() const;
  93         void create();
  94         void init();
  95         double run();
  96
  97         void findMaxResidual( size_t &i, size_t &_I );
  98         void calcNewMessage( size_t i, size_t _I );
  99         Factor beliefV (size_t i) const;
 100         Factor beliefF (size_t I) const;
 101         Factor belief (const Var &n) const;
 102         Factor belief (const VarSet &n) const;
 103         std::vector<Factor> beliefs() const;
 104         Real logZ() const;
 105
 106         void init( const VarSet &ns );
 107         void undoProbs( const VarSet &ns ) { FactorGraph::undoProbs(ns); init(ns); }
 108
 109         /// Set Props according to the PropertySet opts, where the values can be stored as std::strings or as the type of the corresponding Props member
 110         void setProperties( const PropertySet &opts );
 111         PropertySet getProperties() const;
 112         std::string printProperties() const;
 113         double maxDiff() const { return maxdiff; }
 114 };
 115
 116
 117 } // end of namespace dai
 118
 119
 120 #endif