Marmote Core
The project aims at realizing the prototype of a software environment dedicated to modeling with Markov chains.
 All Classes Functions Variables
Public Member Functions | List of all members
eventMixture Class Reference
Inheritance diagram for eventMixture:
transitionStructure

Public Member Functions

 eventMixture (int size, int nbEvents, double *probas, std::string *names, int **transitions)
 Constructor from arrays. More...
 
 eventMixture (sparseMatrix *spMat)
 Contruction from a sparse matrix. More...
 
 ~eventMixture ()
 Destructor of the class. More...
 
int nbEvents ()
 Read accessor for the number of events. More...
 
double eventProba (int e)
 Read accessor for the probabilities associated to each event. More...
 
bool setEntry (int i, int j, double val)
 Method to set the value associated with some transition. Not applicable here. More...
 
double getEntry (int i, int j)
 Method to get the value associated with some transition. When state parameters are out of bounds, the returned value should be 0. More...
 
int getNbElts (int i)
 Method to get the number of non-zero entries in a transition from some state. This can be seen as the number of actually possible transitions from that state. More...
 
int getCol (int i, int k)
 Method to get the number of the state corresponding to transition number k in the list of possible transitions from some state i. More...
 
double getEntryByCol (int i, int k)
 Method to get the value attached to transition number k in the list of possible transitions from some state i. More...
 
discreteDistributiongetTransDistrib (int i)
 Method to get the transition from some state as a probability distribution. More...
 
double rowSum (int i)
 Sum of entries on some row i. Always 1.0 since this is a discrete-time transition structure. More...
 
eventMixturecopy ()
 Copying a transition structure. More...
 
eventMixtureuniformize ()
 Uniformizing a transition structure. Since the origin structure is already of discrete-time type, a copy is returned. More...
 
void evaluateMeasure (double *pi, double *res)
 Computing the action of the transition structure on some measure, the measure being represented as a vector of real numbers. This corresponds to the multiplication vector/matrix, the row vector being interpreted as a signed measure. More...
 
void evaluateMeasure (discreteDistribution *d, discreteDistribution *res)
  More...
 
void evaluateValue (double *v, double *res)
 Computing the action of the transition structure on some vector of values. This corresponds to the multiplication matrix/vector, the column vector being interpreted as a vector of values attached to the states. More...
 
void write (FILE *out, std::string format)
 Output method for the transition structure. Supported formats are: XBORNE, MARCA, Ers, Maple. More...
 
- Public Member Functions inherited from transitionStructure
virtual ~transitionStructure ()
 Destructor of the class. More...
 
int size ()
 Read accessor for the size of the state space. More...
 
timeType type ()
 Read accessor for the time type. More...
 
double uniformizationRate ()
 Read accessor for the uniformization rate. Relevant mostly for discrete-time structures created by uniformization of a continuous-time one. More...
 
void setType (timeType t)
 Write accessor for the time type. More...
 
void setUniformizationRate (double rate)
 Write accessor for the uniformization rate. More...
 
bool readEntry (FILE *input)
 Reading from a file, and adding an element to the matrix. The field must be in the form "row column value" with blank spaces as separators. More...
 

Additional Inherited Members

- Protected Member Functions inherited from transitionStructure
int consolidate (int i, int *destinations, double *values)
 Method to consolidate (aggregate) transition probabilities from a given state. The method returns the number of different destination states, and modifies the arrays which will containt the lists of destinations and the corresponding probabilities. These arrays must have been allocated beforehand, with a size large enough to handle safely all possibilities. More...
 
- Protected Attributes inherited from transitionStructure
timeType _type
 the time type of the structure: discrete or continuous. More...
 
long int _size
 size of the state space. More...
 
double _uniformizationRate
 value related to the uniformization procedure. More...
 

Constructor & Destructor Documentation

eventMixture::eventMixture ( int  size,
int  nbEvents,
double *  probas,
std::string *  names,
int **  transitions 
)

Constructor from arrays.

