storm::models::ModelBase Class Reference

#include <ModelBase.h>

Inheritance diagram for storm::models::ModelBase:

Collaboration diagram for storm::models::ModelBase:

Public Member Functions
	ModelBase (ModelType const &modelType)
	Constructs a model of the given type.
virtual	~ModelBase ()
template<typename ModelType >
std::shared_ptr< ModelType >	as ()
	Casts the model into the model type given by the template parameter.
template<typename ModelType >
std::shared_ptr< ModelType const >	as () const
	Casts the model into the model type given by the template parameter.
virtual ModelType	getType () const
	Return the actual type of the model.
virtual uint_fast64_t	getNumberOfStates () const =0
	Returns the number of states of the model.
virtual uint_fast64_t	getNumberOfTransitions () const =0
	Returns the number of (non-zero) transitions of the model.
virtual uint_fast64_t	getNumberOfChoices () const =0
	Returns the number of choices ine the model.
virtual void	printModelInformationToStream (std::ostream &out) const =0
	Prints information about the model to the specified stream.
virtual bool	isSparseModel () const
	Checks whether the model is a sparse model.
virtual bool	isSymbolicModel () const
	Checks whether the model is a symbolic model.
bool	isOfType (storm::models::ModelType const &modelType) const
	Checks whether the model is of the given type.
bool	isNondeterministicModel () const
	Returns true if the model is a nondeterministic model.
bool	isDiscreteTimeModel () const
	Returns true if the model is a descrete-time model.
virtual bool	supportsParameters () const
	Checks whether the model supports parameters.
virtual bool	hasParameters () const
	Checks whether the model has parameters.
virtual bool	isExact () const
	Checks whether the model is exact.
virtual bool	isPartiallyObservable () const
virtual void	reduceToStateBasedRewards ()=0
	Converts the transition rewards of all reward models to state-based rewards.
virtual bool	hasRewardModel (std::string const &rewardModelName) const =0
	Retrieves whether the model has a reward model with the given name.
virtual bool	hasUniqueRewardModel () const =0
virtual std::string const &	getUniqueRewardModelName () const =0

Detailed Description

Definition at line 11 of file ModelBase.h.

Constructor & Destructor Documentation

ModelBase()

storm::models::ModelBase::ModelBase ( ModelType const &  modelType )

inline

Constructs a model of the given type.

Parameters

modelType

The type of the model.

Definition at line 18 of file ModelBase.h.

~ModelBase()

virtual storm::models::ModelBase::~ModelBase ( )

inlinevirtual

Definition at line 25 of file ModelBase.h.

Member Function Documentation

as() [1/2]

template<typename ModelType >

std::shared_ptr< ModelType > storm::models::ModelBase::as ( )

inline

Casts the model into the model type given by the template parameter.

Returns

A shared pointer of the requested type that points to the model if the cast succeeded and a null pointer otherwise.

Definition at line 36 of file ModelBase.h.

as() [2/2]

template<typename ModelType >

std::shared_ptr< ModelType const > storm::models::ModelBase::as ( ) const

inline

Casts the model into the model type given by the template parameter.

Returns

A shared pointer of the requested type that points to the model if the cast succeeded and a null pointer otherwise.

Definition at line 47 of file ModelBase.h.

getNumberOfChoices()

virtual uint_fast64_t storm::models::ModelBase::getNumberOfChoices ( ) const

pure virtual

Returns the number of choices ine the model.

Returns

The number of choices in of the model.

Implemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, storm::models::symbolic::Model< Type, ValueType >, storm::models::symbolic::NondeterministicModel< Type, ValueType >, storm::models::symbolic::NondeterministicModel< DdType, ValueType >, storm::models::symbolic::NondeterministicModel< Type, double >, and storm::models::symbolic::NondeterministicModel< Type, ValueType >.

getNumberOfStates()

virtual uint_fast64_t storm::models::ModelBase::getNumberOfStates ( ) const

pure virtual

Returns the number of states of the model.

Returns

The number of states of the model.

Implemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

getNumberOfTransitions()

virtual uint_fast64_t storm::models::ModelBase::getNumberOfTransitions ( ) const

pure virtual

Returns the number of (non-zero) transitions of the model.

Returns

The number of (non-zero) transitions of the model.

Implemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

getType()

ModelType storm::models::ModelBase::getType ( ) const

virtual

Return the actual type of the model.

Each model must implement this method.

Returns

Type of the model.

Definition at line 7 of file ModelBase.cpp.

getUniqueRewardModelName()

virtual std::string const & storm::models::ModelBase::getUniqueRewardModelName ( ) const

pure virtual

Implemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

hasParameters()

bool storm::models::ModelBase::hasParameters ( ) const

virtual

Checks whether the model has parameters.

Returns

True iff the model has parameters.

Reimplemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

Definition at line 50 of file ModelBase.cpp.

hasRewardModel()

virtual bool storm::models::ModelBase::hasRewardModel ( std::string const &  rewardModelName ) const

pure virtual

Retrieves whether the model has a reward model with the given name.

Returns

True iff the model has a reward model with the given name.

Implemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

hasUniqueRewardModel()

