graphChangesGenerator4K2.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_LEARNING_GRAPH_CHANGES_GENERATOR_4_K2_H
#define GUM_LEARNING_GRAPH_CHANGES_GENERATOR_4_K2_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/threads/threadExecutor.h>
#include <agrum/base/core/threads/threads.h>
#include <agrum/BN/learning/structureUtils/IGraphChangesGenerator4DiGraph.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:
      Size _max_threads_number_{gum::getNumberOfThreads()};
    };
 
  } /* namespace learning */
 
} /* namespace gum */

#include <agrum/BN/learning/structureUtils/graphChangesGenerator4K2_tpl.h>
 
#endif /* GUM_LEARNING_GRAPH_CHANGES_GENERATOR_4_K2_H */