PRMInference.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_PRM_INFERENCE_H
#define GUM_PRM_INFERENCE_H

#include <string>

#include <agrum/core/hashTable.h>
#include <agrum/multidim/potential.h>

#include <agrum/PRM/PRM.h>

namespace gum {
  namespace prm {
    template < typename GUM_SCALAR >
    class PRMInference {
      public:
      typedef std::pair< const PRMInstance< GUM_SCALAR >*,
                         const PRMAttribute< GUM_SCALAR >* >
         Chain;

      typedef NodeProperty< const Potential< GUM_SCALAR >* > EMap;

      typedef
         typename NodeProperty< const Potential< GUM_SCALAR >* >::iterator_safe
            EMapIterator;

      typedef typename NodeProperty<
         const Potential< GUM_SCALAR >* >::const_iterator_safe EMapConstIterator;

      // ========================================================================
      // ========================================================================

      PRMInference(const PRM< GUM_SCALAR >&       prm,
                   const PRMSystem< GUM_SCALAR >& system);

      PRMInference(const PRMInference& source);

      virtual ~PRMInference();

      PRMInference& operator=(const PRMInference& source);

      // ========================================================================
      // ========================================================================

      virtual std::string name() const = 0;

      // ========================================================================
      // ========================================================================
      // ========================================================================

      void marginal(const Chain& chain, Potential< GUM_SCALAR >& m);

      void joint(const std::vector< Chain >& chains, Potential< GUM_SCALAR >& j);

      // ========================================================================
      // ========================================================================

      EMap& evidence(const PRMInstance< GUM_SCALAR >& i);

      EMap& evidence(const PRMInstance< GUM_SCALAR >* i);

      const EMap& evidence(const PRMInstance< GUM_SCALAR >& i) const;

      const EMap& evidence(const PRMInstance< GUM_SCALAR >* i) const;

      bool hasEvidence(const PRMInstance< GUM_SCALAR >& i) const;

      bool hasEvidence(const PRMInstance< GUM_SCALAR >* i) const;

      bool hasEvidence(const Chain& chain) const;

      bool hasEvidence() const;

      void addEvidence(const Chain& chain, const Potential< GUM_SCALAR >& p);

      void removeEvidence(const Chain& chain);

      void clearEvidence();

      protected:
      // ========================================================================
      // ========================================================================

      virtual void _evidenceAdded(const Chain& chain) = 0;

      virtual void _evidenceRemoved(const Chain& chain) = 0;

      virtual void _marginal(const Chain& chain, Potential< GUM_SCALAR >& m) = 0;

      virtual void _joint(const std::vector< Chain >& queries,
                          Potential< GUM_SCALAR >&    j) = 0;

      PRM< GUM_SCALAR > const* _prm;

      PRMSystem< GUM_SCALAR > const* _sys;


      private:
      // ========================================================================
      // ========================================================================

      typedef typename HashTable< const PRMInstance< GUM_SCALAR >*,
                                  EMap* >::iterator_safe EvidenceIterator;
      typedef
         typename HashTable< const PRMInstance< GUM_SCALAR >*,
                             EMap* >::const_iterator_safe EvidenceConstIterator;

      HashTable< const PRMInstance< GUM_SCALAR >*, EMap* > __evidences;

      EMap& __EMap(const PRMInstance< GUM_SCALAR >* i);

    };


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMInference< double >;
#endif


  } /* namespace prm */
} /* namespace gum */

#include <agrum/PRM/inference/PRMInference_tpl.h>

#endif /* GUM_PRM_INFERENCE_H */