multiDimFunctionGraph.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_FUNCTION_GRAPH_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_H
 
#include <agrum/base/core/types.h>
#include <agrum/base/multidim/implementations/multiDimFunctionGraphManager.h>
#include <agrum/base/multidim/implementations/multiDimImplementation.h>
#include <agrum/base/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/ExactTerminalNodePolicy.h>
#include <agrum/FMDP/learning/core/templateStrategy.h>
 
namespace gum {
 
  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraphManager;
 
  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraphROManager;
 
  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraphTreeManager;

  template < typename GUM_SCALAR,
             template < typename > class TerminalNodePolicy = ExactTerminalNodePolicy >
  class MultiDimFunctionGraph final:
      public MultiDimImplementation< GUM_SCALAR >,
      public TerminalNodePolicy< GUM_SCALAR > {
    public:
    const static GUM_SCALAR defaultValue;
 
    public:
    // =========================================================================
    // =========================================================================
 
    private:
    MultiDimFunctionGraph(bool isReduced = true);
 
    public:
    MultiDimFunctionGraph(const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >& from);

    MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >&
        operator=(const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >& from);

    ~MultiDimFunctionGraph();

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

    virtual void set(const Instantiation& i, const GUM_SCALAR& value) const;

    virtual void fill(const GUM_SCALAR& d) const;

    virtual void populate(const std::vector< GUM_SCALAR >& v) const;
    virtual void populate(std::initializer_list< GUM_SCALAR > v) const;

    virtual void copyFrom(const MultiDimContainer< GUM_SCALAR >& src,
                          Instantiation*                         p_i = (Instantiation*)0) const;

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

    // =========================================================================
    // =========================================================================
 
    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const;
 
    virtual GUM_SCALAR get(const Instantiation& i) const;
 
    virtual const std::string& name() const;
 
    virtual void add(const DiscreteVariable& v);
 
    virtual void erase(const DiscreteVariable& v);
 
    virtual Size realSize() const;
 
    virtual void changeNotification(const Instantiation&          i,
                                    const DiscreteVariable* const var,
                                    Idx                           oldval,
                                    Idx                           newval);
 
    virtual void setFirstNotification(const Instantiation& i);
 
    virtual void setLastNotification(const Instantiation& i);
 
    virtual void setIncNotification(const Instantiation& i);
 
    virtual void setDecNotification(const Instantiation& i);
 
    virtual void setChangeNotification(const Instantiation& i);
 
    virtual std::string toString(const Instantiation* i) const;

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

    void copy(const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >& src);

    void copyAndReassign(
        const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >&       src,
        const Bijection< const DiscreteVariable*, const DiscreteVariable* >& reassign);

    void copyAndMultiplyByScalar(const MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >& src,
                                 GUM_SCALAR gamma);

    void clear();

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

    std::string toDot(bool withBackArcs = false) const;

    const NodeGraphPart& model() const;

    MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >* manager();

    const NodeId& root() const;

    bool isTerminalNode(const NodeId& node) const;

    bool isInternalNode(const NodeId& node) const;

    const GUM_SCALAR& nodeValue(NodeId n) const;

    const InternalNode* node(NodeId n) const;

    const LinkedList< NodeId >* varNodeListe(const DiscreteVariable* var) const;

    const std::string& tableName() const;

    void setTableName(const std::string& name);

    bool isReducedAndOrdered() const;

    static MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* getReducedAndOrderedInstance();

    static MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* getTreeInstance();

 
    protected:
    virtual void replace_(const DiscreteVariable* x, const DiscreteVariable* y);

    GUM_SCALAR& get_(const Instantiation& inst) const;
 
    private:
    std::string _name_;

    std::string _tableName_;

    NodeGraphPart _model_;

    MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >* _manager_;

    NodeId _root_;

    HashTable< NodeId, InternalNode* > _internalNodeMap_;

    HashTable< const DiscreteVariable*, LinkedList< NodeId >* > _var2NodeIdMap_;

    bool _isReduced_;
 
    friend class MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  // extern template class MultiDimFunctionGraph<float>;
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  // extern template class MultiDimFunctionGraph<double>;
#  endif
#endif
}   // namespace gum
 
#include <agrum/base/multidim/implementations/multiDimFunctionGraph_tpl.h>
 
#endif   // GUM_MULTI_DIM_FUNCTION_GRAPH_H