#include <TModeler.h>

Inheritance diagram for URANIE::Modeler::TModeler:

[legend]

Collaboration diagram for URANIE::Modeler::TModeler:

Public Member Functions
Constructor and Destructor
	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.

Get and Set methods
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.

Training
void	train (Option_t *option="text")

Export the model in extrenal langage
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.

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

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

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

virtual void	exportModelPython (std::ofstream *sourcefile) const =0
	Export the model in Python langage in a file.

Printing Log
void	setLog ()

void	unsetLog ()

void	changeLog ()

Bool_t	getLog ()

virtual void	printLog (Option_t *option="")

Public Attributes
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)

Constructor & Destructor Documentation

◆ TModeler() [1/2]

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

Constructor with a dataserver.

Referenced by ClassImp().

◆ TModeler() [2/2]

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

Default constructor with input and output attributes.

◆ ~TModeler()

virtual URANIE::Modeler::TModeler::~TModeler ( )

virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ changeLog()

void URANIE::Modeler::TModeler::changeLog ( )

inline

References _blog.

◆ exportFunction()

virtual void URANIE::Modeler::TModeler::exportFunction	(	const char *	lang,
		const char *	file = `""`,
		const char *	name = `""`,
		Option_t *	option = `""`
	)

virtual

Export the model in an external file with a specified langage.

It will be the main interface function to the export.

Parameters

lang	(const char *) the langage to export (C\|Fortran)
file	(const char *) the file to export the modeler. If empty, use the name of the model, plus the extension of the langage.
name	(const char *) the name of the function in the export file. If empty, use the name of the model
option	(Option_t *)[""] The option to pass

Referenced by ClassImp(), and ClassImp().

◆ exportModelCplusplus()

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

pure 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.

Implemented in URANIE::Modeler::TAnisp, URANIE::Modeler::TGLM, URANIE::Modeler::TKernel, URANIE::Modeler::TkNN, URANIE::Modeler::TLinearRegression, URANIE::Modeler::TPolynomialMultiDimFit, and URANIE::Modeler::TPolynomialRegression.

Referenced by ClassImp().

◆ exportModelFortran()

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

pure 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.

Implemented in URANIE::Modeler::TAnisp, URANIE::Modeler::TANNModeler, URANIE::Modeler::TGLM, URANIE::Modeler::TKernel, URANIE::Modeler::TkNN, URANIE::Modeler::TLinearRegression, URANIE::Modeler::TPolynomialMultiDimFit, and URANIE::Modeler::TPolynomialRegression.

Referenced by ClassImp().

◆ exportModelPMML()

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

pure virtual

Export the model in a PMML 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.

Implemented in URANIE::Modeler::TAnisp, URANIE::Modeler::TGLM, URANIE::Modeler::TKernel, URANIE::Modeler::TkNN, URANIE::Modeler::TLinearRegression, URANIE::Modeler::TPolynomialMultiDimFit, and URANIE::Modeler::TPolynomialRegression.

Referenced by ClassImp(), and ClassImp().

◆ exportModelPython()

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

pure virtual

Export the model in Python 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.

Implemented in URANIE::Modeler::TAnisp, URANIE::Modeler::TANNModeler, URANIE::Modeler::TGLM, URANIE::Modeler::TKernel, URANIE::Modeler::TkNN, URANIE::Modeler::TLinearRegression, URANIE::Modeler::TPolynomialMultiDimFit, and URANIE::Modeler::TPolynomialRegression.

Referenced by ClassImp().

◆ getDrawProgressBar()

Bool_t URANIE::Modeler::TModeler::getDrawProgressBar ( )

inline

Get the "draw progress bar" flag.

Returns: (Bool_t) the "draw progress bar" flag (boolean)

References _bdrawProgressBar.

Referenced by ClassImp().

◆ getInputName()

const char * URANIE::Modeler::TModeler::getInputName ( Int_t i ) const

Return the name of input attributes.

Referenced by ClassImp(), and ClassImp().

◆ getIntercept()

Bool_t URANIE::Modeler::TModeler::getIntercept ( )

inline

Gets the boolean attribut _bIntercept.

References _bIntercept.

◆ getLog()

Bool_t URANIE::Modeler::TModeler::getLog ( )

inline

References _blog.

Referenced by ClassImp().

◆ getNInput()

Int_t URANIE::Modeler::TModeler::getNInput ( )

Gets the number of input.

Referenced by ClassImp().

◆ getOutputName()

const char * URANIE::Modeler::TModeler::getOutputName ( Int_t i = 0 )

Return the name of output attribute.

Referenced by ClassImp().

◆ getParameters()

TVectorD URANIE::Modeler::TModeler::getParameters ( )

inline

Return the parameter vector of the model.

References _parameterValues.

Referenced by ClassImp().

◆ getR2()

