simplicialSet.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_SIMPLICIAL_SET_H
#define GUM_SIMPLICIAL_SET_H
 
#include <iostream>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/priorityQueue.h>
#include <agrum/base/graphs/cliqueGraph.h>
 
#define GUM_QUASI_RATIO      0.99
#define GUM_WEIGHT_THRESHOLD 0.0
 
namespace gum {
 
  /* ===========================================================================
   */
  /* ===  CLASS FOR RETRIEVING SIMPLICIAL, ALMOST AND QUASI SIMPLICIAL NODES ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  class SimplicialSet {
    public:
    // ############################################################################
    // ############################################################################


    explicit SimplicialSet(UndiGraph*                    graph,
                           const NodeProperty< double >* log_domain_sizes,
                           NodeProperty< double >*       log_weights,
                           double                        theRatio     = GUM_QUASI_RATIO,
                           double                        theThreshold = GUM_WEIGHT_THRESHOLD);


    SimplicialSet(const SimplicialSet&          simplicial_from,
                  UndiGraph*                    graph,
                  const NodeProperty< double >* log_domain_sizes,
                  NodeProperty< double >*       log_weights,
                  bool                          avoid_check = false);

    SimplicialSet(SimplicialSet&& from);

    ~SimplicialSet();

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


    void makeClique(const NodeId id);


    void eraseClique(const NodeId id);


    void eraseNode(const NodeId id);


    void eraseEdge(const Edge& edge);


    void addEdge(NodeId first, NodeId second);


    bool isSimplicial(const NodeId id);


    bool hasSimplicialNode();

    bool hasAlmostSimplicialNode();

    bool hasQuasiSimplicialNode();


    NodeId bestSimplicialNode();


    const PriorityQueue< NodeId, double >& allSimplicialNodes();

    NodeId bestAlmostSimplicialNode();


    const PriorityQueue< NodeId, double >& allAlmostSimplicialNodes();

    NodeId bestQuasiSimplicialNode();


    const PriorityQueue< NodeId, double >& allQuasiSimplicialNodes();


    void setFillIns(bool on_off);

    const EdgeSet& fillIns() const;


    void setGraph(UndiGraph*                    graph,
                  const NodeProperty< double >* log_domain_sizes,
                  NodeProperty< double >*       log_weights,
                  double                        theRatio     = GUM_QUASI_RATIO,
                  double                        theThreshold = GUM_WEIGHT_THRESHOLD);


    void replaceLogWeights(NodeProperty< double >* old_weigths,
                           NodeProperty< double >* new_weights);

 
 
    private:
    UndiGraph* _graph_;

    NodeProperty< double >* _log_weights_;

    const NodeProperty< double >* _log_domain_sizes_;

    PriorityQueue< NodeId, double > _simplicial_nodes_;

    PriorityQueue< NodeId, double > _almost_simplicial_nodes_;

    PriorityQueue< NodeId, double > _quasi_simplicial_nodes_;

    enum class _Belong_ : char { SIMPLICIAL, ALMOST_SIMPLICIAL, QUASI_SIMPLICIAL, NO_LIST };
    NodeProperty< _Belong_ > _containing_list_;

    EdgeProperty< Size > _nb_triangles_;

    NodeProperty< Size > _nb_adjacent_neighbours_;


    double _log_tree_width_;

    double _quasi_ratio_;

    double _log_threshold_;

    NodeSet _changed_status_;

    bool _we_want_fill_ins_{false};

    EdgeSet _fill_ins_list_;
 

    void _updateList_(const NodeId id);

    void _updateAllNodes_();

    void _initialize_();


    SimplicialSet& operator=(const SimplicialSet&);


    SimplicialSet(const SimplicialSet&);
  };
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/algorithms/simplicialSet_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_SIMPLICIAL_SET_H */