structuralConstraintSliceOrder.h

Go to the documentation of this file.

#ifndef GUM_LEARNING_STRUCTURAL_CONSTRAINT_SLICE_ORDER_H
#define GUM_LEARNING_STRUCTURAL_CONSTRAINT_SLICE_ORDER_H

#include <agrum/agrum.h>
#include <agrum/learning/constraints/structuralConstraintDiGraph.h>
#include <agrum/learning/constraints/structuralConstraintSetStatic.h>

namespace gum {

  namespace learning {

    class StructuralConstraintSliceOrder
        : protected virtual StructuralConstraintSetStatic<
             StructuralConstraintDiGraph > {
      public:
      // ##########################################################################
      // ##########################################################################

      StructuralConstraintSliceOrder();


      StructuralConstraintSliceOrder(const NodeProperty< NodeId >& order);

      StructuralConstraintSliceOrder(const DiGraph&                graph,
                                     const NodeProperty< NodeId >& order);

      StructuralConstraintSliceOrder(const StructuralConstraintSliceOrder& from);

      StructuralConstraintSliceOrder(StructuralConstraintSliceOrder&& from);

      virtual ~StructuralConstraintSliceOrder();


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

      StructuralConstraintSliceOrder&
         operator=(const StructuralConstraintSliceOrder& from);

      StructuralConstraintSliceOrder&
         operator=(StructuralConstraintSliceOrder&& from);


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

      void setSliceOrder(const NodeProperty< NodeId >& slice);

      const NodeProperty< NodeId >& sliceOrder() const;

      void addNode(NodeId node, NodeId slice);

      void setDefaultSlice(NodeId slice);

      void setGraphAlone(const DiGraph& graph);


      void modifyGraphAlone(const ArcAddition& change);


      void modifyGraphAlone(const ArcDeletion& change);


      void modifyGraphAlone(const ArcReversal& change);


      void modifyGraphAlone(const GraphChange& change);


      bool isAlwaysInvalidAlone(const GraphChange& change) const;


      bool checkArcAdditionAlone(NodeId x, NodeId y) const;


      bool checkArcDeletionAlone(NodeId x, NodeId y) const;


      bool checkArcReversalAlone(NodeId x, NodeId y) const;


      bool checkModificationAlone(const ArcAddition& change) const;


      bool checkModificationAlone(const ArcDeletion& change) const;


      bool checkModificationAlone(const ArcReversal& change) const;


      bool checkModificationAlone(const GraphChange& 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 StructuralConstraintSliceOrder
#  include <agrum/learning/constraints/structuralConstraintPatternHeader.h>
#  undef GUM_CONSTRAINT_CLASS_NAME
#endif   // DOXYGEN_SHOULD_SKIP_THIS

      protected:
      NodeProperty< NodeId > _SliceOrder__order;
    };

  } /* namespace learning */

} /* namespace gum */

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

#endif /* GUM_LEARNING_STRUCTURAL_CONSTRAINT_SLICE_ORDER_H */