DAGCycleDetector.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_DAG_CYCLE_DETECTOR_H
#define GUM_DAG_CYCLE_DETECTOR_H

#include <vector>

#include <agrum/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/graphs/algorithms/DAGCycleDetector_inl.h>
#endif   // GUM_NOINLINE

#endif   // GUM_DAG_CYCLE_DETECTOR_H