potential.h

Go to the documentation of this file.

/************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {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_POTENTIAL_H
#define GUM_POTENTIAL_H

#include <vector>

#include <agrum/agrum.h>
#include <agrum/core/set.h>
#include <agrum/multidim/implementations/multiDimDecorator.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>

namespace gum {

  // ==========================================================================
  // ===                          POTENTIAL                                 ===
  // ==========================================================================

  template < typename GUM_SCALAR >
  class Potential : public MultiDimDecorator< GUM_SCALAR > {
    public:
    // =========================================================================
    // =========================================================================

    Potential();

    Potential(MultiDimImplementation< GUM_SCALAR >* aContent);

    Potential(MultiDimImplementation< GUM_SCALAR >*  aContent,
              const MultiDimContainer< GUM_SCALAR >& src);
    Potential(const Potential< GUM_SCALAR >& src);
    Potential< GUM_SCALAR >& operator=(const Potential< GUM_SCALAR >& src);

    Potential(Potential< GUM_SCALAR >&& from);
    Potential< GUM_SCALAR >& operator=(Potential< GUM_SCALAR >&& src);


    ~Potential();

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

    virtual Potential< GUM_SCALAR >* newFactory() const;

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

    Potential< GUM_SCALAR >
       margSumOut(const Set< const DiscreteVariable* >& del_vars) const;

    Potential< GUM_SCALAR >
       margSumIn(const Set< const DiscreteVariable* >& kept_vars) const;

    Potential< GUM_SCALAR >
       margProdOut(const Set< const DiscreteVariable* >& del_vars) const;

    Potential< GUM_SCALAR >
       margProdIn(const Set< const DiscreteVariable* >& kept_vars) const;

    Potential< GUM_SCALAR >
       margMinOut(const Set< const DiscreteVariable* >& del_vars) const;

    Potential< GUM_SCALAR >
       margMinIn(const Set< const DiscreteVariable* >& kept_vars) const;

    Potential< GUM_SCALAR >
       margMaxOut(const Set< const DiscreteVariable* >& del_vars) const;

    Potential< GUM_SCALAR >
       margMaxIn(const Set< const DiscreteVariable* >& kept_vars) const;

    Potential< GUM_SCALAR > isNonZeroMap() const;

    GUM_SCALAR sum() const;
    GUM_SCALAR product() const;
    GUM_SCALAR max() const;
    GUM_SCALAR min() const;
    GUM_SCALAR maxNonOne() const;
    GUM_SCALAR minNonZero() const;

    Set< Instantiation > findAll(GUM_SCALAR v) const;
    Set< Instantiation > argmax() const;
    Set< Instantiation > argmin() const;

    GUM_SCALAR entropy() const;

    Potential< GUM_SCALAR >
       reorganize(const std::vector< const DiscreteVariable* >& vars) const;

    Potential< GUM_SCALAR > extract(const Instantiation& inst) const;

    Potential< GUM_SCALAR > putFirst(const DiscreteVariable* var) const;

    const Potential< GUM_SCALAR >&
       fillWith(const Potential< GUM_SCALAR >& src) const;

    const Potential< GUM_SCALAR >&
       fillWith(const Potential< GUM_SCALAR >&    src,
                const std::vector< std::string >& mapSrc) const;

    const Potential< GUM_SCALAR >&
       fillWith(const std::vector< GUM_SCALAR >& v) const;

    const Potential< GUM_SCALAR >& fillWith(const GUM_SCALAR& v) const;


    const Potential< GUM_SCALAR >& abs() const;

    const Potential< GUM_SCALAR >& normalize() const;

    const Potential< GUM_SCALAR >& sq() const;

    GUM_SCALAR KL(const Potential< GUM_SCALAR >& p) const;

    void normalizeAsCPT() const;

    const Potential< GUM_SCALAR >& scale(GUM_SCALAR v) const;

    const Potential< GUM_SCALAR >& translate(GUM_SCALAR v) const;

    Idx draw() const;


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


    Potential< GUM_SCALAR > operator+(const Potential< GUM_SCALAR >& p2) const {
      if (p2.empty())
        return Potential< GUM_SCALAR >(*this).translate(p2._empty_value);
      if (this->empty())
        return Potential< GUM_SCALAR >(p2).translate(this->_empty_value);

      return Potential< GUM_SCALAR >(*this->content() + *p2.content());
    }

    Potential< GUM_SCALAR > operator-(const Potential< GUM_SCALAR >& p2) const {
      if (p2.empty())
        return Potential< GUM_SCALAR >(*this).translate(-p2._empty_value);
      if (this->empty()) {
        auto p = Potential< GUM_SCALAR >(p2);
        p.apply([this](GUM_SCALAR x) { return this->_empty_value - x; });
        return p;
      }
      return Potential< GUM_SCALAR >(*this->content() - *p2.content());
    }

    Potential< GUM_SCALAR > operator*(const Potential< GUM_SCALAR >& p2) const {
      if (p2.empty()) return Potential< GUM_SCALAR >(*this).scale(p2._empty_value);
      if (this->empty())
        return Potential< GUM_SCALAR >(p2).scale(this->_empty_value);

      return Potential< GUM_SCALAR >(*this->content() * *p2.content());
    }

    Potential< GUM_SCALAR > operator/(const Potential< GUM_SCALAR >& p2) const {
      if (p2.empty())
        return Potential< GUM_SCALAR >(*this).scale(1 / p2._empty_value);
      if (this->empty()) {
        auto p = Potential< GUM_SCALAR >(p2);
        p.apply([this](GUM_SCALAR x) { return this->_empty_value / x; });
        return p;
      }
      return Potential< GUM_SCALAR >(*this->content() / *p2.content());
    }

    Potential< GUM_SCALAR >& operator+=(const Potential< GUM_SCALAR >& r) {
      *this = *this + r;
      return *this;
    }

    Potential< GUM_SCALAR >& operator*=(const Potential< GUM_SCALAR >& r) {
      *this = *this * r;
      return *this;
    }

    Potential< GUM_SCALAR >& operator-=(const Potential< GUM_SCALAR >& r) {
      *this = *this - r;
      return *this;
    }

    Potential< GUM_SCALAR >& operator/=(const Potential< GUM_SCALAR >& r) {
      *this = *this / r;
      return *this;
    }

    bool operator==(const Potential< GUM_SCALAR >& r) const {
      if (this->empty()) {
        if (r.empty())
          return this->_empty_value == r._empty_value;
        else
          return false;
      } else {
        if (r.empty())
          return false;
        else
          return (*this->_content) == (*r._content);
      }
    }

    bool operator!=(const Potential< GUM_SCALAR >& r) const {
      return !operator==(r);
    }

    virtual const std::string toString() const {
      return MultiDimDecorator< GUM_SCALAR >::toString();
    }


    protected:
    Set< const DiscreteVariable* >
       _complementVars(const Set< const DiscreteVariable* >& del_vars) const;
  };


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


} /* namespace gum */

#include <agrum/multidim/potential_tpl.h>
#endif /* GUM_POTENTIAL_H */