structuralConstraintSetStatic.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_SET_STATIC_H
#define GUM_LEARNING_STRUCTURAL_CONSTRAINT_SET_STATIC_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphs/diGraph.h>
#include <agrum/BN/learning/structureUtils/graphChange.h>
 
#include <type_traits>
 
namespace gum {
 
  namespace learning {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
    // a class that indicates the we inherit from a
    // StructuralConstraintSetStatic
    struct _StructuralRoot_ {};
 
    // a temporary structure used to help computing the minimal set of
    // constraints
    template < typename FIRST_CONSTRAINT, typename... OTHER_CONSTRAINTS >
    struct _ConstraintSet_;
 
    // a structure to concatenate  _ConstraintSets_ or simply constraints and
    // produce as a result a new  _ConstraintSet_
    template < typename SET1, typename SET2 >
    struct _ConcatConstraintSet_;
 
    // a helper function to create minimum structural constraint sets and the
    // methods actually used on all these constraints. This is a helper for
    // the class that the user should use, i.e., StructuralConstraintSetStatic
    template < typename FIRST_CONSTRAINT, typename... OTHER_CONSTRAINTS >
    class _StructuralConstraintSetStatic_;
 
    // ============================================================================
    // checks whether a given structural constraint belongs to a given set of
    // structural constraints
    template < typename CONSTRAINT, typename SET >
    struct _IsInConstraintSet_;
 
    template < typename CONSTRAINT, typename SET >
    struct _IsInConstraintSet_< CONSTRAINT, _ConstraintSet_< SET > > {
      constexpr static bool value = std::is_same< CONSTRAINT, SET >::value;
    };
 
    template < typename CONSTRAINT, typename SET1, typename... SETS >
    struct _IsInConstraintSet_< CONSTRAINT, _ConstraintSet_< SET1, SETS... > > {
      constexpr static bool value
          = std::is_same< CONSTRAINT, SET1 >::value
         || _IsInConstraintSet_< CONSTRAINT, _ConstraintSet_< SETS... > >::value;
    };
 
    // ============================================================================
    // a temporary structure used to help computing the minimal set of
    // constraints
    // (removing all duplicates) belonging to a given set of structural
    // constraints. For instance, if we have the following structural hierarchy:
    // Z->Y->X, T->Y->X and we have the set of constraints S =  <Z,T>, the set
    // of
    // all structural constraints reachable from S is S' = <Z,Y,X,T,Y,X>. The
    // goal
    // of the following class is to transform S' into S'' = <Z,T,Y,X>, i.e., the
    // set S' without any duplicates.
    template < typename FIRST_CONSTRAINT, typename... OTHER_CONSTRAINTS >
    struct _ConstraintSet_: public _ConstraintSet_< OTHER_CONSTRAINTS... > {
      using minset = typename std::conditional<
          _IsInConstraintSet_< FIRST_CONSTRAINT, _ConstraintSet_< OTHER_CONSTRAINTS... > >::value,
          typename _ConstraintSet_< OTHER_CONSTRAINTS... >::minset,
          typename _ConcatConstraintSet_<
              FIRST_CONSTRAINT,
              typename _ConstraintSet_< OTHER_CONSTRAINTS... >::minset >::type >::type;
      using set = _StructuralConstraintSetStatic_< FIRST_CONSTRAINT, OTHER_CONSTRAINTS... >;
    };
 
    template < typename CONSTRAINT >
    struct _ConstraintSet_< CONSTRAINT > {
      using minset = _ConstraintSet_< CONSTRAINT >;
      using set    = _StructuralConstraintSetStatic_< CONSTRAINT >;
    };
 
    // ============================================================================
    // a structure to concatenate  _ConstraintSets_ or simply constraints and
    // produce as a result a new  _ConstraintSet_
    template < typename SET1, typename SET2 >
    struct _ConcatConstraintSet_;
 
    template < typename CONSTRAINT1, typename CONSTRAINT2 >
    struct _ConcatConstraintSet_< CONSTRAINT1, _ConstraintSet_< CONSTRAINT2 > > {
      using type = _ConstraintSet_< CONSTRAINT1, CONSTRAINT2 >;
    };
 
    template < typename CONSTRAINT1, typename CONSTRAINT2 >
    struct _ConcatConstraintSet_< _ConstraintSet_< CONSTRAINT1 >, _ConstraintSet_< CONSTRAINT2 > > {
      using type = _ConstraintSet_< CONSTRAINT1, CONSTRAINT2 >;
    };
 
