schedulerSequential.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_SEQUENTIAL_H
#define GUM_SCHEDULER_SEQUENTIAL_H
 
#include <algorithm>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/inference/scheduler/scheduler.h>
 
namespace gum {
 
  class SchedulerSequential: public Scheduler {
    public:
    // ############################################################################
    // ############################################################################

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

    SchedulerSequential(const SchedulerSequential& from);

    SchedulerSequential(SchedulerSequential&& from);

    SchedulerSequential* clone() const final;

    virtual ~SchedulerSequential();

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


    void setMaxMemory(double megabytes) final;

    void execute(Schedule&) final;

    double nbOperations(const Schedule&) final;


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

 
 
    private:
    Schedule* _schedule_{nullptr};

    std::vector< NodeId > _operations_;

    std::pair< double, double > _memory_usage_{0.0, 0.0};

    bool _operations_up_to_date_{false};

    struct UnexecutedOperation {
      double max_memory_usage;
      double end_memory_usage;
      NodeId node;
    };

    void _setSchedule_(const Schedule& schedule);

    Size _addExecutableOps_(std::vector< UnexecutedOperation >& unexecuted_deletions,
                            std::vector< UnexecutedOperation >& unexecuted_operations,
                            bool&                               unexecuted_deletions_sorted,
                            bool&                               unexecuted_operations_sorted,
                            double                              memory_used,
                            double                              max_memory,
                            List< NodeId >&                     available_nodes) const;

    void _simulateDAGUpdate_(DAG&                   dag,
                             const NodeId           node,
                             std::vector< NodeId >& new_available_nodes) const;

    void _simulateExecuteOneOperation_(const NodeId           node,
                                       ScheduleOperator&      op,
                                       DAG&                   dag,
                                       List< NodeId >&        available_nodes,
                                       std::vector< NodeId >& new_available_nodes);

    void _simulateExecution_();

    static bool _cmp_(const UnexecutedOperation& a, const UnexecutedOperation& b);

    // template<typename ITER, typename CMP>
    // friend void std::sort(ITER, ITER, CMP);
  };
 
} /* namespace gum */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/inference/scheduler/schedulerSequential_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_SCHEDULER_SEQUENTIAL_H */