structuralConstraintDAG_inl.h

Go to the documentation of this file.

#ifndef DOXYGEN_SHOULD_SKIP_THIS

#  include <agrum/agrum.h>
#  include <agrum/graphs/algorithms/DAGCycleDetector.h>
#  include <agrum/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/learning/constraints/structuralConstraintPatternInline.h>
#  undef GUM_CONSTRAINT_CLASS_NAME

  } /* namespace learning */

} /* namespace gum */

#endif /* DOXYGEN_SHOULD_SKIP_THIS */