IfmdpFactory.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_ABSTRACT_FMDP_FACTORY_H
#define GUM_ABSTRACT_FMDP_FACTORY_H

#include <string>
#include <vector>

#include <agrum/graphs/graphElements.h>
#include <agrum/variables/discreteVariable.h>

#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