IOperatorStrategy.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                           *
 *                                                                          *
 ****************************************************************************/
 

 
 
// =========================================================================
#ifndef GUM_SDYNA_OPERATOR_STRATEGY_H
#define GUM_SDYNA_OPERATOR_STRATEGY_H
// =========================================================================
// =========================================================================
#include <agrum/FMDP/planning/actionSet.h>
 
// =========================================================================
// =========================================================================
 
namespace gum {

  template < typename GUM_ELEMENT >
  class IOperatorStrategy {
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    virtual ~IOperatorStrategy() = default;

 
 
    // ###################################################################
    // ###################################################################
 
    virtual MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >* getFunctionInstance()
        = 0;
    virtual MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >*
        getArgMaxFunctionInstance()                                                            = 0;
    virtual MultiDimFunctionGraph< ActionSet, SetTerminalNodePolicy >* getAggregatorInstance() = 0;

 
 
    // ###################################################################
    // ###################################################################
 
    public:
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< GUM_ELEMENT >*
        regress(const MultiDimFunctionGraph< GUM_ELEMENT >* Vold,
                Idx                                         actionId,
                const FMDP< GUM_ELEMENT >*                  fmdp,
                const gum::VariableSet&                     elVarSeq) = 0;
 
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< GUM_ELEMENT >*
        maximize(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                 const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                 Idx                                         del = 3) = 0;
 
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< GUM_ELEMENT >*
        minimize(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                 const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                 Idx                                         del = 3) = 0;
 
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< GUM_ELEMENT >*
        multiply(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                 const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                 Idx                                         del = 3) = 0;
 
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >*
        argmaximize(
            const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* f1,
            const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* f2,
            Idx del = 3) = 0;
 
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< GUM_ELEMENT >*
        add(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
            const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
            Idx                                         del = 1) = 0;
 
    // ==========================================================================
    // ==========================================================================
    virtual MultiDimFunctionGraph< GUM_ELEMENT >*
        subtract(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                 const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                 Idx                                         del = 0) = 0;
 

 
    protected:
    void deleteFunctionGraph_(const MultiDimFunctionGraph< GUM_ELEMENT >* f1,
                              const MultiDimFunctionGraph< GUM_ELEMENT >* f2,
                              Idx                                         del);
 
    void deleteFunctionGraph_(
        const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* f1,
        const MultiDimFunctionGraph< ArgMaxSet< GUM_ELEMENT, Idx >, SetTerminalNodePolicy >* f2,
        Idx                                                                                  del);
  };
}   // namespace gum
 
#include <agrum/FMDP/planning/IOperatorStrategy_tpl.h>
#endif   // GUM_SDYNA_OPERATOR_STRATEGY_H