DAGCycleDetector.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_DAG_CYCLE_DETECTOR_H
#define GUM_DAG_CYCLE_DETECTOR_H
 
#include <vector>
 
#include <agrum/base/graphs/DAG.h>
 
namespace gum {
 
  /* ===========================================================================
   */
  // DAG CYCLE DETECTOR
  /* ===========================================================================
   */
  class DAGCycleDetector {
    public:
    // the type of modification that can be applied to the graph
    enum class ChangeType { ARC_ADDITION, ARC_DELETION, ARC_REVERSAL };

    class Change {
      public:
      Change(ChangeType type, NodeId tail, NodeId head) noexcept;
      Change(const Change& from) noexcept;
      Change(Change&& from) noexcept;
      virtual ~Change() noexcept;
 
      protected:
      Change& operator=(const Change& from) noexcept;
      Change& operator=(Change&& from) noexcept;
 
      public:
      // ##########################################################################
      // ##########################################################################

      ChangeType type() const noexcept;

      NodeId tail() const noexcept;

      NodeId head() const noexcept;

 
      private:
      ChangeType _type_;

      NodeId _tail_;

      NodeId _head_;
    };

    class ArcAdd: public Change {
      public:
      // ##########################################################################
      // ##########################################################################
      ArcAdd(NodeId tail, NodeId head) noexcept;

      ArcAdd(const ArcAdd& from) noexcept;

      ArcAdd(ArcAdd&& from) noexcept;

      ~ArcAdd() noexcept;

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

      ArcAdd& operator=(const ArcAdd& from) noexcept;

      ArcAdd& operator=(ArcAdd&& from) noexcept;

    };

    class ArcDel: public Change {
      public:
      // ##########################################################################
      // ##########################################################################
      ArcDel(NodeId tail, NodeId head) noexcept;

      ArcDel(const ArcDel& from) noexcept;

      ArcDel(ArcDel&& from) noexcept;

      ~ArcDel() noexcept;

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

      ArcDel& operator=(const ArcDel& from) noexcept;

      ArcDel& operator=(ArcDel&& from) noexcept;

    };

    class ArcReverse: public Change {
      public:
      // ##########################################################################
      // ##########################################################################
      ArcReverse(NodeId tail, NodeId head) noexcept;

      ArcReverse(const ArcReverse& from) noexcept;

      ArcReverse(ArcReverse&& from) noexcept;

      ~ArcReverse() noexcept;

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

      ArcReverse& operator=(const ArcReverse& from) noexcept;

      ArcReverse& operator=(ArcReverse&& from) noexcept;

    };
 
    // ############################################################################
    // ############################################################################

    DAGCycleDetector() noexcept;

    DAGCycleDetector(const DAGCycleDetector& from);

    DAGCycleDetector(DAGCycleDetector&& from);

    ~DAGCycleDetector();

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

    DAGCycleDetector& operator=(const DAGCycleDetector& from);

    DAGCycleDetector& operator=(DAGCycleDetector&& from);


    bool operator==(const DAGCycleDetector& from) const;


    bool operator!=(const DAGCycleDetector& from) const;

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

    void setDAG(const DAG& dag);


    void addArc(NodeId x, NodeId y);


    void eraseArc(NodeId x, NodeId y);


    void reverseArc(NodeId x, NodeId y);


    bool hasCycleFromAddition(NodeId x, NodeId y) const noexcept;


    bool hasCycleFromReversal(NodeId x, NodeId y) const noexcept;


    bool hasCycleFromDeletion(NodeId x, NodeId y) const noexcept;


    bool hasCycleFromModifications(const std::vector< Change >& modifs) const;

 
    private:
    DiGraph _dag_;


    NodeProperty< NodeProperty< Size > > _ancestors_;


    NodeProperty< NodeProperty< Size > > _descendants_;

    void _addWeightedSet_(NodeProperty< Size >&       nodeset,
                          const NodeProperty< Size >& set_to_add,
                          Size                        multiplier) const;

    void _delWeightedSet_(NodeProperty< Size >&       nodeset,
                          const NodeProperty< Size >& set_to_del,
                          Size                        multiplier) const;

    void _restrictWeightedSet_(NodeProperty< Size >&       result_set,
                               const NodeProperty< Size >& set_to_restrict,
                               const NodeSet&              extrmities) const;
  };
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/algorithms/DAGCycleDetector_inl.h>
#endif   // GU%_NO_INLINE
 
#endif   // GUM_DAG_CYCLE_DETECTOR_H