graphChangesGenerator4K2.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}@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 wil 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_LEARNING_GRAPH_CHANGES_GENERATOR_4_K2_H
#define GUM_LEARNING_GRAPH_CHANGES_GENERATOR_4_K2_H

#include <agrum/agrum.h>
#include <agrum/core/OMPThreads.h>
#include <agrum/core/sequence.h>
#include <agrum/core/set.h>

#include <agrum/graphs/diGraph.h>
#include <agrum/learning/structureUtils/IGraphChangesGenerator4DiGraph.h>
#include <agrum/learning/structureUtils/graphChange.h>

namespace gum {

  namespace learning {

    // a dummy class used to check that the generator is adapted to K2
    struct __GraphChangesGenerator4K2 {};

    template < typename STRUCT_CONSTRAINT >
    class GraphChangesGenerator4K2
        : public IGraphChangesGenerator4DiGraph
        , __GraphChangesGenerator4K2 {
      public:
      using iterator = typename Set< GraphChange >::const_iterator;

      using const_iterator = iterator;

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

      GraphChangesGenerator4K2(STRUCT_CONSTRAINT& constraint);

      GraphChangesGenerator4K2(
         const GraphChangesGenerator4K2< STRUCT_CONSTRAINT >& from);

      GraphChangesGenerator4K2(
         GraphChangesGenerator4K2< STRUCT_CONSTRAINT >&& from);

      virtual ~GraphChangesGenerator4K2();


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

      GraphChangesGenerator4K2< STRUCT_CONSTRAINT >&
         operator=(const GraphChangesGenerator4K2< STRUCT_CONSTRAINT >& from);

      GraphChangesGenerator4K2< STRUCT_CONSTRAINT >&
         operator=(GraphChangesGenerator4K2< STRUCT_CONSTRAINT >&& from);


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

      iterator begin() const;

      const iterator& end() const;


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

      STRUCT_CONSTRAINT& constraint() const noexcept;

      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);

      void clearChanges() noexcept;

      void notifyGetCompleted();

      void setMaxNbThreads(Size nb) noexcept;

      void setOrder(const Sequence< NodeId >& order);

      void setOrder(const std::vector< NodeId >& order);


      protected:
      DiGraph _graph;

      STRUCT_CONSTRAINT* _constraint;

      Sequence< NodeId > _order;

      Set< GraphChange > _legal_changes;

      void _createChanges();

      private:
#if defined(_OPENMP) && !defined(GUM_DEBUG_MODE)
      Size __max_threads_number{getMaxNumberOfThreads()};
#else
      Size __max_threads_number{1};
#endif /* GUM_DEBUG_MODE */
    };

  } /* namespace learning */

} /* namespace gum */

#include <agrum/learning/structureUtils/graphChangesGenerator4K2_tpl.h>

#endif /* GUM_LEARNING_GRAPH_CHANGES_GENERATOR_4_K2_H */