Valuations.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <string>
 
#include "storm/adapters/JsonForward.h"
#include "storm/adapters/RationalNumberForward.h"
#include "storm/storage/BitVector.h"
#include "storm/storage/expressions/Variable.h"
#include "storm/utility/NumberTraits.h"
 
namespace storm {
 
namespace expressions {
template<typename T>
class ExpressionEvaluator;
}
 
namespace storage::sparse {
 
struct ValuationClassDescription;
class ValuationsStorage;

class Valuations {
   public:
    Valuations(ValuationClassDescription const valuationClassDescription, std::shared_ptr<storm::expressions::ExpressionManager const> const& manager = {},
               uint64_t const numEntities = 0);
    Valuations(ValuationsStorage&& umbValuations);
    Valuations(Valuations const& other);
    Valuations(Valuations&& other);
    ~Valuations();
    Valuations& operator=(Valuations&& other);
    Valuations& operator=(Valuations const& other);
 
    storm::expressions::ExpressionManager const& getManager() const;
    ValuationsStorage const& getStorage() const;
    ValuationsStorage& getStorage();

    uint64_t getNumberOfEntities() const;

    std::set<storm::expressions::Variable> getAllVariables() const;

    bool entityHasVariable(uint64_t entity, storm::expressions::Variable const& variable) const;
 
    // optional variants have no value iff either entityHasVariable(entity, variable) is false or the value is of optional type and not set.
    bool getBooleanValue(uint64_t const entity, storm::expressions::Variable const& booleanVariable) const;
    std::optional<bool> getOptionalBooleanValue(uint64_t const entity, storm::expressions::Variable const& booleanVariable) const;
    int64_t getInt64Value(uint64_t const entity, storm::expressions::Variable const& integerVariable) const;
    std::optional<int64_t> getOptionalInt64Value(uint64_t const entity, storm::expressions::Variable const& integerVariable) const;
    double getDoubleValue(uint64_t const entity, storm::expressions::Variable const& doubleVariable) const;
    std::optional<double> getOptionalDoubleValue(uint64_t const entity, storm::expressions::Variable const& doubleVariable) const;
    storm::RationalNumber getRationalValue(uint64_t const entity, storm::expressions::Variable const& rationalVariable) const;
    std::optional<storm::RationalNumber> getOptionalRationalValue(uint64_t const entity, storm::expressions::Variable const& rationalVariable) const;
    std::string getStringValue(uint64_t const entity, storm::expressions::Variable const& stringVariable) const;
    std::optional<std::string> getOptionalStringValue(uint64_t const entity, storm::expressions::Variable const& stringVariable) const;

    template<typename RationalValueType>
    void setValuesInEvaluator(uint64_t entity, storm::expressions::ExpressionEvaluator<RationalValueType>& evaluator) const;

    storm::storage::BitVector getBooleanValues(storm::expressions::Variable const& booleanVariable) const;

    std::vector<int64_t> getInt64Values(storm::expressions::Variable const& integerVariable) const;

    std::vector<double> getDoubleValues(storm::expressions::Variable const& doubleVariable) const;

    std::vector<storm::RationalNumber> getRationalValues(storm::expressions::Variable const& rationalVariable) const;

    std::vector<std::string> getStringValues(storm::expressions::Variable const& stringVariable) const;

    std::string toString(uint64_t const entity, bool const pretty = true,
                         std::optional<std::set<storm::expressions::Variable>> const& selectedVariables = {}) const;

    template<typename JsonRationalType = storm::RationalNumber>
    storm::json<JsonRationalType> toJson(uint64_t const entity, std::optional<std::set<storm::expressions::Variable>> const& selectedVariables = {}) const;

    Valuations selectEntities(storm::storage::BitVector const& selectedEntities) const;

    Valuations selectEntities(std::vector<uint64_t> const& selectedEntities) const;
 
    std::size_t hash() const;
 
   private:
    std::unique_ptr<ValuationsStorage> umbValuations;
};
 
}  // namespace storage::sparse
}  // namespace storm