structuralConstraintIndegree.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_LEARNING_STRUCTURAL_CONSTRAINT_INDEGREE_H
#define GUM_LEARNING_STRUCTURAL_CONSTRAINT_INDEGREE_H

#include <limits>

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

namespace gum {

  namespace learning {

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

      StructuralConstraintIndegree();

      StructuralConstraintIndegree(Size nb_nodes, Size max_indegree);

      StructuralConstraintIndegree(const DiGraph& graph, Size max_indegree);

      StructuralConstraintIndegree(const StructuralConstraintIndegree& from);

      StructuralConstraintIndegree(StructuralConstraintIndegree&& from);

      virtual ~StructuralConstraintIndegree();


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

      StructuralConstraintIndegree&
         operator=(const StructuralConstraintIndegree& from);

      StructuralConstraintIndegree& operator=(StructuralConstraintIndegree&& from);


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

      void setIndegree(const NodeProperty< Size >& max_indegree);

      void setMaxIndegree(Size max_indegree, bool update_all_node = false);

      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 StructuralConstraintIndegree
#  include <agrum/learning/constraints/structuralConstraintPatternHeader.h>
#  undef GUM_CONSTRAINT_CLASS_NAME
#endif   // DOXYGEN_SHOULD_SKIP_THIS

      protected:
      NodeProperty< Size > _Indegree__max_parents;

      Size _Indegree__max_indegree{std::numeric_limits< Size >::max()};
    };

  } /* namespace learning */

} /* namespace gum */

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

#endif /* GUM_LEARNING_STRUCTURAL_CONSTRAINT_INDEGREE_H */