Description of the class TLinearRegression. More...

#include <TLinearRegression.h>

Inheritance diagram for URANIE::Modeler::TLinearRegression:

[legend]

Collaboration diagram for URANIE::Modeler::TLinearRegression:

[legend]

Public Member Functions
TVectorD	computeHii (TMatrixD A)

Constructor and Destructor
	TLinearRegression (URANIE::DataServer::TDataServer tds, TString architecture, Option_t option="")
	Default constructor with the TDataServer.

	TLinearRegression (URANIE::DataServer::TDataServer tds, const char varexpinput, const char varexpoutput, Option_t option="")
	Default constructor with input and output attributes.

virtual	~TLinearRegression ()
	Constructor with a dataserver and a PMML File.

Get and Set methods
Double_t	getR2Adjusted () const
	Return the Adjusted R2 statistic.

Double_t	getPress () const
	Return the Press statistic.

Double_t	getQ2 () const
	Return the Q2 statistic.

TMatrixD	getParametersCovariance () const
	Return the Q2 statistic.

Estimate
void	estimate (Option_t *option="")

Export the model in extrenal langage
void	exportModelCplusplus (std::ofstream *sourcefile) const
	Export the model in C++ langage in a file.

void	exportModelFortran (std::ofstream *sourcefile) const
	Export the model in Fortran langage in a file.

void	exportModelPMML (const char file="", const char name="", Option_t *option="") const
	Export the model in a PMML file.

void	exportModelPython (std::ofstream *sourcefile) const
	Export the model in Python langage in a file (not yet implemented)

Printing Log
virtual void	printLog (Option_t *option="")

Public Member Functions inherited from URANIE::Modeler::TModeler
	TModeler (URANIE::DataServer::TDataServer tds, TString architecture, Option_t option="")
	Constructor with a dataserver.

	TModeler (URANIE::DataServer::TDataServer tds, const char varexpinput, const char varexpoutput, Option_t option="")
	Default constructor with input and output attributes.

virtual	~TModeler ()
	Default destructor.

TVectorD	getParameters ()
	Return the parameter vector of the model.

Double_t	getR2 () const
	Return the R2 quality.

const char *	getInputName (Int_t i) const
	Return the name of input attributes.

const char *	getOutputName (Int_t i=0)
	Return the name of output attribute.

Int_t	getNInput ()
	Gets the number of input.

Bool_t	getIntercept ()
	Gets the boolean attribut _bIntercept.

void	setDrawProgressBar (Bool_t bbool=kTRUE)
	Set the "draw progress bar" flag.

Bool_t	getDrawProgressBar ()
	Get the "draw progress bar" flag.

void	train (Option_t *option="text")

virtual void	exportFunction (const char lang, const char file="", const char name="", Option_t option="")
	Export the model in an external file with a specified langage.

void	setLog ()

void	unsetLog ()

void	changeLog ()

Bool_t	getLog ()

Public Attributes
Double_t	_dr2a
	The Adjusted R2 quality.

Double_t	_dq2
	The Q2 quality.

Double_t	_dpress
	The PRESS quality.

TMatrixD	_mParameterCov

Public Attributes inherited from URANIE::Modeler::TModeler
Bool_t	_blog
	Boolean for edit the log.

Bool_t	_bdrawProgressBar
	Boolean to know if the progress bar has to be drawn.

Bool_t	_bStoreYHat
	Boolean to specify if we add the \hat{} attribute in the TDS [default kTRUE].

URANIE::DataServer::TDataServer *	_tds

Int_t	_nS
	Pointer to a TDS.

