staticTriangulation.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_STATIC_TRIANGULATION_H
#define GUM_STATIC_TRIANGULATION_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphs/algorithms/triangulations/eliminationStrategies/eliminationSequenceStrategy.h>
#include <agrum/base/graphs/algorithms/triangulations/junctionTreeStrategies/junctionTreeStrategy.h>
#include <agrum/base/graphs/algorithms/triangulations/triangulation.h>
 
namespace gum {
 

  class StaticTriangulation: public Triangulation {
    public:
    // ############################################################################
    // ############################################################################

    virtual StaticTriangulation* newFactory() const = 0;


    virtual StaticTriangulation* copyFactory() const = 0;

    virtual ~StaticTriangulation();

 
 
    // ############################################################################
    // ############################################################################


    virtual void setGraph(const UndiGraph* graph, const NodeProperty< Size >* domsizes);

    const EdgeSet& fillIns();

    const std::vector< NodeId >& eliminationOrder();

    Idx eliminationOrder(const NodeId);

    const NodeProperty< NodeId >& reverseEliminationOrder();

    const UndiGraph& triangulatedGraph();

    const CliqueGraph& eliminationTree();

    const CliqueGraph& junctionTree();

    NodeId createdJunctionTreeClique(const NodeId id);

    const NodeProperty< NodeId >& createdJunctionTreeCliques();


    const CliqueGraph& maxPrimeSubgraphTree();

    NodeId createdMaxPrimeSubgraph(const NodeId id);

    void clear();

    void setMinimalRequirement(bool);

    virtual bool isMinimalityRequired() const final;

    void setFillIns(bool);


    const UndiGraph* originalGraph() const;

    EliminationSequenceStrategy& eliminationSequenceStrategy() const;

    JunctionTreeStrategy& junctionTreeStrategy() const;

 
 
    protected:
    // ############################################################################
    // ############################################################################


    StaticTriangulation(const EliminationSequenceStrategy& elimSeq,
                        const JunctionTreeStrategy&        JTStrategy,
                        bool                               minimality = false);


    StaticTriangulation(const UndiGraph*                   graph,
                        const NodeProperty< Size >*        dom_sizes,
                        const EliminationSequenceStrategy& elimSeq,
                        const JunctionTreeStrategy&        JTStrategy,
                        bool                               minimality = false);

    StaticTriangulation(const StaticTriangulation&);

    StaticTriangulation(StaticTriangulation&&);

 
 
    // ############################################################################
    // ############################################################################


    virtual void initTriangulation_(UndiGraph& graph);

 

    EliminationSequenceStrategy* elimination_sequence_strategy_{nullptr};

    JunctionTreeStrategy* junction_tree_strategy_{nullptr};
 
 
    private:
    const UndiGraph* _original_graph_{nullptr};

    UndiGraph _triangulated_graph_;

    EdgeSet _fill_ins_;

    std::vector< NodeId > _elim_order_;

    NodeProperty< NodeId > _reverse_elim_order_;

    NodeProperty< NodeSet > _elim_cliques_;

    CliqueGraph _elim_tree_;


    const CliqueGraph* _junction_tree_{nullptr};

    CliqueGraph _max_prime_junction_tree_;

    NodeProperty< NodeId > _node_2_max_prime_clique_;

    bool _has_triangulation_{false};

    bool _has_triangulated_graph_{false};

    bool _has_elimination_tree_{false};

    bool _has_junction_tree_{false};

    bool _has_max_prime_junction_tree_{false};

    bool _has_fill_ins_{false};

    bool _minimality_required_{false};

    std::vector< EdgeSet > _added_fill_ins_;

    bool _we_want_fill_ins_{false};
 
    // ===========================================================================

    void _triangulate_();

    void _computeEliminationTree_();

    void _computeMaxPrimeJunctionTree_();

    void _computeRecursiveThinning_();

    void _computeMaxPrimeMergings_(const NodeId        node,
                                   const NodeId        from,
                                   std::vector< Arc >& merged_cliques,
                                   NodeSet&            mark) const;

    StaticTriangulation& operator=(const StaticTriangulation&);
  };
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/algorithms/triangulations/staticTriangulation_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   /* GUM_STATIC_TRIANGULATION_H */