viennashe::models::state_base Class Reference

The basic concept of a state in Markov-Chains. More...

#include <chain.hpp>

Public Types
typedef std::size_t	index_type

Public Member Functions
	state_base (index_type id, std::string const &name)
	state_base (state_base const &s)
virtual	~state_base ()
index_type	id () const
	Returns the unique id of the state. More...
std::string	name () const
	Returns the name of the state for convenience and debugability. More...
double	occupancy () const
	Returns the occupancy f or p of the state. It has to be a number in [0,1]. More...
void	occupancy (double o)
	Sets the states occupancy. More...
virtual state_base *	clone () const
	Basic interface to get a clone (uses new operator!) of the current object for storage. The caller takes ownership! More...

Detailed Description

The basic concept of a state in Markov-Chains.

Definition at line 39 of file chain.hpp.

Member Typedef Documentation

index_type

typedef std::size_t viennashe::models::state_base::index_type

Definition at line 42 of file chain.hpp.

Constructor & Destructor Documentation

state_base() [1/2]

viennashe::models::state_base::state_base ( index_type  id, std::string const &  name  )

inline

Definition at line 44 of file chain.hpp.

state_base() [2/2]

viennashe::models::state_base::state_base ( state_base const &  s )

inline

Definition at line 46 of file chain.hpp.

~state_base()

virtual viennashe::models::state_base::~state_base ( )

inlinevirtual

Definition at line 48 of file chain.hpp.

Member Function Documentation

clone()

virtual state_base * viennashe::models::state_base::clone ( ) const

inlinevirtual

Basic interface to get a clone (uses new operator!) of the current object for storage. The caller takes ownership!

Definition at line 74 of file chain.hpp.

id()

index_type viennashe::models::state_base::id ( ) const

inline

Returns the unique id of the state.

Definition at line 51 of file chain.hpp.

name()

std::string viennashe::models::state_base::name ( ) const

inline

Returns the name of the state for convenience and debugability.

Definition at line 53 of file chain.hpp.

occupancy() [1/2]

double viennashe::models::state_base::occupancy ( ) const

inline

Returns the occupancy f or p of the state. It has to be a number in [0,1].

Definition at line 56 of file chain.hpp.

occupancy() [2/2]

void viennashe::models::state_base::occupancy ( double  o )

inline

Sets the states occupancy.

Parameters

o	The new occupancy. Must be a number in [0,1]

Definition at line 61 of file chain.hpp.

---

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

• viennashe/models/markovchain/chain.hpp