Models::FMTModelStats Class Reference

Class reporting the statistics of a FMTModel, used with the preSolve and postsolve functions. More...

#include <FMTModelStats.h>

Public Member Functions
	FMTModelStats (const size_t &lthemes, const size_t &lthemesdata, const size_t &lactions, const size_t &lactionsdata, const size_t &ltransitions, const size_t &ltransitionsdata, const size_t &lyieldsdata, const size_t &llifespansdata, const size_t &loutputs, const size_t &loutputsdata, const size_t &lconstraints, const size_t &lconstraintsdata)
	Constructor for complete stats.
	FMTModelStats ()=default
	Default constructor for FMTModelStats.
	FMTModelStats (const FMTModelStats &rhs)=default
	Copy constructor for FMTModelStats.
	~FMTModelStats ()=default
	Default destructor for FMTModelStats.
FMTModelStats &	operator= (const FMTModelStats &rhs)=default
	Copy assignment operator for FMTModelStats.
FMTModelStats &	operator+= (const FMTModelStats &rhs)
	Addition assignment operator with another FMTModelStats.
FMTModelStats &	operator-= (const FMTModelStats &rhs)
	Subtraction assignment operator with another FMTModelStats.
FMTModelStats	operator+ (const FMTModelStats &rhs)
	Addition operator with another FMTModelStats.
FMTModelStats	operator- (const FMTModelStats &rhs)
	Subtraction operator with another FMTModelStats.
bool	operator== (const FMTModelStats &rhs) const
	Equality comparison operator of FMTModelStats.
bool	operator!= (const FMTModelStats &rhs) const
	Inequality comparison operator of FMTModelStats.
	operator std::string () const
	Return the string representation of the stats.

Public Attributes
int	themes
	The number of themes the FMTModel.
int	themesdata
	The themes's data size.
int	actions
	The number of actions of the FMTModel.
int	actionsdata
	The actions's data size.
int	transitions
	The number of transitions of the FMTModel.
int	transitionsdata
	The transitions's data size.
int	yieldsdata
	The yields's data size.
int	lifespansdata
	The lifespans's data size.
int	outputs
	The number of outputs of the FMTModel.
int	outputsdata
	The outputsdata's data size.
int	constraints
	The number of constraints of the FMTModel.
int	constraintsdata
	The constraintsdata's data size.

Friends
class	boost::serialization::access

Detailed Description

Class reporting the statistics of a FMTModel, used with the preSolve and postsolve functions.

Calling preSolve or postsolve changes the model stats.

Constructor & Destructor Documentation

FMTModelStats() [1/3]

Models::FMTModelStats::FMTModelStats	(	const size_t &	lthemes,
		const size_t &	lthemesdata,
		const size_t &	lactions,
		const size_t &	lactionsdata,
		const size_t &	ltransitions,
		const size_t &	ltransitionsdata,
		const size_t &	lyieldsdata,
		const size_t &	llifespansdata,
		const size_t &	loutputs,
		const size_t &	loutputsdata,
		const size_t &	lconstraints,
		const size_t &	lconstraintsdata
	)

Constructor for complete stats.

Parameters

[in]	lthemes	the number of themes.
[in]	lthemesdata	the themes data size.
[in]	lactions	the number of actions.
[in]	lactionsdata	the actions data size.
[in]	ltransitions	the number of transitions.
[in]	ltransitionsdata	the transitions data size.
[in]	lyieldsdata	the yields data size.
[in]	llifespansdata	the lifespans data size.
[in]	loutputs	the number of outputs.
[in]	loutputsdata	the outputs data size.
[in]	lconstraints	the number of constraints.
[in]	lconstraintsdata	the constraints data size.

FMTModelStats() [2/3]

Models::FMTModelStats::FMTModelStats ( )

default

Default constructor for FMTModelStats.

FMTModelStats() [3/3]

Models::FMTModelStats::FMTModelStats ( const FMTModelStats &  rhs )

default

Copy constructor for FMTModelStats.

Parameters

[in]

rhs

the FMTModelStats to copy.

~FMTModelStats()

Models::FMTModelStats::~FMTModelStats ( )

default

Default destructor for FMTModelStats.

Member Function Documentation

operator std::string()

Models::FMTModelStats::operator std::string

(

)

const

Return the string representation of the stats.

Returns

the string representation of the stats.

operator!=()

bool Models::FMTModelStats::operator!=

(

const FMTModelStats &

rhs

)

const

Inequality comparison operator of FMTModelStats.

Parameters

[in]

rhs

the stats to compare with.

Returns

true if both stats are different else false.

operator+()

FMTModelStats Models::FMTModelStats::operator+

(

const FMTModelStats &

rhs

)

Addition operator with another FMTModelStats.

Parameters

[in]

rhs

the stats to add.

Returns

the resulting FMTModelStats.

operator+=()

FMTModelStats & Models::FMTModelStats::operator+=

(

const FMTModelStats &

rhs

)

Addition assignment operator with another FMTModelStats.

Parameters

[in]

rhs

the stats to add.

Returns

a reference to this FMTModelStats.

operator-()

FMTModelStats Models::FMTModelStats::operator-

(

const FMTModelStats &

rhs

)

Subtraction operator with another FMTModelStats.

Parameters

[in]

rhs

the stats to subtract.

Returns

the resulting FMTModelStats.

operator-=()

FMTModelStats & Models::FMTModelStats::operator-=

(

const FMTModelStats &

rhs

)

Subtraction assignment operator with another FMTModelStats.

Parameters

[in]

rhs

the stats to subtract.

Returns

a reference to this FMTModelStats.

operator=()

FMTModelStats & Models::FMTModelStats::operator= ( const FMTModelStats &  rhs )

default

Copy assignment operator for FMTModelStats.

Parameters

[in]

rhs

the FMTModelStats to copy.

Returns

a reference to this FMTModelStats.

operator==()

bool Models::FMTModelStats::operator==

(

const FMTModelStats &

rhs

)

const

Equality comparison operator of FMTModelStats.

Parameters

[in]

rhs

the stats to compare with.

Returns

true if both stats are equal else false.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Member Data Documentation

actions

int Models::FMTModelStats::actions

The number of actions of the FMTModel.

actionsdata

int Models::FMTModelStats::actionsdata

The actions's data size.

constraints

int Models::FMTModelStats::constraints

The number of constraints of the FMTModel.

constraintsdata

int Models::FMTModelStats::constraintsdata

The constraintsdata's data size.

lifespansdata

int Models::FMTModelStats::lifespansdata

The lifespans's data size.

outputs

int Models::FMTModelStats::outputs

The number of outputs of the FMTModel.

outputsdata

int Models::FMTModelStats::outputsdata

The outputsdata's data size.

themes

int Models::FMTModelStats::themes

The number of themes the FMTModel.

themesdata

int Models::FMTModelStats::themesdata

The themes's data size.

transitions

int Models::FMTModelStats::transitions

The number of transitions of the FMTModel.

transitionsdata

int Models::FMTModelStats::transitionsdata

The transitions's data size.

yieldsdata

int Models::FMTModelStats::yieldsdata

The yields's data size.

---

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

• D:/FMT/Include/FMTModelStats.h