Double_t URANIE::Modeler::TModeler::getR2 ( ) const

inline

Return the R2 quality.

References _dr2.

Referenced by ClassImp(), and ClassImp().

◆ printLog()

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

virtual

Reimplemented in URANIE::Modeler::TAnisp, URANIE::Modeler::TANNModeler, URANIE::Modeler::TGLM, URANIE::Modeler::TKernel, URANIE::Modeler::TkNN, URANIE::Modeler::TLinearRegression, URANIE::Modeler::TPolynomialMultiDimFit, and URANIE::Modeler::TPolynomialRegression.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ setDrawProgressBar()

void URANIE::Modeler::TModeler::setDrawProgressBar ( Bool_t bbool = kTRUE )

inline

Set the "draw progress bar" flag.

The progress bar will be drawn if and only if the "draw progress bar" flag is true.

References _bdrawProgressBar.

◆ setLog()

void URANIE::Modeler::TModeler::setLog ( )

inline

References _blog.

Referenced by ClassImp(), and ClassImp().

◆ train()

void URANIE::Modeler::TModeler::train ( Option_t * option = "text" )

Referenced by ClassImp().

◆ unsetLog()

void URANIE::Modeler::TModeler::unsetLog ( )

inline

References _blog.

Referenced by ClassImp().

Member Data Documentation

◆ _bdrawProgressBar

Bool_t URANIE::Modeler::TModeler::_bdrawProgressBar

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

Referenced by ClassImp(), ClassImp(), getDrawProgressBar(), and setDrawProgressBar().

◆ _bIntercept

Bool_t URANIE::Modeler::TModeler::_bIntercept

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

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and getIntercept().

◆ _blog

Bool_t URANIE::Modeler::TModeler::_blog

Boolean for edit the log.

Referenced by changeLog(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), getLog(), setLog(), and unsetLog().

◆ _bStoreYHat

Bool_t URANIE::Modeler::TModeler::_bStoreYHat

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

Referenced by ClassImp(), ClassImp(), and ClassImp().

◆ _dr2

Double_t URANIE::Modeler::TModeler::_dr2

The R2 quality.

Referenced by ClassImp(), ClassImp(), and getR2().

◆ _listOfInputAttributes

TList* URANIE::Modeler::TModeler::_listOfInputAttributes

The list of input Leaf.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _listOfOutputAttributes

TList* URANIE::Modeler::TModeler::_listOfOutputAttributes

The list of output Leaf.

Referenced by ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _nS

Int_t URANIE::Modeler::TModeler::_nS

Pointer to a TDS.

The size of the TDataServer

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _nX

Int_t URANIE::Modeler::TModeler::_nX

The number of input attributes.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _nY

Int_t URANIE::Modeler::TModeler::_nY

The number of output attributes.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _parameterValues

TVectorD URANIE::Modeler::TModeler::_parameterValues

The list of parameters.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and getParameters().

◆ _sFileName

TString URANIE::Modeler::TModeler::_sFileName

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

Referenced by ClassImp(), and ClassImp().

◆ _sFunctionName

TString URANIE::Modeler::TModeler::_sFunctionName

The name of the function when export the model.

Referenced by ClassImp(), ClassImp(), and ClassImp().

◆ _sInputAttributes

TString URANIE::Modeler::TModeler::_sInputAttributes

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

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _sIntermediateArchitecture

TString URANIE::Modeler::TModeler::_sIntermediateArchitecture

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

Referenced by ClassImp().

◆ _sOutputAttributes

TString URANIE::Modeler::TModeler::_sOutputAttributes

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

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

◆ _tds

URANIE::DataServer::TDataServer* URANIE::Modeler::TModeler::_tds

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), and ClassImp().

Documentation / Developer's manual

Available modules

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ TModeler() [1/2]

◆ TModeler() [2/2]

◆ ~TModeler()

Member Function Documentation

◆ changeLog()

◆ exportFunction()

◆ exportModelCplusplus()

◆ exportModelFortran()

◆ exportModelPMML()

◆ exportModelPython()

◆ getDrawProgressBar()

◆ getInputName()

◆ getIntercept()

◆ getLog()

◆ getNInput()

◆ getOutputName()

◆ getParameters()

◆ getR2()

◆ printLog()

◆ setDrawProgressBar()

◆ setLog()

◆ train()

◆ unsetLog()

Member Data Documentation

◆ _bdrawProgressBar

◆ _bIntercept

◆ _blog

◆ _bStoreYHat

◆ _dr2

◆ _listOfInputAttributes

◆ _listOfOutputAttributes

◆ _nS

◆ _nX

◆ _nY

◆ _parameterValues

◆ _sFileName

◆ _sFunctionName

◆ _sInputAttributes

◆ _sIntermediateArchitecture

◆ _sOutputAttributes

◆ _tds