graphChangesSelector4DiGraph.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_SELECTOR_4_DIGRAPH_H
#define GUM_LEARNING_GRAPH_CHANGES_SELECTOR_4_DIGRAPH_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/learning/scores_and_tests/score.h>
 
namespace gum {
 
  namespace learning {

    template < typename STRUCTURAL_CONSTRAINT, typename GRAPH_CHANGES_GENERATOR >
    class GraphChangesSelector4DiGraph {
      public:
      using GeneratorType = GRAPH_CHANGES_GENERATOR;
 
      // ##########################################################################
      // ##########################################################################

      GraphChangesSelector4DiGraph(Score&                   score,
                                   STRUCTURAL_CONSTRAINT&   constraint,
                                   GRAPH_CHANGES_GENERATOR& changes_generator);

      GraphChangesSelector4DiGraph(
          const GraphChangesSelector4DiGraph< STRUCTURAL_CONSTRAINT, GRAPH_CHANGES_GENERATOR >&
              from);

      GraphChangesSelector4DiGraph(
          GraphChangesSelector4DiGraph< STRUCTURAL_CONSTRAINT, GRAPH_CHANGES_GENERATOR >&& from);

      ~GraphChangesSelector4DiGraph();

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

      GraphChangesSelector4DiGraph< STRUCTURAL_CONSTRAINT, GRAPH_CHANGES_GENERATOR >&
          operator=(const GraphChangesSelector4DiGraph< STRUCTURAL_CONSTRAINT,
                                                        GRAPH_CHANGES_GENERATOR >& from);

      GraphChangesSelector4DiGraph< STRUCTURAL_CONSTRAINT, GRAPH_CHANGES_GENERATOR >& operator=(
          GraphChangesSelector4DiGraph< STRUCTURAL_CONSTRAINT, GRAPH_CHANGES_GENERATOR >&& from);

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

      GeneratorType& graphChangeGenerator() const noexcept;

      bool empty();

      bool empty(const NodeId i);


      const GraphChange& bestChange();


      const GraphChange& bestChange(const NodeId i);


      double bestScore();


      double bestScore(const NodeId i);

      void applyChange(const GraphChange& change);


      void applyChangeWithoutScoreUpdate(const GraphChange& change);


      void updateScoresAfterAppliedChanges();

      bool isChangeValid(const GraphChange& change) const;

      void setGraph(DiGraph& graph);

      std::vector< std::pair< NodeId, double > > nodesSortedByBestScore() const;

      std::vector< std::pair< NodeId, double > > nodesUnsortedWithScore() const;

 
      private:
      Score* _score_;

      STRUCTURAL_CONSTRAINT* _constraint_;

      GRAPH_CHANGES_GENERATOR* _changes_generator_;

      Sequence< GraphChange > _changes_;


      std::vector< std::pair< double, double > > _change_scores_;


      NodeProperty< PriorityQueue< std::size_t, double, std::greater< double > > >
          _change_queue_per_node_;

      PriorityQueue< NodeId, double, std::greater< double > > _node_queue_;


      Set< std::size_t > _illegal_changes_;

      NodeProperty< double > _node_current_scores_;

      NodeProperty< std::vector< NodeId > > _parents_;

      bool _queues_valid_{false};

      Set< NodeId > _queues_to_update_;

      bool _isChangeValid_(const std::size_t index) const;

      void _invalidateChange_(const std::size_t change_index);

      void _illegal2LegalChanges_(Set< std::size_t >& changes_to_recompute);

      void _findLegalChangesNeedingUpdate_(Set< std::size_t >& changes_to_recompute,
                                           const NodeId        target_node);

      void _updateScores_(const Set< std::size_t >& changes_to_recompute);

      void _getNewChanges_();
    };
 
  } /* namespace learning */
 
} /* namespace gum */

#include <agrum/BN/learning/structureUtils/graphChangesSelector4DiGraph_tpl.h>
 
#endif /* GUM_LEARNING_GRAPH_CHANGES_SELECTOR_4_DIGRAPH_H */