    template < typename CONSTRAINT1, typename CONSTRAINT2, typename... OTHER_CONSTRAINT2 >
    struct _ConcatConstraintSet_< CONSTRAINT1,
                                  _ConstraintSet_< CONSTRAINT2, OTHER_CONSTRAINT2... > > {
      using type = _ConstraintSet_< CONSTRAINT1, CONSTRAINT2, OTHER_CONSTRAINT2... >;
    };
 
    template < typename CONSTRAINT1, typename CONSTRAINT2, typename... OTHER_CONSTRAINT1 >
    struct _ConcatConstraintSet_< _ConstraintSet_< CONSTRAINT1, OTHER_CONSTRAINT1... >,
                                  _ConstraintSet_< CONSTRAINT2 > > {
      using type = _ConstraintSet_< CONSTRAINT1, OTHER_CONSTRAINT1..., CONSTRAINT2 >;
    };
 
    template < typename CONSTRAINT1,
               typename CONSTRAINT2,
               typename... OTHER_CONSTR1,
               typename... OTHER_CONSTR2 >
    struct _ConcatConstraintSet_< _ConstraintSet_< CONSTRAINT1, OTHER_CONSTR1... >,
                                  _ConstraintSet_< CONSTRAINT2, OTHER_CONSTR2... > > {
      using type = _ConstraintSet_< CONSTRAINT1, OTHER_CONSTR1..., CONSTRAINT2, OTHER_CONSTR2... >;
    };
 
    // ============================================================================
    // a helper function to create minimum structural constraint sets and the
    // methods actually used on all these constraints. This is a helper for
    // the class that the user should use, i.e., StructuralConstraintSetStatic
    template < typename CONSTRAINT1, typename... OTHER_CONSTRAINTS >
    class _StructuralConstraintSetStatic_:
        public virtual CONSTRAINT1,
        public virtual _StructuralConstraintSetStatic_< OTHER_CONSTRAINTS... > {
      public:
      using first_constraint = CONSTRAINT1;

      using next_constraints = _StructuralConstraintSetStatic_< OTHER_CONSTRAINTS... >;
 
      // determines the set of all constraints in the set (included inherited
      // ones)
      using allConstraints = typename _ConcatConstraintSet_<
          typename std::conditional<
              std::is_base_of< _StructuralRoot_, CONSTRAINT1 >::value,
              typename _ConcatConstraintSet_< CONSTRAINT1,
                                              typename CONSTRAINT1::allConstraints >::type,
              _ConstraintSet_< CONSTRAINT1 > >::type,
          typename next_constraints::allConstraints >::type;

      using minConstraints = typename allConstraints::minset::set;
 
      // ##########################################################################
      // ##########################################################################

      _StructuralConstraintSetStatic_();

      _StructuralConstraintSetStatic_(
          const _StructuralConstraintSetStatic_< CONSTRAINT1, OTHER_CONSTRAINTS... >&);

      ~_StructuralConstraintSetStatic_();

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

      _StructuralConstraintSetStatic_< CONSTRAINT1, OTHER_CONSTRAINTS... >&
          operator=(const _StructuralConstraintSetStatic_< CONSTRAINT1, OTHER_CONSTRAINTS... >&);

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

      void setGraph(const DiGraph& graph);

      void modifyGraph(const ArcAddition& change);

      void modifyGraph(const ArcDeletion& change);

      void modifyGraph(const ArcReversal& change);

      void modifyGraph(const GraphChange& change);

      bool isAlwaysInvalid(const GraphChange& change) const;

      bool checkArcAddition(NodeId x, NodeId y) const;

      bool checkArcDeletion(NodeId x, NodeId y) const;

      bool checkArcReversal(NodeId x, NodeId y) const;

      bool checkModification(const ArcAddition& change) const;

      bool checkModification(const ArcDeletion& change) const;

      bool checkModification(const ArcReversal& change) const;

      bool checkModification(const GraphChange& change) const;

    };
 
