structuralConstraintUndiGraph.h

Go to the documentation of this file.

#ifndef GUM_LEARNING_STRUCTURAL_CONSTRAINT_UNDIGRAPH_H
#define GUM_LEARNING_STRUCTURAL_CONSTRAINT_UNDIGRAPH_H

#include <agrum/agrum.h>
#include <agrum/tools/graphs/undiGraph.h>
#include <agrum/BN/learning/constraints/structuralConstraint.h>
#include <agrum/BN/learning/structureUtils/graphChange.h>

namespace gum {

  namespace learning {

    class StructuralConstraintUndiGraph: public virtual StructuralConstraintEmpty {
      public:
      // ##########################################################################
      // ##########################################################################

      StructuralConstraintUndiGraph();

      StructuralConstraintUndiGraph(Size nb_nodes);

      StructuralConstraintUndiGraph(const UndiGraph& graph);

      StructuralConstraintUndiGraph(const StructuralConstraintUndiGraph& from);

      StructuralConstraintUndiGraph(StructuralConstraintUndiGraph&& from);

      virtual ~StructuralConstraintUndiGraph();


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

      StructuralConstraintUndiGraph&
         operator=(const StructuralConstraintUndiGraph& from);

      StructuralConstraintUndiGraph&
         operator=(StructuralConstraintUndiGraph&& from);


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

      void setGraph(Size nb_nodes);

      void setGraphAlone(const UndiGraph& graph);


      void modifyGraphAlone(const EdgeAddition& change);


      void modifyGraphAlone(const EdgeDeletion& change);


      void modifyGraphAlone(const GraphChange& change);


      bool isAlwaysInvalidAlone(const GraphChange& change) const;


      bool checkEdgeAdditionAlone(NodeId x, NodeId y) const;


      bool checkEdgeDeletionAlone(NodeId x, NodeId y) const;


      bool checkModificationAlone(const GraphChange& change) const;


      bool checkModificationAlone(const EdgeAddition& change) const;


      bool checkModificationAlone(const EdgeDeletion& change) const;


#ifndef DOXYGEN_SHOULD_SKIP_THIS
// include the set of methods that enable the structural constraint to
// be standalone, i.e., that it needs not be included into a
// StructuralConstraintSetStatic to be used by learning algorithms
#  define GUM_CONSTRAINT_CLASS_NAME StructuralConstraintUndiGraph
#  include <agrum/BN/learning/constraints/structuralConstraintPattern4UndiGraphHeader.h>
#  undef GUM_CONSTRAINT_CLASS_NAME
#endif   // DOXYGEN_SHOULD_SKIP_THIS

      protected:
      UndiGraph _UndiGraph__graph;
    };

  } /* namespace learning */

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/BN/learning/constraints/structuralConstraintUndiGraph_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_LEARNING_STRUCTURAL_CONSTRAINT_UNDIGRAPH_H */