structuralConstraintDAG_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
 
#  include <agrum/agrum.h>
 
#  include <agrum/base/graphs/algorithms/DAGCycleDetector.h>
#  include <agrum/BN/learning/constraints/structuralConstraintDiGraph.h>
 
namespace gum {
 
  namespace learning {

    INLINE void StructuralConstraintDAG::setGraphAlone(const DiGraph& graph) {
      // check that the digraph has no cycle
      DAG g;
 
      for (auto node: graph)
        g.addNodeWithId(node);
 
      for (auto& arc: graph.arcs())
        g.addArc(arc.tail(), arc.head());
 
      _DAG_cycle_detector_.setDAG(g);
    }

    INLINE void StructuralConstraintDAG::setGraphAlone(Size nb_nodes) {
      DAG g;
 
      for (NodeId i = 0; i < nb_nodes; ++i) {
        g.addNodeWithId(i);
      }
 
      _DAG_cycle_detector_.setDAG(g);
    }

    INLINE bool StructuralConstraintDAG::checkArcAdditionAlone(NodeId x, NodeId y) const {
      return !_DAG_cycle_detector_.hasCycleFromAddition(x, y);
    }

    INLINE bool StructuralConstraintDAG::checkArcDeletionAlone(NodeId x, NodeId y) const {
      return !_DAG_cycle_detector_.hasCycleFromDeletion(x, y);
    }

    INLINE bool StructuralConstraintDAG::checkArcReversalAlone(NodeId x, NodeId y) const {
      return !_DAG_cycle_detector_.hasCycleFromReversal(x, y);
    }

    INLINE bool StructuralConstraintDAG::checkModificationAlone(const ArcAddition& change) const {
      return checkArcAdditionAlone(change.node1(), change.node2());
    }

    INLINE bool StructuralConstraintDAG::checkModificationAlone(const ArcDeletion& change) const {
      return checkArcDeletionAlone(change.node1(), change.node2());
    }

    INLINE bool StructuralConstraintDAG::checkModificationAlone(const ArcReversal& change) const {
      return checkArcReversalAlone(change.node1(), change.node2());
    }

    INLINE bool StructuralConstraintDAG::checkModificationAlone(const GraphChange& change) const {
      switch (change.type()) {
        case GraphChangeType::ARC_ADDITION :
          return checkArcAdditionAlone(change.node1(), change.node2());
 
        case GraphChangeType::ARC_DELETION :
          return checkArcDeletionAlone(change.node1(), change.node2());
 
        case GraphChangeType::ARC_REVERSAL :
          return checkArcReversalAlone(change.node1(), change.node2());
 
        default :
          GUM_ERROR(OperationNotAllowed,
                    "edge modifications are not "
                    "supported by StructuralConstraintDAG");
      }
    }

    INLINE void StructuralConstraintDAG::modifyGraphAlone(const ArcAddition& change) {
      _DAG_cycle_detector_.addArc(change.node1(), change.node2());
    }

    INLINE void StructuralConstraintDAG::modifyGraphAlone(const ArcDeletion& change) {
      _DAG_cycle_detector_.eraseArc(change.node1(), change.node2());
    }

    INLINE void StructuralConstraintDAG::modifyGraphAlone(const ArcReversal& change) {
      _DAG_cycle_detector_.reverseArc(change.node1(), change.node2());
    }

    INLINE void StructuralConstraintDAG::modifyGraphAlone(const GraphChange& change) {
      switch (change.type()) {
        case GraphChangeType::ARC_ADDITION :
          modifyGraphAlone(reinterpret_cast< const ArcAddition& >(change));
          break;
 
        case GraphChangeType::ARC_DELETION :
          modifyGraphAlone(reinterpret_cast< const ArcDeletion& >(change));
          break;
 
        case GraphChangeType::ARC_REVERSAL :
          modifyGraphAlone(reinterpret_cast< const ArcReversal& >(change));
          break;
 
        default :
          GUM_ERROR(OperationNotAllowed, "edge modifications are not supported by DAG constraints")
      }
    }

    INLINE bool StructuralConstraintDAG::isAlwaysInvalidAlone(const GraphChange&) const {
      return false;
    }

    INLINE void StructuralConstraintDAG::setGraph(const DAG& graph) {
      constraints::setGraph(graph);
      _DAG_cycle_detector_.setDAG(graph);
    }

    INLINE void StructuralConstraintDAG::setGraph(Size nb_nodes) {
      StructuralConstraintDiGraph::setGraph(nb_nodes);
      setGraphAlone(nb_nodes);
    }
 
// include all the methods applicable to the whole class hierarchy
#  define GUM_CONSTRAINT_CLASS_NAME StructuralConstraintDAG
#  include <agrum/BN/learning/constraints/structuralConstraintPatternInline.h>
#  undef GUM_CONSTRAINT_CLASS_NAME
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */