localSearchWithTabuList_tpl.h

Go to the documentation of this file.

/**
 *
 *   Copyright (c) 2005-2021 by Pierre-Henri WUILLEMIN(@LIP6) & Christophe GONZALES(@AMU)
 *   info_at_agrum_dot_org
 *
 *  This library is free software: you can redistribute it and/or modify
 *  it under the terms of 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.
 *
 *  This library 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


/** @file
 * @brief The local search with tabu list learning algorithm (for directed
 *graphs)
 *
 * @author Christophe GONZALES(@AMU) and Pierre-Henri WUILLEMIN(@LIP6)
 */

#include <agrum/BN/learning/paramUtils/DAG2BNLearner.h>
#include <agrum/BN/learning/structureUtils/graphChange.h>

namespace gum {

  namespace learning {

    /// learns the structure of a Bayes net
    template < typename GRAPH_CHANGES_SELECTOR >
    DAG LocalSearchWithTabuList::learnStructure(GRAPH_CHANGES_SELECTOR& selector, DAG dag) {
      selector.setGraph(dag);

      unsigned int nb_changes_applied                 = 0;
      Idx          applied_change_with_positive_score = 0;
      Idx          current_N                          = 0;

      initApproximationScheme();

      // a vector that indicates which queues have valid scores, i.e., scores
      // that were not invalidated by previously applied changes
      std::vector< bool > impacted_queues(dag.size(), false);

      // the best dag found so far with its score
      DAG    best_dag      = dag;
      double best_score    = 0;
      double current_score = 0;
      double delta_score   = 0;

      do {
        applied_change_with_positive_score = 0;
        delta_score                        = 0;

        std::vector< std::pair< NodeId, double > > ordered_queues
           = selector.nodesSortedByBestScore();

        for (Idx j = 0; j < dag.size(); ++j) {
          NodeId i = ordered_queues[j].first;

          if (!selector.empty(i) && (!nb_changes_applied || (selector.bestScore(i) > 0))) {
            // pick up the best change
            const GraphChange& change = selector.bestChange(i);

            // perform the change
            switch (change.type()) {
              case GraphChangeType::ARC_ADDITION:
                if (!impacted_queues[change.node2()] && selector.isChangeValid(change)) {
                  if (selector.bestScore(i) > 0) {
                    ++applied_change_with_positive_score;
                  } else if (current_score > best_score) {
                    best_score = current_score;
                    best_dag   = dag;
                  }

                  // std::cout << "apply arc addition " << change.node1()
                  //           << " -> " << change.node2()
                  //           << "  delta = " << selector.bestScore( i )
                  //           << std::endl;

                  delta_score += selector.bestScore(i);
                  current_score += selector.bestScore(i);
                  dag.addArc(change.node1(), change.node2());
                  impacted_queues[change.node2()] = true;
                  selector.applyChangeWithoutScoreUpdate(change);
                  ++nb_changes_applied;
                }

                break;

              case GraphChangeType::ARC_DELETION:
                if (!impacted_queues[change.node2()] && selector.isChangeValid(change)) {
                  if (selector.bestScore(i) > 0) {
                    ++applied_change_with_positive_score;
                  } else if (current_score > best_score) {
                    best_score = current_score;
                    best_dag   = dag;
                  }

                  // std::cout << "apply arc deletion " << change.node1()
                  //           << " -> " << change.node2()
                  //           << "  delta = " << selector.bestScore( i )
                  //           << std::endl;

                  delta_score += selector.bestScore(i);
                  current_score += selector.bestScore(i);
                  dag.eraseArc(Arc(change.node1(), change.node2()));
                  impacted_queues[change.node2()] = true;
                  selector.applyChangeWithoutScoreUpdate(change);
                  ++nb_changes_applied;
                }

                break;

              case GraphChangeType::ARC_REVERSAL:
                if ((!impacted_queues[change.node1()]) && (!impacted_queues[change.node2()])
                    && selector.isChangeValid(change)) {
                  if (selector.bestScore(i) > 0) {
                    ++applied_change_with_positive_score;
                  } else if (current_score > best_score) {
                    best_score = current_score;
                    best_dag   = dag;
                  }

                  // std::cout << "apply arc reversal " << change.node1()
                  //           << " -> " << change.node2()
                  //           << "  delta = " << selector.bestScore( i )
                  //           << std::endl;

                  delta_score += selector.bestScore(i);
                  current_score += selector.bestScore(i);
                  dag.eraseArc(Arc(change.node1(), change.node2()));
                  dag.addArc(change.node2(), change.node1());
                  impacted_queues[change.node1()] = true;
                  impacted_queues[change.node2()] = true;
                  selector.applyChangeWithoutScoreUpdate(change);
                  ++nb_changes_applied;
                }

                break;

              default:
                GUM_ERROR(OperationNotAllowed,
                          "edge modifications are not "
                          "supported by local search");
            }

            break;
          }
        }

        selector.updateScoresAfterAppliedChanges();

        // reset the impacted queue and applied changes structures
        for (auto iter = impacted_queues.begin(); iter != impacted_queues.end(); ++iter) {
          *iter = false;
        }

        updateApproximationScheme(nb_changes_applied);

        // update current_N
        if (applied_change_with_positive_score) {
          current_N          = 0;
          nb_changes_applied = 0;
        } else {
          ++current_N;
        }

        // std::cout << "current N = " << current_N << std::endl;
      } while ((current_N <= _MaxNbDecreasing_) && continueApproximationScheme(delta_score));

      stopApproximationScheme();   // just to be sure of the
                                   // approximationScheme has
                                   // been notified of the end of looop

      if (current_score > best_score) {
        return dag;
      } else {
        return best_dag;
      }
    }

    /// learns the structure and the parameters of a BN
    template < typename GUM_SCALAR, typename GRAPH_CHANGES_SELECTOR, typename PARAM_ESTIMATOR >
    BayesNet< GUM_SCALAR > LocalSearchWithTabuList::learnBN(GRAPH_CHANGES_SELECTOR& selector,
                                                            PARAM_ESTIMATOR&        estimator,
                                                            DAG                     initial_dag) {
      return DAG2BNLearner<>::createBN< GUM_SCALAR >(estimator,
                                                     learnStructure(selector, initial_dag));
    }

  } /* namespace learning */

} /* namespace gum */