#include <ARXIdentification.h>

Public Member Functions
	CARXIdentification (int, int, int, int, double, double)
	This is the default class constructor.

	~CARXIdentification ()
	This is the class constructor that allows to initiate the values of certain class variables. More...

void	AdjustFi ()
	This is the default class destructor.

void	AdjustP ()
	This method adjusts the length of the fi vector. . More...

void	AdjustTheta (char, int)
	This method adjusts the length of the P matrix to the current values of the degrees of the predicting transfer function's nominator and denominator. . More...

void	AdjustThetaHistory ()
	This method adjusts the length of the theta vector to the current values of the degrees of the predicting transfer function's nominator and denominator. More...

void	SetDelayTime (int)
	This method adjusts the length of the history of theta parameters to the current values of the degrees of the predicting transfer function's nominator and denominator.

void	ChangeDelayTime (int)
	This method allows to initiate the value of the time delay of the predicting transfer function. More...

void	SetForgettingFactor (double)
	This method allows to change the value of the time delay of the predicting transfer function. More...

void	SetHistoryLength (int)
	This method allows to set the value of the forgetting factor from the Weighted Recursive Least Mean Squares method. More...

void	ChangeHistoryLength (int)
	This method allows to initiate the length of history of theta parameters. More...

void	ResetWholeHistory ()
	This method allows to change the length of history of theta parameters. More...

std::vector< double >	ReturnThetaNominator ()
	This method resets the history of inputs, outputs and theta parameters.

std::vector< double >	ReturnThetaDenominator ()
	This method returns from the theta vector the values of the nominator of the predicting transfer function. More...

void	ChangePolynomial_i_degree (int)
	This method returns from the theta vector the values of the denominator of the predicting transfer function. More...

void	ChangePolynomial_o_degree (int)
	This method allows to change the degree of the nominator from the predicting transfer function. More...

void	AddInputElement (double)
	This method allows to change the degree of the denominator from the predicting transfer function. More...

void	AddOutputElement (double)
	This method allows to add an input value to the vector that contains the history of input values. More...

double	ComputeQualityIndicator (void)
	This method allows to add an output value to the vector that contains the history of output values. More...

void	Update ()
	This method allows to compute the quality indicator of the WRLMS method (unused).

Detailed Description

The purpose of this class is to allow the possibility of creating a transfer function, which will predict the output of a discrete dynamic system described by data contained inside the instance of CARXIdentification class.

Constructor & Destructor Documentation

CARXIdentification::~CARXIdentification ( )

This is the class constructor that allows to initiate the values of certain class variables.

Parameters

[in]	iDegree_i	This is the degree of the nominator of the predicting transfer function.
[in]	iDegree_o	This is the degree of the denominator of the predicting transfer function.
[in]	iDelay	This is the delaying factor of the predicting transfer function.
[in]	iHistLen	This is the length of history of parameters of the predicting transfer function.
[in]	iForgettingFactor	This is the forgetting factor from the Weighted Recursive Least Mean Squares method.
[in]	dThreshold	This a threshold value used in the calculation of the P matrix.

Member Function Documentation

void CARXIdentification::AddInputElement ( double iInput )

This method allows to change the degree of the denominator from the predicting transfer function.

Parameters

[in] value This is the variable which contains the new value of the denominator's degree.

void CARXIdentification::AddOutputElement ( double iOutput )

This method allows to add an input value to the vector that contains the history of input values.

Parameters

[in] Iinput This is the input value that is added to input history.

void CARXIdentification::AdjustP ( )

This method adjusts the length of the fi vector.
.

The length to which it will be adjusted to is equal to the sum of the desired degree of the nominator and denominator of the predicting transfer function plus 1). New coordinates are filled with 0s.

Here is the caller graph for this function:

void CARXIdentification::AdjustTheta	(	char	c,
		int	iPrevDegree
	)

This method adjusts the length of the P matrix to the current values of the degrees of the predicting transfer function's nominator and denominator.
.

New coordinates are filled with 0s.

Here is the caller graph for this function:

void CARXIdentification::AdjustThetaHistory ( )

This method adjusts the length of the theta vector to the current values of the degrees of the predicting transfer function's nominator and denominator.

Parameters

[in]	c	This is a character variable that informs this method whether it should adjust the length of the nominator or the denominator.
[in]	iPrevDegree	This is an integer variable that informs this method what was the previous degree of the currently adjusted polynomial.

Here is the caller graph for this function:

void CARXIdentification::ChangeDelayTime ( int value )

This method allows to initiate the value of the time delay of the predicting transfer function.

Parameters

[in] value This is the variable which contains the new value of the predicting transfer function's time delay.

void CARXIdentification::ChangeHistoryLength ( int value )

This method allows to initiate the length of history of theta parameters.

Parameters

[in] value This is the variable which contains the new value of the theta history.

Here is the call graph for this function:

void CARXIdentification::ChangePolynomial_i_degree ( int value )

This method returns from the theta vector the values of the denominator of the predicting transfer function.

Returns: vThetaNominator This vector of type double contains the values of the denominator of the predicting transfer function.

Here is the call graph for this function:

void CARXIdentification::ChangePolynomial_o_degree ( int value )

This method allows to change the degree of the nominator from the predicting transfer function.

Parameters

[in] value This is the variable which contains the new value of the nominator's degree.

Here is the call graph for this function:

double CARXIdentification::ComputeQualityIndicator ( void )

This method allows to add an output value to the vector that contains the history of output values.

Parameters

[in] Iinput This is the output value that is added to output history.

void CARXIdentification::ResetWholeHistory ( )

This method allows to change the length of history of theta parameters.

Parameters

[in] value This is the variable which contains the new value of the theta history.

std::vector< double > CARXIdentification::ReturnThetaDenominator ( )

This method returns from the theta vector the values of the nominator of the predicting transfer function.

Returns: vThetaNominator This vector of type double contains the values of the nominator of the predicting transfer function.

void CARXIdentification::SetForgettingFactor ( double value )

This method allows to change the value of the time delay of the predicting transfer function.

Parameters

[in] value This is the variable which contains the new value of the predicting transfer function's time delay.

Here is the caller graph for this function:

void CARXIdentification::SetHistoryLength ( int value )

This method allows to set the value of the forgetting factor from the Weighted Recursive Least Mean Squares method.

Parameters

[in] value This is the variable which contains the new value of the WRLMS method's forgetting factor.

Here is the caller graph for this function:

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

SimulationChain/Source/ARXIdentification.h
SimulationChain/Source/ARXIdentification.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation