scheduleStorage_tpl.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                           *
 *                                                                          *
 ****************************************************************************/
#pragma once
 

 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <agrum/agrum.h>
 
#  include <agrum/base/graphicalModels/inference/scheduler/scheduleStorage.h>
 
namespace gum {
 
  namespace ScheduleStorageMethod {
 
    // storing tables into a Set<Table*>
    template < typename TABLE >
    INLINE void Execution< TABLE, TABLE*, Set >::execute(TABLE& table, Set< TABLE* >& container) {
      container.insert(&table);
    }
 
    // storing tables into a vector<Table>
    template < typename TABLE >
    INLINE void Execution< TABLE, TABLE, std::vector >::execute(TABLE&                table,
                                                                std::vector< TABLE >& container) {
      container.push_back(std::move(table));
    }
 
  }   // namespace ScheduleStorageMethod

  template < typename TABLE, template < typename... > class CONTAINER >
  ScheduleStorage< TABLE, CONTAINER >::ScheduleStorage(const IScheduleMultiDim& table,
                                                       CONTAINER< TABLE >&      container) :
      ScheduleOperator(ScheduleOperatorType::STORE_MULTIDIM, true, false), _container_(&container) {
    // checks that table is a ScheduleMultiDim<T>, where either TABLE=T or
    // TABLE = T*. If this is not the case, then we won't be able to perform the
    // operator, hence we should raise an exception now, i.e., before performing
    // all the computations within the schedule
    try {
      _arg_ = dynamic_cast< ScheduleMultiDim< SCHED_TABLE >* >(
          const_cast< IScheduleMultiDim* >(&table));
    } catch (std::bad_cast&) {
      GUM_ERROR(TypeError,
                "The ScheduleMultiDim cannot be stored in the container "
                "because their types are incompatible.");
    }
 
    // save the arg into _args_ (no need to update _results_)
    _args_ << _arg_;
 
    // for debugging purposes
    GUM_CONSTRUCTOR(ScheduleStorage);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  ScheduleStorage< TABLE, CONTAINER >::ScheduleStorage(
      const ScheduleStorage< TABLE, CONTAINER >& from) :
      ScheduleOperator(from), _arg_(from._arg_), _container_(from._container_),
      _is_executed_(from._is_executed_) {
    // save the arg into _args_ (no need to update _results_)
    _args_ << _arg_;
 
    // for debugging purposes
    GUM_CONS_CPY(ScheduleStorage);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  ScheduleStorage< TABLE, CONTAINER >::ScheduleStorage(ScheduleStorage< TABLE, CONTAINER >&& from) :
      ScheduleOperator(std::move(from)), _arg_(from._arg_), _container_(from._container_),
      _is_executed_(from._is_executed_) {
    // save the arg into _args_ (no need to update _results_)
    _args_ << _arg_;
 
    // for debugging purposes
    GUM_CONS_MOV(ScheduleStorage);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE ScheduleStorage< TABLE, CONTAINER >* ScheduleStorage< TABLE, CONTAINER >::clone() const {
    return new ScheduleStorage< TABLE, CONTAINER >(*this);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  ScheduleStorage< TABLE, CONTAINER >::~ScheduleStorage() {
    // for debugging purposes
    GUM_DESTRUCTOR(ScheduleStorage);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  ScheduleStorage< TABLE, CONTAINER >& ScheduleStorage< TABLE, CONTAINER >::operator=(
      const ScheduleStorage< TABLE, CONTAINER >& from) {
    if (this != &from) {
      _arg_ = from._arg_;
      _args_.clear();
      _args_ << _arg_;
      _container_   = from._container_;
      _is_executed_ = from._is_executed_;
      ScheduleOperator::operator=(from);
    }
    return *this;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  ScheduleStorage< TABLE, CONTAINER >&
      ScheduleStorage< TABLE, CONTAINER >::operator=(ScheduleStorage< TABLE, CONTAINER >&& from) {
    if (this != &from) {
      _arg_ = from._arg_;
      _args_.clear();
      _args_ << _arg_;
      _container_   = from._container_;
      _is_executed_ = from._is_executed_;
      ScheduleOperator::operator=(std::move(from));
    }
    return *this;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::operator==(
      const ScheduleStorage< TABLE, CONTAINER >& op) const {
    return (_container_ == op._container_) && (*_arg_ == *op._arg_);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  bool ScheduleStorage< TABLE, CONTAINER >::operator==(const ScheduleOperator& op) const {
    try {
      const ScheduleStorage< TABLE, CONTAINER >& real_op
          = dynamic_cast< const ScheduleStorage< TABLE, CONTAINER >& >(op);
      return ScheduleStorage< TABLE, CONTAINER >::operator==(real_op);
    } catch (std::bad_cast&) { return false; }
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::operator!=(
      const ScheduleStorage< TABLE, CONTAINER >& op) const {
    return !ScheduleStorage< TABLE, CONTAINER >::operator==(op);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::operator!=(const ScheduleOperator& op) const {
    return !ScheduleStorage< TABLE, CONTAINER >::operator==(op);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::hasSimilarArguments(
      const ScheduleStorage< TABLE, CONTAINER >& op) const {
    return _arg_->hasSameVariables(*op._arg_);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  bool ScheduleStorage< TABLE, CONTAINER >::hasSimilarArguments(const ScheduleOperator& op) const {
    try {
      const ScheduleStorage< TABLE, CONTAINER >& real_op
          = dynamic_cast< const ScheduleStorage< TABLE, CONTAINER >& >(op);
      return ScheduleStorage< TABLE, CONTAINER >::hasSimilarArguments(real_op);
    } catch (std::bad_cast&) { return false; }
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::hasSameArguments(
      const ScheduleStorage< TABLE, CONTAINER >& op) const {
    return (_container_ == op._container_) && _arg_->hasSameVariables(*op._arg_)
        && _arg_->hasSameContent(*op._arg_);
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  bool ScheduleStorage< TABLE, CONTAINER >::hasSameArguments(const ScheduleOperator& op) const {
    try {
      const ScheduleStorage< TABLE, CONTAINER >& real_op
          = dynamic_cast< const ScheduleStorage< TABLE, CONTAINER >& >(op);
      return ScheduleStorage< TABLE, CONTAINER >::hasSameArguments(real_op);
    } catch (std::bad_cast&) { return false; }
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::isSameOperator(
      const ScheduleStorage< TABLE, CONTAINER >& op) const {
    return true;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  bool ScheduleStorage< TABLE, CONTAINER >::isSameOperator(const ScheduleOperator& op) const {
    try {
      const ScheduleStorage< TABLE, CONTAINER >& real_op
          = dynamic_cast< const ScheduleStorage< TABLE, CONTAINER >& >(op);
      return ScheduleStorage< TABLE, CONTAINER >::isSameOperator(real_op);
    } catch (std::bad_cast&) { return false; }
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE const ScheduleMultiDim< typename std::remove_pointer< TABLE >::type >&
               ScheduleStorage< TABLE, CONTAINER >::arg() const {
    return *_arg_;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  const Sequence< const IScheduleMultiDim* >& ScheduleStorage< TABLE, CONTAINER >::args() const {
    return _args_;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  const Sequence< const IScheduleMultiDim* >& ScheduleStorage< TABLE, CONTAINER >::results() const {
    return _results_;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  void ScheduleStorage< TABLE, CONTAINER >::execute() {
    if (_arg_->isAbstract()) {
      GUM_ERROR(NullElement,
                "It is impossible to store an abstract ScheduleMultiDim"
                "into a container.");
    }
 
    // if the container contains tables, not pointers to tables, we will move
    // directly the table contained within the ScheduleMultiDim into it, else
    // we will allocate a new table and pass this newly allocated tables to
    // the container
    if (std::is_same< SCHED_TABLE, TABLE >::value) {
      // here, the container contains tables, not pointers to tables
      if (_arg_->containsMultiDim()) {
        // here, the ScheduleMultiDim owns the table, so it can pass directly
        // its table to the container
        ScheduleStorageMethod::Execution< SCHED_TABLE, TABLE, CONTAINER >::execute(
            const_cast< SCHED_TABLE& >(_arg_->multiDim()),
            *_container_);
      } else {
        // here, the container just contains a reference on the table, hence
        // we should first copy it and this is this copy that will be inserted
        // into the container
        SCHED_TABLE table = _arg_->multiDim();
        ScheduleStorageMethod::Execution< SCHED_TABLE, TABLE, CONTAINER >::execute(table,
                                                                                   *_container_);
      }
    } else {
      // here, the container contains pointers to tables. So we should first
      // allocate the table that will be stored into the container
      SCHED_TABLE* table;
 
      // if the ScheduleMultiDim owns the table, we just have to initialize
      // it by moving the ScheduleMultiDim's table, else we should copy it
      if (_arg_->containsMultiDim()) {
        table = new SCHED_TABLE(std::move(const_cast< SCHED_TABLE& >(_arg_->multiDim())));
      } else {
        table = new SCHED_TABLE(const_cast< SCHED_TABLE& >(_arg_->multiDim()));
      }
 
      ScheduleStorageMethod::Execution< SCHED_TABLE, TABLE, CONTAINER >::execute(*table,
                                                                                 *_container_);
    }
 
    // be sure that the ScheduleMultiDim becomes abstract
    _arg_->makeAbstract();
    _is_executed_ = true;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE bool ScheduleStorage< TABLE, CONTAINER >::isExecuted() const {
    return _is_executed_;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  void ScheduleStorage< TABLE, CONTAINER >::undo() {
    GUM_ERROR(OperationNotAllowed, "ScheduleStorage cannot be undone.");
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  void ScheduleStorage< TABLE, CONTAINER >::updateArgs(
      const Sequence< const IScheduleMultiDim* >& new_args) {
    // check that there is exactly one argument in new_args and that its type
    // is compatible with TABLE
    if (new_args.size() != Size(1)) {
      GUM_ERROR(SizeError,
                "Method ScheduleStorage::updateArgs expects 1 new "
                    << "argument, but " << new_args.size() << " were passed.");
    }
    ScheduleMultiDim< SCHED_TABLE >* arg;
    try {
      arg = dynamic_cast< ScheduleMultiDim< SCHED_TABLE >* >(
          const_cast< IScheduleMultiDim* >(new_args[0]));
    } catch (std::bad_cast&) {
      GUM_ERROR(TypeError,
                "The type of the argument passed to "
                    << "ScheduleStorage::updateArgs does not match what "
                    << "the ScheduleOperator expects");
    }
 
    // save the new argument
    _arg_ = (ScheduleMultiDim< SCHED_TABLE >*)arg;
    _args_.clear();
    _args_ << _arg_;
    _is_executed_ = false;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE double ScheduleStorage< TABLE, CONTAINER >::nbOperations() const {
    return 1.0;
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  INLINE std::pair< double, double > ScheduleStorage< TABLE, CONTAINER >::memoryUsage() const {
    const double size_table = double(_arg_->domainSize()) * _arg_->sizeOfContent() + sizeof(TABLE);
    return {-size_table, -size_table};
  }

  template < typename TABLE, template < typename... > class CONTAINER >
  std::string ScheduleStorage< TABLE, CONTAINER >::toString() const {
    return "store ( " + _arg_->toString() + " )";
  }
 
}   // namespace gum
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */