multiDimFunctionGraphManager.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_MANAGER_H
#  define GUM_MULTI_DIM_FUNCTION_GRAPH_MANAGER_H

#  include <agrum/agrum.h>
#  include <agrum/graphs/parts/nodeGraphPart.h>
#  include <agrum/multidim/implementations/multiDimFunctionGraph.h>
#  include <agrum/multidim/utils/FunctionGraphUtilities/internalNode.h>

namespace gum {

  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraph;

  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraphManager {
    // =========================================================================
    // =========================================================================

    friend MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >*
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::manager();

    protected:
    explicit MultiDimFunctionGraphManager(
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* master);

    public:
    virtual ~MultiDimFunctionGraphManager();

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

    void setRootNode(const NodeId& root);

    NodeId addInternalNode(const DiscreteVariable* var);

    virtual NodeId addInternalNode(const DiscreteVariable* var, NodeId* sons) = 0;

    protected:
    NodeId _addInternalNode(const DiscreteVariable* var, NodeId* sons);

    public:
    NodeId addInternalNode(const DiscreteVariable* var, NodeId nid);

    NodeId addTerminalNode(const GUM_SCALAR& value);

    void eraseNode(NodeId id, NodeId replacingId = 0, bool updateParents = true);

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

    void setSon(const NodeId& node, const Idx& modality, const NodeId& sonNode);


    void minimizeSize();

    void moveTo(const DiscreteVariable* x, Idx desiredPos);

    private:
    void __adjacentSwap(const DiscreteVariable* x, const DiscreteVariable* y);

    protected:
    void _migrateNode(const NodeId& x, const NodeId& y);

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

    protected:
    NodeId _nodeRedundancyCheck(const DiscreteVariable* var, NodeId* sonsMap);

    private:
    NodeId __checkIsomorphism(const DiscreteVariable* var, NodeId* sons);

    bool __isRedundant(const DiscreteVariable* var, NodeId* sons);

    public:
    virtual void reduce() = 0;

    protected:
    void _reduce();


    public:
    void clean();

    private:
    MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* __functionGraph;
  };

  // ===========================================================================
  // MultiDimFunctionGraphTreeManager
  // ===========================================================================

  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraphTreeManager
      : public MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy > {
    friend MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >*
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::manager();

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

    MultiDimFunctionGraphTreeManager(
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* master);

    public:
    ~MultiDimFunctionGraphTreeManager();

    // ========================================================================
    // ========================================================================
    virtual NodeId addInternalNode(const DiscreteVariable* var, NodeId* sons);

    virtual void reduce();
  };

  // ===========================================================================
  // MultiDimFunctionGraphROManager
  // ===========================================================================

  template < typename GUM_SCALAR, template < typename > class TerminalNodePolicy >
  class MultiDimFunctionGraphROManager
      : public MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy > {
    friend MultiDimFunctionGraphManager< GUM_SCALAR, TerminalNodePolicy >*
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::manager();

    // ========================================================================
    // ========================================================================
    MultiDimFunctionGraphROManager(
       MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >* master);

    public:
    ~MultiDimFunctionGraphROManager();

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

    virtual NodeId addInternalNode(const DiscreteVariable* var, NodeId* sons);

    virtual void reduce();

  };

}   // namespace gum

// ============================================================================
#  include <agrum/multidim/implementations/multiDimFunctionGraphManager_tpl.h>
// ============================================================================
#endif   // GUM_MULTI_DIM_FUNCTION_GRAPH_MANAGER_H
// ============================================================================