schedule.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_SCHEDULE_H
#define GUM_SCHEDULE_H
 
#include <atomic>
#include <memory>
#include <sstream>
#include <string>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/graphicalModels/inference/scheduler/scheduleBinaryCombination.h>
#include <agrum/base/graphicalModels/inference/scheduler/scheduleDeletion.h>
#include <agrum/base/graphicalModels/inference/scheduler/scheduleProjection.h>
#include <agrum/base/graphicalModels/inference/scheduler/scheduleStorage.h>
#include <agrum/base/graphs/DAG.h>
 
namespace gum {

  class Schedule {
    public:
    // ############################################################################
    // ############################################################################

    explicit Schedule(const Size nb_ops = 256);

    Schedule(const Schedule& from);

    Schedule(Schedule&& from);

    virtual Schedule* clone() const;

    virtual ~Schedule();

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


    Schedule& operator=(const Schedule&);

    Schedule& operator=(Schedule&&);

    bool operator==(const Schedule&) const;

    bool operator!=(const Schedule&) const;

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

    template < typename TABLE >
    const IScheduleMultiDim* insertTable(const TABLE& table, const bool copy, const Idx id = 0);

    const IScheduleMultiDim* insertScheduleMultiDim(const IScheduleMultiDim& multidim);

    void emplaceScheduleMultiDim(const IScheduleMultiDim& multidim);


    const ScheduleOperator& insertOperation(const ScheduleOperator& op,
                                            const bool              are_results_persistent = false);


    template < typename TABLE1, typename TABLE2, typename TABLE_RES >
    const ScheduleOperator& emplaceBinaryCombination(const ScheduleMultiDim< TABLE1 >& table1,
                                                     const ScheduleMultiDim< TABLE2 >& table2,
                                                     TABLE_RES (*combine)(const TABLE1&,
                                                                          const TABLE2&),
                                                     const bool is_result_persistent = false);


    template < typename TABLE >
    const ScheduleOperator& emplaceProjection(const ScheduleMultiDim< TABLE >& table,
                                              const gum::VariableSet&          del_vars,
                                              TABLE (*project)(const TABLE&,
                                                               const gum::VariableSet&),
                                              const bool is_result_persistent = false);


    template < typename TABLE >
    const ScheduleOperator& emplaceDeletion(const ScheduleMultiDim< TABLE >& table);


    template < typename TABLE, template < typename... > class CONTAINER >
    const ScheduleOperator& emplaceStorage(const IScheduleMultiDim& table,
                                           CONTAINER< TABLE >&      container);


    const DAG& dag() const;


    const ScheduleOperator& operation(const NodeId id) const;


    NodeId nodeId(const ScheduleOperator&) const;

    NodeSet availableOperations() const;


    void updateAfterExecution(const NodeId           exec_node,
                              std::vector< NodeId >& new_available_nodes,
                              const bool             check = false);


    void updateAfterExecution(const ScheduleOperator& exec_op,
                              std::vector< NodeId >&  new_available_nodes,
                              const bool              check = false);

    const IScheduleMultiDim* scheduleMultiDim(const NodeId id) const;

    bool existsScheduleMultiDim(const NodeId id) const;

    NodeId scheduleMultiDimId(const IScheduleMultiDim* multidim) const;


    const ScheduleOperator* scheduleMultiDimCreator(const NodeId id) const;


    const ScheduleOperator* scheduleMultiDimCreator(const IScheduleMultiDim* multidim) const;

    Idx versionNumber() const;

    void clear();

 
 
    private:

    DAG _dag_;

    NodeId _newId_{NodeId(0)};

    Bijection< NodeId, ScheduleOperator* > _node2op_;


    HashTable< const IScheduleMultiDim*, std::pair< ScheduleOperator*, Idx > > _multidim_location_;

    Bijection< const IScheduleMultiDim*, Idx > _multidim2id_;

    Set< const IScheduleMultiDim* > _emplaced_multidims_;

    HashTable< const IScheduleMultiDim*, NodeSet > _multidim2nodes_;

    Bijection< const IScheduleMultiDim*, NodeId > _deleted_multidim2node_;


    Idx _version_number_;


    void _copy_(const Schedule& from);

    void _destroy_();

    DAG _fullDAG_() const;

    static std::string _paramString_(Idx i);

    static Idx _newVersionNumber_();
 
    // the version numbers help to identify the changes in schedules
    static std::atomic< Idx > _overall_version_number_;
  };
 
} /* namespace gum */
 
// always include the template implementation
#include <agrum/base/graphicalModels/inference/scheduler/schedule_tpl.h>
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/inference/scheduler/schedule_inl.h>
#endif /* GUM_NO_INLINE */
 
 
#endif /* GUM_SCHEDULE_H */