/****************************************************************************
 *   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/structuralConstraintNoParentNodes.h>

/** @file
 * @brief the structural constraint for forbidding the creation of some arcs
 * during structure learning
 *
 * @author Christophe GONZALES(_at_AMU) and Pierre-Henri WUILLEMIN(_at_LIP6)
 */
#ifndef DOXYGEN_SHOULD_SKIP_THIS


namespace gum::learning {

  /// sets a new graph from which we will perform checkings
  INLINE void StructuralConstraintNoParentNodes::setGraphAlone(const DiGraph& graph) {}

  /// checks whether the constraints enable to add arc (x,y)
  INLINE bool StructuralConstraintNoParentNodes::checkArcAdditionAlone(NodeId x, NodeId y) const {
    return !_noParentNodes_.exists(y);
  }

  /// checks whether the constraints enable to remove arc (x,y)
  INLINE bool StructuralConstraintNoParentNodes::checkArcDeletionAlone(NodeId x, NodeId y) const {
    return true;
  }

  /// checks whether the constraints enable to reverse arc (x,y)
  INLINE bool StructuralConstraintNoParentNodes::checkArcReversalAlone(NodeId x, NodeId y) const {
    return !_noParentNodes_.exists(x);
  }

  /// checks whether the constraints enable to apply an ArcTriangleDeletion1(x, y, z)
  INLINE bool StructuralConstraintNoParentNodes::checkArcTriangleDeletion1Alone(NodeId x,
                                                                                NodeId y,
                                                                                NodeId z) const {
    return !_noParentNodes_.exists(x);
  }

  /// checks whether the constraints enable to apply an ArcTriangleDeletion1(x, y, z)
  INLINE bool StructuralConstraintNoParentNodes::checkArcTriangleDeletion2Alone(NodeId x,
                                                                                NodeId y,
                                                                                NodeId z) const {
    return !_noParentNodes_.exists(y);
  }

  /// checks whether the constraints enable to add an arc
  INLINE bool
      StructuralConstraintNoParentNodes::checkModificationAlone(const ArcAddition& change) const {
    return checkArcAdditionAlone(change.node1(), change.node2());
  }

  /// checks whether the constraints enable to remove an arc
  INLINE bool
      StructuralConstraintNoParentNodes::checkModificationAlone(const ArcDeletion& change) const {
    return checkArcDeletionAlone(change.node1(), change.node2());
  }

  /// checks whether the constraints enable to reverse an arc
  INLINE bool
      StructuralConstraintNoParentNodes::checkModificationAlone(const ArcReversal& change) const {
    return checkArcReversalAlone(change.node1(), change.node2());
  }

  /// checks whether the constraints enable to apply an ArcTriangleDeletion1
  INLINE bool StructuralConstraintNoParentNodes::checkModificationAlone(
      const ArcTriangleDeletion1& change) const {
    return checkArcTriangleDeletion1Alone(change.node1(), change.node2(), change.node3());
  }

  /// checks whether the constraints enable to apply an ArcTriangleDeletion2
  INLINE bool StructuralConstraintNoParentNodes::checkModificationAlone(
      const ArcTriangleDeletion2& change) const {
    return checkArcTriangleDeletion2Alone(change.node1(), change.node2(), change.node3());
  }

  /// checks whether the constraints enable to perform a graph change

  /// notify the constraint of a modification of the graph
  INLINE void StructuralConstraintNoParentNodes::modifyGraphAlone(const ArcAddition& change) {}

  /// notify the constraint of a modification of the graph
  INLINE void StructuralConstraintNoParentNodes::modifyGraphAlone(const ArcDeletion& change) {}

  /// notify the constraint of a modification of the graph
  INLINE void StructuralConstraintNoParentNodes::modifyGraphAlone(const ArcReversal& change) {}

  /// notify the constraint of a modification of the graph
  INLINE void
      StructuralConstraintNoParentNodes::modifyGraphAlone(const ArcTriangleDeletion1& change) {}

  /// notify the constraint of a modification of the graph
  INLINE void
      StructuralConstraintNoParentNodes::modifyGraphAlone(const ArcTriangleDeletion2& change) {}

  /// notify the constraint of a modification of the graph
  INLINE void StructuralConstraintNoParentNodes::modifyGraphAlone(const GraphChange& change) {}

  /// indicates whether a change will always violate the constraint
  INLINE bool
      StructuralConstraintNoParentNodes::isAlwaysInvalidAlone(const GraphChange& change) const {
    switch (change.type()) {
      case GraphChangeType::ARC_ADDITION : return _noParentNodes_.exists(change.node2());

      case GraphChangeType::ARC_DELETION : return false;

      case GraphChangeType::ARC_REVERSAL : return _noParentNodes_.exists(change.node1());

      case GraphChangeType::ARC_TRIANGLE_DELETION1 : return _noParentNodes_.exists(change.node1());

      case GraphChangeType::ARC_TRIANGLE_DELETION2 : return _noParentNodes_.exists(change.node2());

      default :
        GUM_ERROR(OperationNotAllowed,
                  "edge modifications are not supported "
                  "by the No-Parent Nodes structural constraint");
    }
  }

  /// assign a set of forbidden arcs
  INLINE void StructuralConstraintNoParentNodes::setNodes(const NodeSet& set) {
    _noParentNodes_ = set;
  }

  /// assign a new forbidden arc
  INLINE void StructuralConstraintNoParentNodes::addNode(NodeId node) {
    _noParentNodes_.insert(node);
  }

  /// remove a forbidden arc
  INLINE void StructuralConstraintNoParentNodes::eraseNode(NodeId node) {
    _noParentNodes_.erase(node);
  }

  /// returns the set of mandatory arcs
  INLINE const NodeSet& StructuralConstraintNoParentNodes::nodes() const { return _noParentNodes_; }

// include all the methods applicable to the whole class hierarchy
#  define GUM_CONSTRAINT_CLASS_NAME StructuralConstraintNoParentNodes
#  include <agrum/BN/learning/constraints/structuralConstraintPatternRootInline.h>
#  undef GUM_CONSTRAINT_CLASS_NAME

}   // namespace gum::learning


#endif /* DOXYGEN_SHOULD_SKIP_THIS */
