schedulerParallel.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_SCHEDULER_PARALLEL_H
#define GUM_SCHEDULER_PARALLEL_H
 
#include <algorithm>
#include <atomic>
#include <chrono>
#include <memory>
#include <mutex>
#include <thread>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/priorityQueue.h>
#include <agrum/base/core/threads/threadExecutor.h>
#include <agrum/base/graphicalModels/inference/scheduler/schedulerSequential.h>
 
#include <condition_variable>
 
namespace gum {

  class SchedulerParallel: public Scheduler {
    public:
    // ############################################################################
    // ############################################################################

    explicit SchedulerParallel(Size max_nb_threads = 0, double max_megabyte_memory = 0.0);

    SchedulerParallel(const SchedulerParallel& from);

    SchedulerParallel(SchedulerParallel&& from);

    SchedulerParallel* clone() const final;

    virtual ~SchedulerParallel();

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


    void setNumberOfThreads(Size nb) final;


    void setMaxMemory(double megabytes) final;

    void execute(Schedule&) final;

    double nbOperations(const Schedule&) final;


    std::pair< double, double > memoryUsage(const Schedule&) final;

 
 
    private:
    SchedulerSequential _sequential_scheduler_;
  };
 
} /* namespace gum */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/inference/scheduler/schedulerParallel_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_SCHEDULER_PARALLEL_H */