cliqueGraph_inl.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                           *
 *                                                                          *
 ****************************************************************************/
#pragma once
 

 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
// to ease parser in IDE
#  include <agrum/base/graphs/cliqueGraph.h>
 
namespace gum {

  INLINE CliqueGraph& CliqueGraph::operator=(const CliqueGraph& g) {
    if (this != &g) {
      UndiGraph::operator=(g);
      _cliques_    = g._cliques_;
      _separators_ = g._separators_;
    }
 
    return *this;
  }
 
  INLINE void CliqueGraph::addEdge(NodeId first, NodeId second) {
    Edge edge(first, second);
 
    if (!existsEdge(edge)) {
      // create the edge in the graph
      UndiGraph::addEdge(first, second);
 
      // create the separator
      _separators_.insert(edge, _cliques_[first] * _cliques_[second]);
    }
  }

 
  INLINE void CliqueGraph::eraseEdge(const Edge& edge) {
    if (existsEdge(edge)) {
      _separators_.erase(edge);
      UndiGraph::eraseEdge(edge);
    }
  }

 
  INLINE NodeId CliqueGraph::addNode(const NodeSet& clique) {
    // create the new node in the graph
    NodeId new_node = UndiGraph::addNode();
 
    // update the set of nodes of the clique
    _cliques_.insert(new_node, clique);
    return new_node;
  }
 
  INLINE NodeId CliqueGraph::addNode() { return addNode(NodeSet()); }

 
  INLINE void CliqueGraph::addNodeWithId(const NodeId id, const NodeSet& clique) {
    // create the new node in the graph
    UndiGraph::addNodeWithId(id);
 
    // update the set of nodes of the clique
    _cliques_.insert(id, clique);
  }
 
  INLINE void CliqueGraph::addNodeWithId(const NodeId id) { addNodeWithId(id, NodeSet()); }

 
  INLINE void CliqueGraph::eraseNode(const NodeId id) {
    // check if the node belongs to the graph
    if (!exists(id)) return;
 
    // remove the separators
    auto nei = neighbours(id);
    for (auto iter = nei.beginSafe(); iter != nei.endSafe(); ++iter)   // safe iterator needed here
      eraseEdge(Edge(*iter, id));
 
    // erase the clique set
    _cliques_.erase(id);
 
    // erase the node and its neighbours from the graph
    UndiGraph::eraseNode(id);
  }

 
  INLINE const NodeSet& CliqueGraph::clique(const NodeId clique) const { return _cliques_[clique]; }

 
  INLINE NodeId CliqueGraph::container(const NodeId id) const {
    for (const auto& elt: _cliques_)
      if (elt.second.contains(id)) return elt.first;
 
    GUM_ERROR(NotFound, "This node belongs to no clique")
  }

 
  INLINE void CliqueGraph::_updateSeparators_(const NodeId id1) {
    for (const auto nei: neighbours(id1))
      _separators_[Edge(nei, id1)] = _cliques_[id1] * _cliques_[nei];
  }

 
  INLINE void CliqueGraph::setClique(const NodeId id, const NodeSet& new_clique) {
    // get the current clique set
    _cliques_[id] = new_clique;
    _updateSeparators_(id);
  }

 
  INLINE const NodeSet& CliqueGraph::separator(const Edge& edge) const {
    return _separators_[edge];
  }

 
  INLINE const NodeSet& CliqueGraph::separator(const NodeId node1, const NodeId node2) const {
    return separator(Edge(node1, node2));
  }

 
  INLINE bool CliqueGraph::isJoinTree() const {
    return (!hasUndirectedCycle() && hasRunningIntersection());
  }

 
  INLINE void CliqueGraph::clear() {
    UndiGraph::clear();
    _cliques_.clear();
    _separators_.clear();
  }

 
  INLINE void CliqueGraph::clearEdges() {
    UndiGraph::clearEdges();
    _separators_.clear();
  }
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */