CTheoreticalModel Class Reference

Theoretical Model derived in section $\ref{paper-sec:Model}$ , page $\pageref{paper-sec:Model}$ . More...

#include <CTheoreticalModel.h>

List of all members.

Public Member Functions

CTheoreticalModel (double alpha, double beta)

Construct a new model using the given parameters.

double algorithmA ()

calculates [some property] by implementing algorithm $\ref{paper-alg:SomeAlgorithm}$ on page $\pageref{paper-alg:SomeAlgorithm}$

void equationB (double gamma)

updates the model by [some parameter] according to the dynamics of equation $\ref{paper-eqn:SomeEquation}$ on page $\pageref{paper-eqn:SomeEquation}$

bool testC (double theta)

tests [some parameter] against the model; implements condition $\ref{paper-eqn:SomeCondition}$

Private Attributes

double m_alpha

[parameter] defined in equation $\ref{paper-eqn:alphaDef}$

double m_beta

[parameter] defined in equation $\ref{paper-eqn:betaDef}$

Detailed Description

Theoretical Model derived in section $\ref{paper-sec:Model}$ , page $\pageref{paper-sec:Model}$ .

This is a detailed description of the model

Constructor & Destructor Documentation

CTheoreticalModel::CTheoreticalModel	(	double	alpha,
		double	beta
	)

Construct a new model using the given parameters.

Parameters:

`[in]`	alpha	[parameter] defined in equation $\ref{paper-eqn:alphaDef}$
`[in]`	beta	[parameter] defined in equation $\ref{paper-eqn:betaDef}$

Member Function Documentation

double CTheoreticalModel::algorithmA ( )

calculates [some property] by implementing algorithm $\ref{paper-alg:SomeAlgorithm}$ on page $\pageref{paper-alg:SomeAlgorithm}$

Returns:: [some property]

void CTheoreticalModel::equationB ( double gamma )

updates the model by [some parameter] according to the dynamics of equation $\ref{paper-eqn:SomeEquation}$ on page $\pageref{paper-eqn:SomeEquation}$

Parameters:

[in] gamma [parameter] defined in equation $\ref{paper-eqn:gammaDef}$

bool CTheoreticalModel::testC ( double theta )

tests [some parameter] against the model; implements condition $\ref{paper-eqn:SomeCondition}$

Parameters:

[in] theta [some parameter] defined by equation $\ref{paper-eqn:thetaDef}$

Member Data Documentation

double CTheoreticalModel::m_alpha [private]

[parameter] defined in equation $\ref{paper-eqn:alphaDef}$

double CTheoreticalModel::m_beta [private]

[parameter] defined in equation $\ref{paper-eqn:betaDef}$

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

CTheoreticalModel.h


Public Member Functions
	CTheoreticalModel (double alpha, double beta)
	Construct a new model using the given parameters.
double	algorithmA ()
	calculates [some property] by implementing algorithm $\ref{paper-alg:SomeAlgorithm}$ on page $\pageref{paper-alg:SomeAlgorithm}$
void	equationB (double gamma)
	updates the model by [some parameter] according to the dynamics of equation $\ref{paper-eqn:SomeEquation}$ on page $\pageref{paper-eqn:SomeEquation}$
bool	testC (double theta)
	tests [some parameter] against the model; implements condition $\ref{paper-eqn:SomeCondition}$
Private Attributes
double	m_alpha
	[parameter] defined in equation $\ref{paper-eqn:alphaDef}$
double	m_beta
	[parameter] defined in equation $\ref{paper-eqn:betaDef}$