RewardModel.h

Go to the documentation of this file.

#pragma once
 
#include <map>
#include <string>
#include <vector>
 
#include "storm/storage/BoostTypes.h"
#include "storm/storage/prism/StateActionReward.h"
#include "storm/storage/prism/StateReward.h"
#include "storm/storage/prism/TransitionReward.h"
 
namespace storm {
namespace prism {
class RewardModel : public LocatedInformation {
   public:
    RewardModel(std::string const& rewardModelName, std::vector<storm::prism::StateReward> const& stateRewards,
                std::vector<storm::prism::StateActionReward> const& stateActionRewards, std::vector<storm::prism::TransitionReward> const& transitionRewards,
                std::string const& filename = "", uint_fast64_t lineNumber = 0);
 
    // Create default implementations of constructors/assignment.
    RewardModel() = default;
    RewardModel(RewardModel const& other) = default;
    RewardModel& operator=(RewardModel const& other) = default;
    RewardModel(RewardModel&& other) = default;
    RewardModel& operator=(RewardModel&& other) = default;

    std::string const& getName() const;

    bool empty() const;

    bool hasStateRewards() const;

    std::vector<storm::prism::StateReward> const& getStateRewards() const;

    bool hasStateActionRewards() const;

    std::vector<storm::prism::StateActionReward> const& getStateActionRewards() const;

    bool hasTransitionRewards() const;

    std::vector<storm::prism::TransitionReward> const& getTransitionRewards() const;

    RewardModel substitute(std::map<storm::expressions::Variable, storm::expressions::Expression> const& substitution) const;
 
    RewardModel labelUnlabelledCommands(std::vector<std::pair<uint64_t, std::string>> const& newActionNames) const;

    bool containsVariablesOnlyInRewardValueExpressions(std::set<storm::expressions::Variable> const& undefinedConstantVariables) const;

    RewardModel restrictActionRelatedRewards(storm::storage::FlatSet<uint_fast64_t> const& actionIndicesToKeep) const;
 
    friend std::ostream& operator<<(std::ostream& stream, RewardModel const& rewardModel);
 
   private:
    // The name of the reward model.
    std::string rewardModelName;
 
    // The state-based rewards associated with this reward model.
    std::vector<storm::prism::StateReward> stateRewards;
 
    // The state-action-based rewards associated with this reward model.
    std::vector<storm::prism::StateActionReward> stateActionRewards;
 
    // The transition-based rewards associated with this reward model.
    std::vector<storm::prism::TransitionReward> transitionRewards;
};
 
}  // namespace prism
}  // namespace storm