structuralConstraintIndegree_inl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once

 
#include <agrum/BN/learning/constraints/structuralConstraintIndegree.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
namespace gum::learning {

  INLINE void StructuralConstraintIndegree::setGraphAlone(const DiGraph& graph) {
    // check that the max_indegree corresponds to the graph
    for (const auto id: graph) {
      if (!_Indegree_max_parents_.exists(id)) {
        _Indegree_max_parents_.insert(id, _Indegree_max_indegree_);
      }
    }
  }

  INLINE bool StructuralConstraintIndegree::checkArcAdditionAlone(NodeId x, NodeId y) const {
    return (_Indegree_max_parents_[y] > _graph_.parents(y).size());
  }

  INLINE bool StructuralConstraintIndegree::checkArcDeletionAlone(NodeId x, NodeId y) const {
    return true;
  }

  INLINE bool StructuralConstraintIndegree::checkArcReversalAlone(NodeId x, NodeId y) const {
    return (_Indegree_max_parents_[x] > _graph_.parents(x).size());
  }

  INLINE bool StructuralConstraintIndegree::checkArcTriangleDeletion1Alone(NodeId node1,
                                                                           NodeId node2,
                                                                           NodeId node3) const {
    return _Indegree_max_parents_[node1] >= _graph_.parents(node1).size() + 2;
  }

  INLINE bool StructuralConstraintIndegree::checkArcTriangleDeletion2Alone(NodeId node1,
                                                                           NodeId node2,
                                                                           NodeId node3) const {
    return _Indegree_max_parents_[node2] > _graph_.parents(node1).size();
  }

  INLINE bool
      StructuralConstraintIndegree::checkModificationAlone(const ArcAddition& change) const {
    return checkArcAdditionAlone(change.node1(), change.node2());
  }

  INLINE bool
      StructuralConstraintIndegree::checkModificationAlone(const ArcDeletion& change) const {
    return checkArcDeletionAlone(change.node1(), change.node2());
  }

  INLINE bool
      StructuralConstraintIndegree::checkModificationAlone(const ArcReversal& change) const {
    return checkArcReversalAlone(change.node1(), change.node2());
  }

  INLINE bool StructuralConstraintIndegree::checkModificationAlone(
      const ArcTriangleDeletion1& change) const {
    return checkArcTriangleDeletion1Alone(change.node1(), change.node2(), change.node3());
  }

  INLINE bool StructuralConstraintIndegree::checkModificationAlone(
      const ArcTriangleDeletion2& change) const {
    return checkArcTriangleDeletion2Alone(change.node1(), change.node2(), change.node3());
  }


  INLINE void StructuralConstraintIndegree::modifyGraphAlone(const ArcAddition& change) {}

  INLINE void StructuralConstraintIndegree::modifyGraphAlone(const ArcDeletion& change) {}

  INLINE void StructuralConstraintIndegree::modifyGraphAlone(const ArcReversal& change) {}

  INLINE void StructuralConstraintIndegree::modifyGraphAlone(const GraphChange& change) {}

  INLINE void StructuralConstraintIndegree::modifyGraphAlone(const ArcTriangleDeletion1& change) {}

  INLINE void StructuralConstraintIndegree::modifyGraphAlone(const ArcTriangleDeletion2& change) {}

  INLINE bool StructuralConstraintIndegree::isAlwaysInvalidAlone(const GraphChange& change) const {
    switch (change.type()) {
      case GraphChangeType::ARC_ADDITION : return _Indegree_max_parents_[change.node2()] == 0;
 
      case GraphChangeType::ARC_DELETION : return true;
 
      case GraphChangeType::ARC_REVERSAL : return _Indegree_max_parents_[change.node1()] == 0;
 
      case GraphChangeType::ARC_TRIANGLE_DELETION1 :
        return _Indegree_max_parents_[change.node1()] < 2;
 
      case GraphChangeType::ARC_TRIANGLE_DELETION2 :
        return _Indegree_max_parents_[change.node2()] < 2;
 
      default :
        GUM_ERROR(OperationNotAllowed,
                  "Graph change operation "
                      << change.typeAsString()
                      << " is not supported by the Indegree structural constraint");
    }
  }

  INLINE void StructuralConstraintIndegree::setIndegree(const NodeProperty< Size >& max_indegree) {
    for (const auto& degree: max_indegree) {
      _Indegree_max_parents_.set(degree.first, degree.second);
    }
  }

  INLINE void StructuralConstraintIndegree::setMaxIndegree(Size max_indegree, bool update_all) {
    if (update_all) {
      for (auto& degree: _Indegree_max_parents_) {
        degree.second = max_indegree;
      }
    }
 
    _Indegree_max_indegree_ = max_indegree;
  }
 
// include all the methods applicable to the whole class hierarchy
#  define GUM_CONSTRAINT_CLASS_NAME StructuralConstraintIndegree
#  include <agrum/BN/learning/constraints/structuralConstraintPatternInline.h>
#  undef GUM_CONSTRAINT_CLASS_NAME
 
  INLINE Size StructuralConstraintIndegree::maxIndegree() const { return _Indegree_max_indegree_; }
 
}   // namespace gum::learning
 
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */