mddOperatorStrategy_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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
 

 
// =========================================================================
#include <algorithm>
#include <queue>
#include <thread>
#include <utility>
#include <vector>
// =========================================================================
#include <agrum/base/core/functors.h>
 
#include <agrum/base/core/math/math_utils.h>
// =========================================================================
#include <agrum/base/multidim/tensor.h>
#include <agrum/base/multidim/utils/FunctionGraphUtilities/operators/multiDimFunctionGraphOperator.h>
#include <agrum/base/multidim/utils/FunctionGraphUtilities/operators/regress.h>
// =========================================================================
#include <agrum/FMDP/planning/mddOperatorStrategy.h>
// =========================================================================

#define RECAST(x) reinterpret_cast< const MultiDimFunctionGraph< GUM_ELEMENT >* >(x)
 
namespace gum {
 
 
  /* **************************************************************************************************
   * **/
  /* ** **/
  /* **                                Constructors / Destructors **/
  /* ** **/
  /* **************************************************************************************************
   * **/
 
  // ===========================================================================
  // Default constructor
  // ===========================================================================
  template < typename GUM_ELEMENT >
  MDDOperatorStrategy< GUM_ELEMENT >::MDDOperatorStrategy() {
    GUM_CONSTRUCTOR(MDDOperatorStrategy);
  }
 
  // ===========================================================================
  // Default destructor
  // ===========================================================================
  template < typename GUM_ELEMENT >
  MDDOperatorStrategy< GUM_ELEMENT >::~MDDOperatorStrategy() {
    GUM_DESTRUCTOR(MDDOperatorStrategy);
  }
 
  /* **************************************************************************************************
   * **/
  /* ** **/
  /* **                             Graph Function Operations Methods **/
  /* ** **/
  /* **************************************************************************************************
   * **/
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT >*
      MDDOperatorStrategy< GUM_ELEMENT >::regress(const MultiDimFunctionGraph< GUM_ELEMENT >* Vold,
                                                  Idx                        actionId,
                                                  const FMDP< GUM_ELEMENT >* fmdp,
                                                  const gum::VariableSet&    elVarSeq) {
    MultiDimFunctionGraph< GUM_ELEMENT >* qAction
        = MultiDimFunctionGraph< GUM_ELEMENT >::getReducedAndOrderedInstance();
    qAction->copy(*Vold);
 
    const DiscreteVariable* xip = this->lastVar_(qAction);
 
    while (this->shouldEleminateVar_(xip, fmdp)) {
      const MultiDimFunctionGraph< GUM_ELEMENT >* pxi
          = RECAST(fmdp->transition(actionId, fmdp->mapMainPrime().first(xip)));
      Regress< GUM_ELEMENT, std::multiplies, std::plus > r(qAction,
                                                           pxi,
                                                           &elVarSeq,
                                                           xip,
                                                           (GUM_ELEMENT)0);
      MultiDimFunctionGraph< GUM_ELEMENT >*              temp = r.compute();
      delete qAction;
      qAction = temp;
      xip     = this->lastVar_(qAction);
    }
 
    return qAction;
  }
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT >*
      MDDOperatorStrategy< GUM_ELEMENT >::maximize(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                                                   const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                                                   Idx del) {
    MultiDimFunctionGraph< GUM_ELEMENT >* ret = maximize2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT >*
      MDDOperatorStrategy< GUM_ELEMENT >::minimize(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                                                   const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                                                   Idx del) {
    MultiDimFunctionGraph< GUM_ELEMENT >* ret = minimize2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT >*
      MDDOperatorStrategy< GUM_ELEMENT >::multiply(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                                                   const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                                                   Idx del) {
    MultiDimFunctionGraph< GUM_ELEMENT >* ret = multiply2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >*
      MDDOperatorStrategy< GUM_ELEMENT >::argmaximize(
          const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* f1,
          const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* f2,
          Idx del) {
    MultiDimFunctionGraphOperator< ArgMaxSet< GUM_ELEMENT, Idx >,
                                   ArgumentMaximisesAction,
                                   SetTerminalNodePolicy >
        argmaxope(f1, f2);
    MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* ret
        = argmaxope.compute();
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT >*
      MDDOperatorStrategy< GUM_ELEMENT >::add(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                                              const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                                              Idx                                         del) {
    MultiDimFunctionGraph< GUM_ELEMENT >* ret = add2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }
 
  // ==========================================================================
  // ==========================================================================
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT >*
      MDDOperatorStrategy< GUM_ELEMENT >::subtract(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                                                   const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                                                   Idx del) {
    MultiDimFunctionGraph< GUM_ELEMENT >* ret = subtract2MultiDimFunctionGraphs(f1, f2);
    this->deleteFunctionGraph_(f1, f2, del);
    return ret;
  }
 
  template < typename GUM_ELEMENT >
  bool MDDOperatorStrategy< GUM_ELEMENT >::shouldEleminateVar_(const DiscreteVariable*    v,
                                                               const FMDP< GUM_ELEMENT >* fmdp) {
    return v == nullptr ? false : fmdp->mapMainPrime().existsSecond(v);
  }
 
  template < typename GUM_ELEMENT >
  const DiscreteVariable* MDDOperatorStrategy< GUM_ELEMENT >::lastVar_(
      const MultiDimFunctionGraph< GUM_ELEMENT >* function) {
    return function->variablesSequence().size() == 0
             ? nullptr
             : function->variablesSequence().atPos(function->variablesSequence().size() - 1);
  }
 
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >*
      MDDOperatorStrategy< GUM_ELEMENT >::getFunctionInstance() {
    return MultiDimFunctionGraph< GUM_ELEMENT >::getReducedAndOrderedInstance();
  }
 
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >*
      MDDOperatorStrategy< GUM_ELEMENT >::getArgMaxFunctionInstance() {
    return MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >,
                                  SetTerminalNodePolicy >::getReducedAndOrderedInstance();
  }
 
  template < typename GUM_ELEMENT >
  MultiDimFunctionGraph< ActionSet, SetTerminalNodePolicy >*
      MDDOperatorStrategy< GUM_ELEMENT >::getAggregatorInstance() {
    return MultiDimFunctionGraph< ActionSet,
                                  SetTerminalNodePolicy >::getReducedAndOrderedInstance();
  }
 
}   // end of namespace gum