multiDimICIModel.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_MULTI_DIM_ICI_MODEL_H
#define GUM_MULTI_DIM_ICI_MODEL_H

#include <agrum/core/bijection.h>
#include <agrum/multidim/implementations/multiDimReadOnly.h>

namespace gum {

  // ===========================================================================
  // ===                       GUM_MULTI_DIM_AGGREGATOR                      ===
  // ===========================================================================
  // clang-format off
  // clang-format on
  template < typename GUM_SCALAR >
  class MultiDimICIModel : public MultiDimReadOnly< GUM_SCALAR > {
    public:
    // ============================================================================
    // ============================================================================

    MultiDimICIModel(GUM_SCALAR external_weight,
                     GUM_SCALAR default_weight = (GUM_SCALAR)1.0);

    MultiDimICIModel(const MultiDimICIModel< GUM_SCALAR >& from);

    MultiDimICIModel(
       const Bijection< const DiscreteVariable*, const DiscreteVariable* >& bij,
       const MultiDimICIModel< GUM_SCALAR >&                                from);

    virtual ~MultiDimICIModel();

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

    public:
    const std::string toString() const override;

    // @todo : optimisation with a always up-to-date value associated to each
    // instantiation
    virtual void changeNotification(const gum::Instantiation&,
                                    const gum::DiscreteVariable* const,
                                    gum::Idx,
                                    gum::Idx) override{};

    virtual void setFirstNotification(const gum::Instantiation&) override{};

    virtual void setLastNotification(const gum::Instantiation&) override{};

    virtual void setIncNotification(const gum::Instantiation&) override{};

    virtual void setDecNotification(const gum::Instantiation&) override{};

    virtual void setChangeNotification(const gum::Instantiation&) override{};

    const std::string toString(const gum::Instantiation* i) const override {
      return i->toString();
    };

    virtual void
       copyFrom(const MultiDimContainer< GUM_SCALAR >& src) const override;

    virtual Size realSize() const override { return this->nbrDim(); };

    GUM_SCALAR causalWeight(const DiscreteVariable& v) const;

    void causalWeight(const DiscreteVariable& v, GUM_SCALAR w) const;

    GUM_SCALAR externalWeight() const;

    void externalWeight(GUM_SCALAR w) const;

    virtual const std::string& name() const override;

    protected:
    mutable GUM_SCALAR __external_weight;

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

    mutable GUM_SCALAR __default_weight;

    mutable HashTable< const DiscreteVariable*, GUM_SCALAR > __causal_weights;

    virtual void _replace(const DiscreteVariable* x,
                          const DiscreteVariable* y) override;
  };


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

} /* namespace gum */

#include <agrum/multidim/ICIModels/multiDimICIModel_tpl.h>

#endif /* GUM_MULTI_DIM_ICI_MODEL_H */