    template < typename CONSTRAINT >
    class _StructuralConstraintSetStatic_< CONSTRAINT >:
        public virtual CONSTRAINT,
        public virtual _StructuralRoot_ {
      public:
      using first_constraint = CONSTRAINT;

      using next_constraints = _StructuralRoot_;
 
      // determines the set of all constraints in the set (included inherited
      // ones). Rhis produces an  _ConstraintSet_. This type is to be used internally.
      using allConstraints = typename std::conditional<
          std::is_base_of< _StructuralRoot_, CONSTRAINT >::value,
          typename _ConcatConstraintSet_< CONSTRAINT, typename CONSTRAINT::allConstraints >::type,
          _ConstraintSet_< CONSTRAINT > >::type;

      using minConstraints = typename allConstraints::minset::set;
 
      // ##########################################################################
      // ##########################################################################

      _StructuralConstraintSetStatic_();

      _StructuralConstraintSetStatic_(const _StructuralConstraintSetStatic_< CONSTRAINT >&);

      ~_StructuralConstraintSetStatic_();

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

      _StructuralConstraintSetStatic_< CONSTRAINT >&
          operator=(const _StructuralConstraintSetStatic_< CONSTRAINT >&);

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

      void setGraph(const DiGraph& graph);

      void modifyGraph(const ArcAddition& change);

      void modifyGraph(const ArcDeletion& change);

      void modifyGraph(const ArcReversal& change);

      void modifyGraph(const GraphChange& change);

      bool isAlwaysInvalid(const GraphChange& change) const;

      bool checkArcAddition(NodeId x, NodeId y) const;

      bool checkArcDeletion(NodeId x, NodeId y) const;

      bool checkArcReversal(NodeId x, NodeId y) const;

      bool checkModification(const ArcAddition& change) const;

      bool checkModification(const ArcDeletion& change) const;

      bool checkModification(const ArcReversal& change) const;

      bool checkModification(const GraphChange& change) const;

    };
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

    template < typename CONSTRAINT1, typename... OTHER_CONSTRAINTS >
    class StructuralConstraintSetStatic:
        public virtual _StructuralConstraintSetStatic_< CONSTRAINT1,
                                                        OTHER_CONSTRAINTS... >::minConstraints {
      public:
      using constraints =
          typename _StructuralConstraintSetStatic_< CONSTRAINT1,
                                                    OTHER_CONSTRAINTS... >::minConstraints;
 
      // ##########################################################################
      // ##########################################################################

      StructuralConstraintSetStatic();

      StructuralConstraintSetStatic(
          const StructuralConstraintSetStatic< CONSTRAINT1, OTHER_CONSTRAINTS... >&);

      ~StructuralConstraintSetStatic();

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

      StructuralConstraintSetStatic< CONSTRAINT1, OTHER_CONSTRAINTS... >&
          operator=(const StructuralConstraintSetStatic< CONSTRAINT1, OTHER_CONSTRAINTS... >&);

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

      void setGraph(const DiGraph& graph);

      void modifyGraph(const ArcAddition& change);

      void modifyGraph(const ArcDeletion& change);

      void modifyGraph(const ArcReversal& change);

      void modifyGraph(const GraphChange& change);

      bool isAlwaysInvalid(const GraphChange& change) const;

      bool checkArcAddition(NodeId x, NodeId y) const;

      bool checkArcDeletion(NodeId x, NodeId y) const;

      bool checkArcReversal(NodeId x, NodeId y) const;

      bool checkModification(const ArcAddition& change) const;

      bool checkModification(const ArcDeletion& change) const;

      bool checkModification(const ArcReversal& change) const;

      bool checkModification(const GraphChange& change) const;

    };
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
    template < typename CONSTRAINT >
    class StructuralConstraintSetStatic< CONSTRAINT >:
        public virtual _StructuralConstraintSetStatic_< CONSTRAINT >::minConstraints {
      public:
      using constraints = typename _StructuralConstraintSetStatic_< CONSTRAINT >::minConstraints;
 
      // ##########################################################################
      // ##########################################################################

      StructuralConstraintSetStatic();

      StructuralConstraintSetStatic(const StructuralConstraintSetStatic< CONSTRAINT >&);

      ~StructuralConstraintSetStatic();

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

      StructuralConstraintSetStatic< CONSTRAINT >&
          operator=(const StructuralConstraintSetStatic< CONSTRAINT >&);

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

      void setGraph(const DiGraph& graph);

      void modifyGraph(const ArcAddition& change);

      void modifyGraph(const ArcDeletion& change);

      void modifyGraph(const ArcReversal& change);

      void modifyGraph(const GraphChange& change);

      bool isAlwaysInvalid(const GraphChange& change) const;

      bool checkArcAddition(NodeId x, NodeId y) const;

      bool checkArcDeletion(NodeId x, NodeId y) const;

      bool checkArcReversal(NodeId x, NodeId y) const;

      bool checkModification(const ArcAddition& change) const;

      bool checkModification(const ArcDeletion& change) const;

      bool checkModification(const ArcReversal& change) const;

      bool checkModification(const GraphChange& change) const;

    };
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  } /* namespace learning */
 
} /* namespace gum */

#include <agrum/BN/learning/constraints/structuralConstraintSetStatic_tpl.h>
 
#endif /* GUM_LEARNING_STRUCTURAL_CONSTRAINT_SET_STATIC_H */