SolveGoal.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
 
#include <boost/optional.hpp>
 
#include "storm/logic/ComparisonType.h"
#include "storm/solver/OptimizationDirection.h"
#include "storm/solver/UncertaintyResolutionMode.h"
#include "storm/storage/BitVector.h"
 
#include "storm/solver/LinearEquationSolver.h"
#include "storm/solver/MinMaxLinearEquationSolver.h"
 
namespace storm {
namespace storage {
template<typename ValueType>
class SparseMatrix;
}
 
namespace solver {
 
template<typename ValueType>
class LinearEquationSolverFactory;
}  // namespace solver
 
namespace modelchecker {
template<typename FormulaType, typename ValueType>
class CheckTask;
}
namespace models {
namespace sparse {
template<typename ValueType, typename RewardModelType>
class Model;
}
}  // namespace models
 
namespace solver {
template<typename ValueType>
class LinearEquationSolver;
 
template<typename ValueType, typename SolutionType = ValueType>
class SolveGoal {
   public:
    SolveGoal();
 
    template<typename RewardModelType, typename FormulaType>
    SolveGoal(storm::models::sparse::Model<ValueType, RewardModelType> const& model,
              storm::modelchecker::CheckTask<FormulaType, SolutionType> const& checkTask) {
        if (checkTask.isOptimizationDirectionSet()) {
            optimizationDirection = checkTask.getOptimizationDirection();
        }
        if (checkTask.isOnlyInitialStatesRelevantSet()) {
            relevantValueVector = model.getInitialStates();
        }
        if (checkTask.isBoundSet()) {
            comparisonType = checkTask.getBoundComparisonType();
            threshold = checkTask.getBoundThreshold();
        }
        uncertaintyResolutionMode = checkTask.getUncertaintyResolutionMode();
    }
 
    SolveGoal(bool minimize);
    SolveGoal(OptimizationDirection d);
    SolveGoal(OptimizationDirection d, storm::logic::ComparisonType boundComparisonType, SolutionType const& boundThreshold,
              storm::storage::BitVector const& relevantValues);
    SolveGoal(OptimizationDirection d, storm::storage::BitVector const& relevantValues);

    void oneMinus();
 
    bool hasDirection() const;
 
    bool minimize() const;
 
    OptimizationDirection direction() const;
 
    UncertaintyResolutionMode getUncertaintyResolutionMode() const;
 
    bool isBounded() const;
 
    bool boundIsALowerBound() const;
 
    bool boundIsStrict() const;
 
    storm::logic::ComparisonType boundComparisonType() const;
 
    SolutionType const& thresholdValue() const;
 
    bool hasRelevantValues() const;
 
    storm::storage::BitVector& relevantValues();
    storm::storage::BitVector const& relevantValues() const;
 
    void restrictRelevantValues(storm::storage::BitVector const& filter);
    void setRelevantValues(storm::storage::BitVector&& values);
 
   private:
    boost::optional<OptimizationDirection> optimizationDirection;
 
    boost::optional<storm::logic::ComparisonType> comparisonType;
    boost::optional<SolutionType> threshold;
    boost::optional<storm::storage::BitVector> relevantValueVector;
    UncertaintyResolutionMode uncertaintyResolutionMode;
};
 
template<typename ValueType, typename MatrixType, typename SolutionType>
std::unique_ptr<storm::solver::MinMaxLinearEquationSolver<ValueType, SolutionType>> configureMinMaxLinearEquationSolver(
    Environment const& env, SolveGoal<ValueType, SolutionType>&& goal, storm::solver::MinMaxLinearEquationSolverFactory<ValueType, SolutionType> const& factory,
    MatrixType&& matrix, OptimizationDirectionSetting optimizationDirectionSetting = OptimizationDirectionSetting::Unset) {
    std::unique_ptr<storm::solver::MinMaxLinearEquationSolver<ValueType, SolutionType>> solver = factory.create(env, std::forward<MatrixType>(matrix));
    solver->setOptimizationDirection((optimizationDirectionSetting == OptimizationDirectionSetting::Unset) ? goal.direction()
                                                                                                           : convert(optimizationDirectionSetting));
    if (goal.isBounded()) {
        if (goal.boundIsALowerBound()) {
            solver->setTerminationCondition(std::make_unique<TerminateIfFilteredExtremumExceedsThreshold<SolutionType>>(
                goal.relevantValues(), goal.boundIsStrict(), goal.thresholdValue(), true));
        } else {
            solver->setTerminationCondition(std::make_unique<TerminateIfFilteredExtremumBelowThreshold<SolutionType>>(
                goal.relevantValues(), goal.boundIsStrict(), goal.thresholdValue(), false));
        }
    }
    if (goal.hasRelevantValues()) {
        solver->setRelevantValues(std::move(goal.relevantValues()));
    }
    return solver;
}
 
template<typename ValueType, typename MatrixType, typename SolutionType>
std::unique_ptr<storm::solver::LinearEquationSolver<ValueType>> configureLinearEquationSolver(
    Environment const& env, SolveGoal<ValueType, SolutionType>&& goal, storm::solver::LinearEquationSolverFactory<ValueType> const& factory,
    MatrixType&& matrix) {
    std::unique_ptr<storm::solver::LinearEquationSolver<ValueType>> solver = factory.create(env, std::forward<MatrixType>(matrix));
    if (goal.isBounded()) {
        solver->setTerminationCondition(std::make_unique<TerminateIfFilteredExtremumExceedsThreshold<ValueType>>(goal.relevantValues(), goal.boundIsStrict(),
                                                                                                                 goal.thresholdValue(), goal.minimize()));
    }
    return solver;
}
 
template<typename MatrixType>
std::unique_ptr<storm::solver::LinearEquationSolver<storm::RationalFunction>> configureLinearEquationSolver(
    Environment const& env, SolveGoal<storm::RationalFunction>&&, storm::solver::LinearEquationSolverFactory<storm::RationalFunction> const& factory,
    MatrixType&& matrix) {
    std::unique_ptr<storm::solver::LinearEquationSolver<storm::RationalFunction>> solver = factory.create(env, std::forward<MatrixType>(matrix));
    return solver;
}
 
}  // namespace solver
}  // namespace storm