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

 
#ifndef GUM_ABSTRACT_FMDP_FACTORY_H
#define GUM_ABSTRACT_FMDP_FACTORY_H
 
#include <string>
#include <vector>
 
#include <agrum/FMDP/fmdp.h>
 
namespace gum {

  enum class FMDPfactory_state : char {
    NONE,
    VARIABLE,
    ACTION,
    TRANSITION,
    COST,
    REWARD,
    DISCOUNT
  };

 
  class AbstractFMDPFactory {
    public:
    // ==========================================================================
    // ==========================================================================
 
    //~ /**
    //~ * @brief Copy constructor.
    //~ * The copy will have an exact copy of the constructed Factored markov
    // Decision Process in source.
    //~ * @warning You can only copy a factory if its current state is NONE or
    //~ *          NETWORK.
    //~ * @throw OperationNotAllowed Raised if the state of source is not NONE
    // or
    //~ *                            NETWORK.
    //~ */
    //~ FMDPFactory ( const FMDPFactory<GUM_SCALAR>& source );

    virtual ~AbstractFMDPFactory() {};

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

    virtual FMDPfactory_state state() const = 0;

    virtual const DiscreteVariable* variable(const std::string& name) const = 0;

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

    virtual void startVariableDeclaration() = 0;

    virtual void variableName(const std::string& name) = 0;

    virtual void variableDescription(const std::string& desc) = 0;

    virtual void addModality(const std::string& name) = 0;

    virtual void endVariableDeclaration() = 0;

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

    virtual void startActionDeclaration() = 0;

    virtual void addAction(const std::string& action) = 0;

    virtual void endActionDeclaration() = 0;

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

    virtual void startTransitionDeclaration() = 0;

    virtual void addTransition(const std::string& var, const MultiDimAdressable* transition) = 0;

    virtual void addTransition(const std::string& var) = 0;

    virtual void endTransitionDeclaration() = 0;

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

    virtual void startCostDeclaration() = 0;

    virtual void addCost(const MultiDimAdressable* cost) = 0;

    virtual void addCost() = 0;

    virtual void endCostDeclaration() = 0;

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

    virtual void startRewardDeclaration() = 0;

    virtual void setOperationModeOn(std::string operationType) = 0;

    virtual void addReward(const MultiDimAdressable* reward) = 0;

    virtual void addReward() = 0;

    virtual void endRewardDeclaration() = 0;

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

    virtual void startDiscountDeclaration() = 0;

    virtual void addDiscount(float discount) = 0;

    virtual void endDiscountDeclaration() = 0;

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

    virtual NodeId addInternalNode(std::string name_of_var) = 0;

    virtual NodeId addTerminalNode(float value) = 0;

    virtual void addArc(NodeId from, NodeId to, Idx modality) = 0;

    virtual void setRoot(NodeId rootId) = 0;


    void setVerbose() { _verbose_ = true; }
 
    void resetVerbose() { _verbose_ = false; }
 
    bool isVerbose() { return _verbose_; }

 
    private:
    bool _verbose_;
  };
} /* namespace gum */
 
 
#endif   // GUM_ABSTRACT_FMDP_FACTORY_H