fmdpFactory.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_FMDP_FACTORY_H
#define GUM_FMDP_FACTORY_H
//======================================================================
#include <string>
#include <vector>
 
#include <string_view>
//======================================================================
 
#include <agrum/base/variables/labelizedVariable.h>
#include <agrum/FMDP/IfmdpFactory.h>
 
namespace gum {

 
  template < typename GUM_ELEMENT >
  class FMDPFactory: public AbstractFMDPFactory {
    public:
    // ==========================================================================
    // ==========================================================================

    FMDPFactory(FMDP< GUM_ELEMENT >* fmdp);

    ~FMDPFactory() override;

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

    FMDP< GUM_ELEMENT >* fmdp() const;

    FMDPfactory_state state() const override;

    const DiscreteVariable* variable(std::string_view name) const override;

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

    void startVariableDeclaration() override;

    void variableName(std::string_view name) override;

    void variableDescription(std::string_view desc) override;

    void addModality(std::string_view name) override;

    void endVariableDeclaration() override;

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

    void startActionDeclaration() override;

    void addAction(std::string_view action) override;

    void endActionDeclaration() override;

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

    void startTransitionDeclaration() override;

    void addTransition(std::string_view var, const MultiDimAdressable* transition) override;

    void addTransition(std::string_view var) override;

    void endTransitionDeclaration() override;

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

    void startCostDeclaration() override;

    void addCost(const MultiDimAdressable* cost) override;

    void addCost() override;

    void endCostDeclaration() override;

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

    void startRewardDeclaration() override;

    void setOperationModeOn(std::string_view operationType) override;

    void addReward(const MultiDimAdressable* reward) override;

    void addReward() override;

    void endRewardDeclaration() override;

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

    void startDiscountDeclaration() override;

    void addDiscount(float discount) override;

    void endDiscountDeclaration() override;

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

    NodeId addInternalNode(std::string_view name_of_var) override;

    NodeId addTerminalNode(float value) override;

    void addArc(NodeId from, NodeId to, Idx modality) override;

    void setRoot(NodeId rootId) override;

 
    private:
    // ==========================================================================
    // ==========================================================================

    bool _foo_flag_;

    bool _bar_flag_;

    std::vector< std::string > _stringBag_;

    std::vector< const MultiDimImplementation< GUM_ELEMENT >* > _ddBag_;

    void _checkModalityInBag_(std::string_view mod);

    void _resetParts_();

    void _initializeFunctionGraph_();

    void _finalizeFunctionGraph_();


    std::vector< FMDPfactory_state > _states_;

    FMDP< GUM_ELEMENT >* _fmdp_;

    MultiDimFunctionGraph< GUM_ELEMENT >* _FunctionGraph_;

    HashTable< std::string, const DiscreteVariable* > _varNameMap_;

    Idx _actionIdcpt_;

    FMDPFactory< GUM_ELEMENT >& operator=(const FMDPFactory< GUM_ELEMENT >& source);

    void _illegalStateError_(std::string_view s);
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class FMDPFactory< double >;
#endif
 
} /* namespace gum */
 
#include <agrum/FMDP/fmdpFactory_tpl.h>
 
#endif   // GUM_FMDP_FACTORY_H