TString	_sInputAttributes
	The string of input attributes (separated by the character ":".

TString	_sOutputAttributes
	The string of output attributes (separated by the character ":".

TString	_sIntermediateArchitecture
	The intermediate (between the first and last character ",") information.

TList *	_listOfInputAttributes
	The list of input Leaf.

TList *	_listOfOutputAttributes
	The list of output Leaf.

Int_t	_nX
	The number of input attributes.

Int_t	_nY
	The number of output attributes.

TString	_sFileName
	The name of the file when export the model without extension.

TString	_sFunctionName
	The name of the function when export the model.

TVectorD	_parameterValues
	The list of parameters.

Double_t	_dr2
	The R2 quality.

Bool_t	_bIntercept
	For certain models, add the intercept (Default is TRUE)

Private Member Functions
TMatrixD	computeH (TMatrixD A)

TMatrixD	computeCov (TMatrixD A)

Detailed Description

Description of the class TLinearRegression.

To write by the developper.

Constructor & Destructor Documentation

◆ TLinearRegression() [1/2]

URANIE::Modeler::TLinearRegression::TLinearRegression	(	URANIE::DataServer::TDataServer *	tds,
		TString	architecture,
		Option_t *	option = `""`
	)

Default constructor with the TDataServer.

Referenced by ClassImp().

◆ TLinearRegression() [2/2]

URANIE::Modeler::TLinearRegression::TLinearRegression	(	URANIE::DataServer::TDataServer *	tds,
		const char *	varexpinput,
		const char *	varexpoutput,
		Option_t *	option = `""`
	)

Default constructor with input and output attributes.

◆ ~TLinearRegression()

virtual URANIE::Modeler::TLinearRegression::~TLinearRegression ( )

virtual

Constructor with a dataserver and a PMML File.

Default destructor

Referenced by ClassImp().

Member Function Documentation

◆ computeCov()

TMatrixD URANIE::Modeler::TLinearRegression::computeCov ( TMatrixD A )

private

Referenced by ClassImp().

◆ computeH()

TMatrixD URANIE::Modeler::TLinearRegression::computeH ( TMatrixD A )

private

Referenced by ClassImp().

◆ computeHii()

TVectorD URANIE::Modeler::TLinearRegression::computeHii ( TMatrixD A )

Referenced by ClassImp().

◆ estimate()

void URANIE::Modeler::TLinearRegression::estimate ( Option_t * option = "" )

Referenced by ClassImp(), and ClassImp().

◆ exportModelCplusplus()

void URANIE::Modeler::TLinearRegression::exportModelCplusplus ( std::ofstream * sourcefile ) const

virtual

Export the model in C++ langage in a file.

Warning: Don't use this method. Use the main method TModeler::exportFunction.

Parameters

sourcefile (ofstream *) the pointer to the file to export the modeler.

Implements URANIE::Modeler::TModeler.

Referenced by ClassImp(), and ClassImp().

◆ exportModelFortran()

void URANIE::Modeler::TLinearRegression::exportModelFortran ( std::ofstream * sourcefile ) const

virtual

Export the model in Fortran langage in a file.

Warning: Don't use this method. Use the main method TModeler::exportFunction.

Parameters

sourcefile (ofstream *) the pointer to the file to export the modeler.

Implements URANIE::Modeler::TModeler.

Referenced by ClassImp(), and ClassImp().

◆ exportModelPMML()

void URANIE::Modeler::TLinearRegression::exportModelPMML	(	const char *	file = `""`,
		const char *	name = `""`,
		Option_t *	option = `""`
	)		const

virtual

Export the model in a PMML file.

Implements URANIE::Modeler::TModeler.

Referenced by ClassImp().

◆ exportModelPython()

void URANIE::Modeler::TLinearRegression::exportModelPython ( std::ofstream * sourcefile ) const

inlinevirtual

Export the model in Python langage in a file (not yet implemented)

Warning: Don't use this method. Use the main method TModeler::exportFunction.

Parameters

sourcefile (ofstream *) the pointer to the file to export the modeler.

Implements URANIE::Modeler::TModeler.

◆ getParametersCovariance()

TMatrixD URANIE::Modeler::TLinearRegression::getParametersCovariance ( ) const

inline

Return the Q2 statistic.

References _mParameterCov.

◆ getPress()

Double_t URANIE::Modeler::TLinearRegression::getPress ( ) const

inline

Return the Press statistic.

References _dpress.

Referenced by ClassImp().

◆ getQ2()

Double_t URANIE::Modeler::TLinearRegression::getQ2 ( ) const

inline

Return the Q2 statistic.

References _dq2.

Referenced by ClassImp(), and ClassImp().

◆ getR2Adjusted()

Double_t URANIE::Modeler::TLinearRegression::getR2Adjusted ( ) const

inline

Return the Adjusted R2 statistic.

References _dr2a.

Referenced by ClassImp(), and ClassImp().

◆ printLog()

virtual void URANIE::Modeler::TLinearRegression::printLog ( Option_t * option = "" )

virtual

Reimplemented from URANIE::Modeler::TModeler.

Referenced by ClassImp().

Member Data Documentation

◆ _dpress

Double_t URANIE::Modeler::TLinearRegression::_dpress

The PRESS quality.

Referenced by ClassImp(), and getPress().

◆ _dq2

Double_t URANIE::Modeler::TLinearRegression::_dq2

The Q2 quality.

Referenced by ClassImp(), and getQ2().

◆ _dr2a

Double_t URANIE::Modeler::TLinearRegression::_dr2a

The Adjusted R2 quality.

Referenced by ClassImp(), and getR2Adjusted().

◆ _mParameterCov

TMatrixD URANIE::Modeler::TLinearRegression::_mParameterCov

Referenced by ClassImp(), and getParametersCovariance().

Documentation / Developer's manual

Available modules

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TLinearRegression() [1/2]

◆ TLinearRegression() [2/2]

◆ ~TLinearRegression()

Member Function Documentation

◆ computeCov()

◆ computeH()

◆ computeHii()

◆ estimate()

◆ exportModelCplusplus()

◆ exportModelFortran()

◆ exportModelPMML()

◆ exportModelPython()

◆ getParametersCovariance()

◆ getPress()

◆ getQ2()

◆ getR2Adjusted()

◆ printLog()

Member Data Documentation

◆ _dpress

◆ _dq2

◆ _dr2a

◆ _mParameterCov