tempest/src/models/sparse/Dtmc.h

#ifndef STORM_MODELS_SPARSE_DTMC_H_
#define STORM_MODELS_SPARSE_DTMC_H_
#include <unordered_set>

#include "src/models/sparse/DeterministicModel.h"
#include "src/utility/OsDetection.h"
#include "src/utility/constants.h"
#include "src/adapters/CarlAdapter.h"

namespace storm {
    namespace models {
        namespace sparse {
            
            /*!
             * This class represents a discrete-time Markov chain.
             */
            template <class ValueType>
            class Dtmc : public DeterministicModel<ValueType> {
            public:
                /*!
                 * Constructs a model from the given data.
                 *
                 * @param transitionMatrix The matrix representing the transitions in the model.
                 * @param stateLabeling The labeling of the states.
                 * @param optionalStateRewardVector The reward values associated with the states.
                 * @param optionalTransitionRewardMatrix The reward values associated with the transitions of the model.
                 * @param optionalChoiceLabeling A vector that represents the labels associated with the choices of each state.
                 */
                Dtmc(storm::storage::SparseMatrix<ValueType> const& probabilityMatrix,
                     storm::models::sparse::StateLabeling const& stateLabeling,
                     boost::optional<std::vector<ValueType>> const& optionalStateRewardVector = boost::optional<std::vector<ValueType>>(),
                     boost::optional<storm::storage::SparseMatrix<ValueType>> const& optionalTransitionRewardMatrix = boost::optional<storm::storage::SparseMatrix<ValueType>>(),
                     boost::optional<std::vector<LabelSet>> const& optionalChoiceLabeling = boost::optional<std::vector<LabelSet>>());
                
                /*!
                 * Constructs a model by moving the given data.
                 *
                 * @param transitionMatrix The matrix representing the transitions in the model.
                 * @param stateLabeling The labeling of the states.
                 * @param optionalStateRewardVector The reward values associated with the states.
                 * @param optionalTransitionRewardMatrix The reward values associated with the transitions of the model.
                 * @param optionalChoiceLabeling A vector that represents the labels associated with the choices of each state.
                 */
                Dtmc(storm::storage::SparseMatrix<ValueType>&& probabilityMatrix, storm::models::sparse::StateLabeling&& stateLabeling,
                     boost::optional<std::vector<ValueType>>&& optionalStateRewardVector = boost::optional<std::vector<ValueType>>(),
                     boost::optional<storm::storage::SparseMatrix<ValueType>>&& optionalTransitionRewardMatrix = boost::optional<storm::storage::SparseMatrix<ValueType>>(),
                     boost::optional<std::vector<LabelSet>>&& optionalChoiceLabeling = boost::optional<std::vector<LabelSet>>());
                
                Dtmc(Dtmc<ValueType> const& dtmc) = default;
                Dtmc& operator=(Dtmc<ValueType> const& dtmc) = default;
                
#ifndef WINDOWS
                Dtmc(Dtmc<ValueType>&& dtmc) = default;
                Dtmc& operator=(Dtmc<ValueType>&& dtmc) = default;
#endif
                
                /*!
                 * Retrieves the sub-DTMC that only contains the given set of states.
                 *
                 * @param states The states of the sub-DTMC.
                 * @return The resulting sub-DTMC.
                 */
                Dtmc<ValueType> getSubDtmc(storm::storage::BitVector const& states) const;
                
#ifdef STORM_HAVE_CARL
                class ConstraintCollector {
                private:
                    // A set of constraints that says that the DTMC actually has valid probability distributions in all states.
                    std::unordered_set<storm::ArithConstraint<ValueType>> wellformedConstraintSet;
                    
                    // A set of constraints that makes sure that the underlying graph of the model does not change depending
                    // on the parameter values.
                    std::unordered_set<storm::ArithConstraint<ValueType>> graphPreservingConstraintSet;
                    
                    // A comparator that is used for
                    storm::utility::ConstantsComparator<ValueType> comparator;
                    
                public:
                    /*!
                     * Constructs the a constraint collector for the given DTMC. The constraints are built and ready for
                     * retrieval after the construction.
                     *
                     * @param dtmc The DTMC for which to create the constraints.
                     */
                    ConstraintCollector(storm::models::sparse::Dtmc<ValueType> const& dtmc);
                    
                    /*!
                     * Returns the set of wellformed-ness constraints.
                     *
                     * @return The set of wellformed-ness constraints.
                     */
                    std::unordered_set<storm::ArithConstraint<ValueType>> const&  getWellformedConstraints() const;
                    
                    /*!
                     * Returns the set of graph-preserving constraints.
                     *
                     * @return The set of graph-preserving constraints.
                     */
                    std::unordered_set<storm::ArithConstraint<ValueType>> const&  getGraphPreservingConstraints() const;
                    
                    /*!
                     * Constructs the constraints for the given DTMC.
                     *
                     * @param dtmc The DTMC for which to create the constraints.
                     */
                    void process(storm::models::sparse::Dtmc<ValueType> const& dtmc);
                    
                    /*!
                     * Constructs the constraints for the given DTMC by calling the process method.
                     *
                     * @param dtmc The DTMC for which to create the constraints.
                     */
                    void operator()(storm::models::sparse::Dtmc<ValueType> const& dtmc);
                    
                };
#endif

            private:
                /*!
                 * Checks the probability matrix for validity.
                 *
                 * @return True iff the probability matrix is valid.
                 */
                bool checkValidityOfProbabilityMatrix() const;
            };
            
        } // namespace sparse
    } // namespace models
} // namespace storm

#endif /* STORM_MODELS_SPARSE_DTMC_H_ */