scheduleOperator.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_OPERATOR_H
#define GUM_SCHEDULE_OPERATOR_H
 
#include <memory>
#include <string>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/inference/scheduler/IScheduleMultiDim.h>
 
namespace gum {
 


  enum class ScheduleOperatorType : char {
    COMBINE_MULTIDIM,
    PROJECT_MULTIDIM,
    DELETE_MULTIDIM,
    STORE_MULTIDIM
  };

  class ScheduleOperator {
    public:
    // ############################################################################
    // ############################################################################


    explicit ScheduleOperator(const ScheduleOperatorType type,
                              const bool                 imply_deletion,
                              const bool                 are_results_persistent);

    virtual ScheduleOperator* clone() const = 0;


    virtual ~ScheduleOperator();

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


    virtual bool operator==(const ScheduleOperator&) const;


    virtual bool operator!=(const ScheduleOperator&) const;

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

    virtual bool hasSameArguments(const ScheduleOperator&) const = 0;

    virtual bool hasSimilarArguments(const ScheduleOperator&) const = 0;

    virtual bool isSameOperator(const ScheduleOperator&) const;

    ScheduleOperatorType type() const;

    bool implyDeletion() const;

    virtual void execute() = 0;

    virtual bool isExecuted() const = 0;


    virtual void undo() = 0;


    virtual void updateArgs(const Sequence< const IScheduleMultiDim* >& new_args) = 0;

    virtual const Sequence< const IScheduleMultiDim* >& args() const = 0;


    virtual const Sequence< const IScheduleMultiDim* >& results() const = 0;


    void makeResultsPersistent(const bool is_persistent);

    bool hasPersistentResults() const;

    virtual double nbOperations() const = 0;


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

    virtual std::string toString() const = 0;

 
    protected:
    ScheduleOperator(const ScheduleOperator& from);

    ScheduleOperator(ScheduleOperator&& from);


    ScheduleOperator& operator=(const ScheduleOperator& from);


    ScheduleOperator& operator=(ScheduleOperator&& from);
 
 
    private:
    ScheduleOperatorType _op_type_;

    bool _imply_deletion_;

    bool _result_persistent_;
  };
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/inference/scheduler/scheduleOperator_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_SCHEDULE_OPERATOR_H */