scheduleOperation.h

Go to the documentation of this file.

#ifndef GUM_SCHEDULE_OPERATION_H
#define GUM_SCHEDULE_OPERATION_H

#include <string>
#include <utility>

#include <agrum/agrum.h>

#include <agrum/core/sequence.h>
#include <agrum/graphicalModels/inference/scheduleMultiDim.h>

namespace gum {

  template < typename GUM_SCALAR >
  class ScheduleOperation {
    public:
    enum class Type : char {
      COMBINE_MULTIDIM,
      PROJECT_MULTIDIM,
      DELETE_MULTIDIM,
      CLIQUE_STORE_MULTIDIM,
      SEPARATOR_STORE_MULTIDIM
    };

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

    virtual ScheduleOperation< GUM_SCALAR >* newFactory() const = 0;

    virtual ~ScheduleOperation();


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


    virtual bool operator==(const ScheduleOperation< GUM_SCALAR >&) const = 0;


    virtual bool operator!=(const ScheduleOperation< GUM_SCALAR >&) const = 0;


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

    Type type() const;

    Idx id() const;

    virtual const Sequence< const ScheduleMultiDim< GUM_SCALAR >* >&
       multiDimArgs() const = 0;

    virtual const Sequence< const ScheduleMultiDim< GUM_SCALAR >* >&
       multiDimResults() const = 0;

    virtual void execute() = 0;

    virtual float nbOperations() const = 0;


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

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


    protected:
    explicit ScheduleOperation(Type t);

    ScheduleOperation(const ScheduleOperation< GUM_SCALAR >& from);

    ScheduleOperation< GUM_SCALAR >&
       operator=(const ScheduleOperation< GUM_SCALAR >&);

    private:
    Type __type;

    Idx __id;

    static Idx __newId();
  };

} /* namespace gum */

// always include the template implementation
#include <agrum/graphicalModels/inference/scheduleOperation_tpl.h>

#endif /* GUM_SCHEDULE_OPERATION_H */