fmdp.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_FACTORED_MARKOV_DECISION_PROCESS_H
#define GUM_FACTORED_MARKOV_DECISION_PROCESS_H
//======================================================================
#include <string>
#include <vector>
 
#include <string_view>
//======================================================================
//======================================================================
#include <agrum/base/multidim/implementations/multiDimFunctionGraph.h>
 
//======================================================================
 
namespace gum {
 
  template < typename GUM_ELEMENT >
  class FMDP {
    template < typename GUM_ELEMENT_O >
    using VarTransitionTable
        = HashTable< const DiscreteVariable*, const MultiDimImplementation< GUM_ELEMENT_O >* >;
 
    public:
    // ===========================================================================
    // ===========================================================================

    FMDP(bool onDestructionDeleteVar = false);

    ~FMDP();

 
    // ===========================================================================
    // ===========================================================================

    void addVariable(const DiscreteVariable* var);

    SequenceIteratorSafe< const DiscreteVariable* > beginVariables() const;

    SequenceIteratorSafe< const DiscreteVariable* > endVariables() const;

    const DiscreteVariable* main2prime(const DiscreteVariable* mainVar) const;

    const Bijection< const DiscreteVariable*, const DiscreteVariable* >& mapMainPrime() const;

 
    // ===========================================================================
    // ===========================================================================

    void addAction(Idx actionId, std::string_view action);

    SequenceIteratorSafe< Idx > beginActions() const;

    SequenceIteratorSafe< Idx > endActions() const;

 
    // ===========================================================================
    // ===========================================================================

    void addTransitionForAction(Idx                                          actionId,
                                const DiscreteVariable*                      var,
                                const MultiDimImplementation< GUM_ELEMENT >* transition);

    void addTransition(const DiscreteVariable*                      var,
                       const MultiDimImplementation< GUM_ELEMENT >* transition);

    const MultiDimImplementation< GUM_ELEMENT >* transition(Idx                     actionId,
                                                            const DiscreteVariable* v) const;

 
    // ===========================================================================
    // ===========================================================================

    void addCostForAction(Idx actionId, const MultiDimImplementation< GUM_ELEMENT >* cost);

    void addCost(const MultiDimImplementation< GUM_ELEMENT >* cost);

    const MultiDimImplementation< GUM_ELEMENT >* cost(Idx actionId = 0) const;

 
    // ===========================================================================
    // ===========================================================================

    void addRewardForAction(Idx actionId, const MultiDimImplementation< GUM_ELEMENT >* reward);

    void addReward(const MultiDimImplementation< GUM_ELEMENT >* reward);

    const MultiDimImplementation< GUM_ELEMENT >* reward(Idx actionId = 0) const;

 
    // ===========================================================================
    // ===========================================================================

    const std::string& actionName(Idx actionId) const;

    Idx actionId(std::string_view) const;

    std::string toString() const;

    Size size() const;

    void setDeleteVariablesOnDestruction(bool b);

    void setDiscount(GUM_ELEMENT discount);

    GUM_ELEMENT discount() const;

 
    private:
    Sequence< const DiscreteVariable* > _varSeq_;
 
    Sequence< Idx > _actionSeq_;

    Bijection< const DiscreteVariable*, const DiscreteVariable* > _main2primed_;

    Bijection< Idx, const std::string* > _actionMap_;

    HashTable< Idx, VarTransitionTable< GUM_ELEMENT >* > _actionTransitionTable_;

    HashTable< Idx, const MultiDimImplementation< GUM_ELEMENT >* > _actionCostTable_;

    HashTable< Idx, const MultiDimImplementation< GUM_ELEMENT >* > _actionRewardTable_;

    bool _onDestructionDeleteVars_;
 
    GUM_ELEMENT _discount_{GUM_ELEMENT(1)};
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class FMDP< double >;
#endif
 
 
} /* namespace gum */
 
#include <agrum/FMDP/fmdp_tpl.h>
 
#endif   // GUM_FACTORED_MARKOV_DECISION_PROCESS_H