graphChangesSelector4DiGraph.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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/base/core/sortedPriorityQueue.h>
#include <agrum/BN/learning/scores/score.h>
 
namespace gum {
 
  namespace learning {

    template < typename INVARIABLE_CONSTRAINT_TYPE, typename VARIABLE_CONSTRAINT_TYPE >
    class GraphChangesSelector4DiGraph {
      public:
      // ##########################################################################
      // ##########################################################################

      GraphChangesSelector4DiGraph(Score&                      score,
                                   INVARIABLE_CONSTRAINT_TYPE& invariable_constraints,
                                   VARIABLE_CONSTRAINT_TYPE&   variable_constraints);

      GraphChangesSelector4DiGraph(
          const GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE,
                                              VARIABLE_CONSTRAINT_TYPE >& from);

      GraphChangesSelector4DiGraph(GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE,
                                                                 VARIABLE_CONSTRAINT_TYPE >&& from);

      ~GraphChangesSelector4DiGraph();

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

      GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE, VARIABLE_CONSTRAINT_TYPE >&
          operator=(const GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE,
                                                        VARIABLE_CONSTRAINT_TYPE >& from);

      GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE, VARIABLE_CONSTRAINT_TYPE >&
          operator=(GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE,
                                                  VARIABLE_CONSTRAINT_TYPE >&& from);

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


      const GraphChange& bestChange();


      double bestDeltaScore();


      double deltaScore(const GraphChange& change, const bool internal_change = false) const;

      double score(const NodeId node) const;

      void applyChange(const GraphChange& change);

      bool isChangeValid(const GraphChange& change) const;

      void setGraph(DiGraph& graph);

      void finalizeGraph(DiGraph& graph);

      void useArcAdditions(bool use);

      void useArcDeletions(bool use);

      void useArcReversals(bool use);

      void useArcTriangleDeletions(bool use);

      bool arcAdditionsEnabled() const;

      bool arcDeletionsEnabled() const;

      bool arcReversalsEnabled() const;

      bool arcTriangleDeletionsEnabled() const;

      INVARIABLE_CONSTRAINT_TYPE& invariableConstraints();

      VARIABLE_CONSTRAINT_TYPE& variableConstraints();

 
      private:
      Score* _score_;

      INVARIABLE_CONSTRAINT_TYPE* _invariable_constraints_;

      VARIABLE_CONSTRAINT_TYPE* _variable_constraints_;
 

      DiGraph* _graph_{nullptr};

      NodeProperty< double > _node_scores_;

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

      SortedPriorityQueue< GraphChange, double > _sorted_changes_;

      NodeSet _removed_nodes_;
 
      bool _use_arc_additions_{true};
      bool _use_arc_deletions_{true};
      bool _use_arc_reversals_{true};
      bool _use_arc_triangle_deletions_{true};

      double _scoreAfterAddingParent_(const NodeId node, const NodeId new_parent);

      double _scoreAfterAddingParents_(const NodeId node,
                                       const NodeId new_parent1,
                                       const NodeId new_parent2);

      double _scoreAfterRemovingParent_(const NodeId node, const NodeId parent);

      double _scoreAfterRemovingParents_(const NodeId node,
                                         const NodeId parent1,
                                         const NodeId parent2);
 


      void _addArcAdditionToSortedChanges_(const ArcAddition& change);


      void _addArcDeletionToSortedChanges_(const ArcDeletion& change);


      void _addArcReversalToSortedChanges_(const ArcReversal& change);


      void _addArcTriangleDeletion1ToSortedChanges_(const ArcTriangleDeletion1& change);


      void _addArcTriangleDeletion2ToSortedChanges_(const ArcTriangleDeletion2& change);
 

      void _updateArcAdditionScore_(const NodeId tail, const NodeId head);

      void _updateArcDeletionScore_(const NodeId tail, const NodeId head);

      void _updateArcReversalScore_(const NodeId tail, const NodeId head);

      void _updateTriangleDeletionsScoresFromNeighborhood_(const NodeId changed_node);
 

      void _initSortedChangesWithArcAdditions_(const DiGraph& graph);

      void _initSortedChangesWithArcDeletions_(const DiGraph& graph);

      void _initSortedChangesWithArcReversals_(const DiGraph& graph);

      void _initSortedChangesWithArcTriangleDeletions_(const DiGraph& graph);
 

      void _applyArcAddition_(const ArcAddition& change, bool update_contraints);

      void _applyArcDeletion_(const ArcDeletion& change, bool update_contraints);

      void _applyArcReversal_(const ArcReversal& change, bool update_contraints);

      void _applyArcTriangleDeletion1_(const ArcTriangleDeletion1& change, bool update_contraints);

      void _applyArcTriangleDeletion2_(const ArcTriangleDeletion2& change, bool update_contraints);
    };
 
  } /* namespace learning */
 
} /* namespace gum */

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