structuralConstraintIndegree.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                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_LEARNING_STRUCTURAL_CONSTRAINT_INDEGREE_H
#define GUM_LEARNING_STRUCTURAL_CONSTRAINT_INDEGREE_H
 
#include <limits>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/learning/constraints/structuralConstraintDiGraph.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;
 
      Size maxIndegree() const { return _Indegree_max_indegree_; };

 
#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/BN/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/BN/learning/constraints/structuralConstraintIndegree_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_STRUCTURAL_CONSTRAINT_INDEGREE_H */