multiDimICIModel.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_MULTI_DIM_ICI_MODEL_H
#define GUM_MULTI_DIM_ICI_MODEL_H
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/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:
    std::string toString() const override;
 
    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 {};
 
    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/base/multidim/ICIModels/multiDimICIModel_tpl.h>
 
#endif /* GUM_MULTI_DIM_ICI_MODEL_H */