scheduler.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_SCHEDULER_H
#define GUM_SCHEDULER_H
 
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/threads/threadNumberManager.h>
#include <agrum/base/graphicalModels/inference/scheduler/schedule.h>
 
namespace gum {

  enum SchedulerType {
    SEQUENTIAL,          // fully sequential scheduler
    PARALLEL_OPERATORS   // combinations and projections are dispatched among threads
  };

  class Scheduler: public ThreadNumberManager {
    public:
    // ############################################################################
    // ############################################################################


    Scheduler(Size nb_threads = 0, double max_megabyte_memory = 0.0);

    [[nodiscard]] virtual Scheduler* clone() const = 0;

    ~Scheduler() override;

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


    virtual void setMaxMemory(double megabytes);


    virtual double maxMemory() const;

    virtual void execute(Schedule&) = 0;

    virtual double nbOperations(const Schedule&) = 0;


    virtual std::pair< double, double > memoryUsage(const Schedule&) = 0;

 
 
    protected:
    double _max_memory{0.0};
 

    Scheduler(const Scheduler& from);

    Scheduler(Scheduler&& from);

    Scheduler& operator=(const Scheduler& from);

    Scheduler& operator=(Scheduler&& from);
  };
 
} /* namespace gum */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/inference/scheduler/scheduler_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_SCHEDULER_H */