Parameters
sizethe number of states
nbEventsthe number of different events
probasthe array of probabilities. This array is copied
namesthe names of events. This array is copied
transitionsthe array of state-to-state mappings. This array is not copied.
eventMixture::eventMixture ( sparseMatrix spMat)

Contruction from a sparse matrix.

Parameters
spMatthe sparse matrix to convert into an event mixture
eventMixture::~eventMixture ( )

Destructor of the class.

Member Function Documentation

eventMixture * eventMixture::copy ( )
virtual

Copying a transition structure.

Returns
transitionStructure

Implements transitionStructure.

void eventMixture::evaluateMeasure ( double *  pi,
double *  res 
)
virtual

Computing the action of the transition structure on some measure, the measure being represented as a vector of real numbers. This corresponds to the multiplication vector/matrix, the row vector being interpreted as a signed measure.

Parameters
dthe measure to evaluate
resthe resulting measure

Reimplemented from transitionStructure.

void eventMixture::evaluateMeasure ( discreteDistribution d,
discreteDistribution res 
)
virtual

Reimplemented from transitionStructure.

void eventMixture::evaluateValue ( double *  v,
double *  res 
)
virtual

Computing the action of the transition structure on some vector of values. This corresponds to the multiplication matrix/vector, the column vector being interpreted as a vector of values attached to the states.

Parameters
vthe vector of values to evaluate
resthe resulting vector

Implements transitionStructure.

double eventMixture::eventProba ( int  e)
inline

Read accessor for the probabilities associated to each event.

Parameters
ethe event index
Returns
the probability that the event is e
int eventMixture::getCol ( int  i,
int  k 
)
virtual

Method to get the number of the state corresponding to transition number k in the list of possible transitions from some state i.

Parameters
ithe origin state
kthe index of transition from state i
Returns
the destination state corresponding to the k-th possible transition from state i

Implements transitionStructure.

double eventMixture::getEntry ( int  i,
int  j 
)
virtual

Method to get the value associated with some transition. When state parameters are out of bounds, the returned value should be 0.

Parameters
ithe origin state
jthe destination state
Returns
the value attached to the transition (i,j)

Implements transitionStructure.

double eventMixture::getEntryByCol ( int  i,
int  k 
)
virtual

Method to get the value attached to transition number k in the list of possible transitions from some state i.

Parameters
ithe origin state
kthe index of the transition from state i
Returns
the value attached to the k-th possible transition from state i

Implements transitionStructure.

int eventMixture::getNbElts ( int  i)
virtual

Method to get the number of non-zero entries in a transition from some state. This can be seen as the number of actually possible transitions from that state.

Parameters
ithe origin state
Returns
int the number of possible transitions

Implements transitionStructure.

discreteDistribution * eventMixture::getTransDistrib ( int  i)
virtual

Method to get the transition from some state as a probability distribution.

Parameters
ithe origin state
Returns
a discrete distribution object

Implements transitionStructure.

int eventMixture::nbEvents ( )
inline

Read accessor for the number of events.

Returns
the number of events
double eventMixture::rowSum ( int  i)
virtual

Sum of entries on some row i. Always 1.0 since this is a discrete-time transition structure.

Parameters
ithe row to be summed
Returns
1.0

Implements transitionStructure.

bool eventMixture::setEntry ( int  i,
int  j,
double  val 
)
virtual

Method to set the value associated with some transition. Not applicable here.

Parameters
ithe origin state
jthe destination state
valthe value attached to the transition
Returns
false since it is not possible to set values in this structure

Implements transitionStructure.

eventMixture * eventMixture::uniformize ( )
virtual

Uniformizing a transition structure. Since the origin structure is already of discrete-time type, a copy is returned.

Returns
a discrete-time transition structure

Implements transitionStructure.

void eventMixture::write ( FILE *  out,
std::string  format 
)
virtual

Output method for the transition structure. Supported formats are: XBORNE, MARCA, Ers, Maple.

Parameters
outthe file descriptor to which the structure should be written.
formatthe format/language to be used

Implements transitionStructure.


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