virtual bool storm::models::ModelBase::hasUniqueRewardModel ( ) const

pure virtual

Implemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

isDiscreteTimeModel()

bool storm::models::ModelBase::isDiscreteTimeModel

(

)

const

Returns true if the model is a descrete-time model.

Definition at line 33 of file ModelBase.cpp.

isExact()

bool storm::models::ModelBase::isExact ( ) const

virtual

Checks whether the model is exact.

Returns

True iff the model is exact.

Reimplemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, and storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >.

Definition at line 54 of file ModelBase.cpp.

isNondeterministicModel()

bool storm::models::ModelBase::isNondeterministicModel

(

)

const

Returns true if the model is a nondeterministic model.

Returns

True iff the model is a nondeterministic model.

Definition at line 23 of file ModelBase.cpp.

isOfType()

bool storm::models::ModelBase::isOfType

(

storm::models::ModelType const &

modelType

)

const

Checks whether the model is of the given type.

Parameters

modelType

The model type to check for.

Returns

True iff the model is of the given type.

Definition at line 19 of file ModelBase.cpp.

isPartiallyObservable()

bool storm::models::ModelBase::isPartiallyObservable ( ) const

virtual

Reimplemented in storm::models::sparse::Pomdp< ValueType, RewardModelType >.

Definition at line 42 of file ModelBase.cpp.

isSparseModel()

bool storm::models::ModelBase::isSparseModel ( ) const

virtual

Checks whether the model is a sparse model.

Returns

True iff the model is a sparse model.

Reimplemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, and storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >.

Definition at line 11 of file ModelBase.cpp.

isSymbolicModel()

bool storm::models::ModelBase::isSymbolicModel ( ) const

virtual

Checks whether the model is a symbolic model.

Returns

True iff the model is a symbolic model.

Reimplemented in storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

Definition at line 15 of file ModelBase.cpp.

printModelInformationToStream()

virtual void storm::models::ModelBase::printModelInformationToStream ( std::ostream &  out ) const

pure virtual

Prints information about the model to the specified stream.

Parameters

out	The stream the information is to be printed to.

Implemented in storm::models::sparse::MarkovAutomaton< ValueType, RewardModelType >, storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::sparse::NondeterministicModel< ValueType, RewardModelType >, storm::models::sparse::NondeterministicModel< double, RM >, storm::models::sparse::NondeterministicModel< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::NondeterministicModel< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::NondeterministicModel< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::sparse::Pomdp< ValueType, RewardModelType >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, storm::models::symbolic::Model< Type, ValueType >, storm::models::symbolic::NondeterministicModel< Type, ValueType >, storm::models::symbolic::NondeterministicModel< DdType, ValueType >, storm::models::symbolic::NondeterministicModel< Type, double >, and storm::models::symbolic::NondeterministicModel< Type, ValueType >.

reduceToStateBasedRewards()

virtual void storm::models::ModelBase::reduceToStateBasedRewards ( )

pure virtual

Converts the transition rewards of all reward models to state-based rewards.

For deterministic models, this reduces the rewards to state rewards only. For nondeterminstic models, the reward models will contain state rewards and state-action rewards. Note that this transformation does not preserve all properties, but it preserves expected rewards.

Implemented in storm::models::sparse::Ctmc< ValueType, RewardModelType >, storm::models::sparse::Dtmc< ValueType, RewardModelType >, storm::models::sparse::Dtmc< FunctionType >, storm::models::sparse::NondeterministicModel< ValueType, RewardModelType >, storm::models::sparse::NondeterministicModel< double, RM >, storm::models::sparse::NondeterministicModel< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::NondeterministicModel< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::NondeterministicModel< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Ctmc< Type, ValueType >, storm::models::symbolic::Dtmc< Type, ValueType >, storm::models::symbolic::NondeterministicModel< Type, ValueType >, storm::models::symbolic::NondeterministicModel< DdType, ValueType >, storm::models::symbolic::NondeterministicModel< Type, double >, and storm::models::symbolic::NondeterministicModel< Type, ValueType >.

supportsParameters()

bool storm::models::ModelBase::supportsParameters ( ) const

virtual

Checks whether the model supports parameters.

Returns

True iff the model supports parameters.

Reimplemented in storm::models::sparse::Model< CValueType, CRewardModelType >, storm::models::sparse::Model< double, RM >, storm::models::sparse::Model< double, storm::models::sparse::StandardRewardModel< double > >, storm::models::sparse::Model< FunctionType, StandardRewardModel< FunctionType > >, storm::models::sparse::Model< ValueType >, storm::models::sparse::Model< ValueType, StandardRewardModel< ValueType > >, storm::models::sparse::Model< ValueType, storm::models::sparse::StandardRewardModel< ValueType > >, storm::models::symbolic::Model< Type, CValueType >, storm::models::symbolic::Model< DdType, ValueType >, storm::models::symbolic::Model< Type, double >, and storm::models::symbolic::Model< Type, ValueType >.

Definition at line 46 of file ModelBase.cpp.

---

The documentation for this class was generated from the following files:

• src/storm/models/ModelBase.h
• src/storm/models/ModelBase.cpp