multiDimFunctionGraphManager.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_MANAGER_H
#  define GUM_MULTI_DIM_FUNCTION_GRAPH_MANAGER_H
 
#  include <agrum/agrum.h>
 
#  include <agrum/base/graphs/parts/nodeGraphPart.h>
#  include <agrum/base/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 final:
      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 final:
      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/base/multidim/implementations/multiDimFunctionGraphManager_tpl.h>
// ============================================================================
#endif   // GUM_MULTI_DIM_FUNCTION_GRAPH_MANAGER_H
// ============================================================================