multiDimFunctionGraph.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_MULTI_DIM_FUNCTION_GRAPH_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_H

#include <agrum/core/bijection.h>
#include <agrum/core/list.h>
#include <agrum/core/smallobjectallocator/smallObjectAllocator.h>
#include <agrum/core/types.h>

#include <agrum/FMDP/learning/core/templateStrategy.h>

#include <agrum/graphs/graphElements.h>

#include <agrum/multidim/implementations/multiDimFunctionGraphManager.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/internalNode.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/link.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/ExactTerminalNodePolicy.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/terminalNodePolicies/ITerminalNodePolicy.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
      : 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 const 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/multidim/implementations/multiDimFunctionGraph_tpl.h>

#endif   // GUM_MULTI_DIM_FUNCTION_GRAPH_H