Description of the class TCorrelationFunction. More...

#include <TCorrelationFunction.h>

Inheritance diagram for URANIE::Modeler::TCorrelationFunction:

[legend]

Collaboration diagram for URANIE::Modeler::TCorrelationFunction:

Public Member Functions
Constructor and Destructor
	TCorrelationFunction ()
	Default constructor.

virtual	~TCorrelationFunction ()
	Default destructor.

Get and Set methods
Int_t	getNParameters ()
	Return the number of parameters of the correlation function.

Int_t	getNDimensions ()
	Return the number of dimensions of the input space.

Int_t	getNCorrLengths ()
	Return the number of correlation lengths.

Double_t *	getParameters ()
	Returns an array containing the parameters of the function.

Double_t *	getCorrLengths ()
	Returns an array containing only the correlation lengths.

virtual void	setParameters (Double_t *newParams)=0
	Set the values of the function's parameters.

virtual void	setCorrLengths (Double_t *corrLength)=0
	Sets the values of the correlation lengths.

Outils
virtual TCorrelationFunction *	clone ()=0
	Return a clone of the correlation function.

virtual void	eval (Int_t n1, Double_t x1, Int_t n2, Double_t x2, Double_t *C)=0
	Compute the correlation between x1 and x2.

Printing Log
void	setLog ()

void	unsetLog ()

void	changeLog ()

Bool_t	getLog ()

virtual void	printLog (Option_t *option="")

Public Attributes
Bool_t	_blog
	Boolean to decide if the log information is shown or not.

Double_t *	parameters
	array containing the values of the function parameters. Correlation lengths are stored last.

Double_t *	_lCorrLengths
	array containing only the correlation lengths.

Int_t	nbDimensions
	number of dimensions of the input space

Int_t	nbParameters
	total number of parameters

Int_t	nbCorrLengths
	number of correlation lengths

Detailed Description

Description of the class TCorrelationFunction.

This class defines a function representing the correlation between two sets of variables.

Constructor & Destructor Documentation

◆ TCorrelationFunction()

URANIE::Modeler::TCorrelationFunction::TCorrelationFunction ( )

Default constructor.

Referenced by ClassImp().

◆ ~TCorrelationFunction()

virtual URANIE::Modeler::TCorrelationFunction::~TCorrelationFunction ( )

virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ changeLog()

void URANIE::Modeler::TCorrelationFunction::changeLog ( )

inline

References _blog.

◆ clone()

virtual TCorrelationFunction * URANIE::Modeler::TCorrelationFunction::clone ( )

pure virtual

Return a clone of the correlation function.

The clone must be destroyed by the object (or user) calling the function.

Implemented in URANIE::Modeler::TExponentialCorrFunction, URANIE::Modeler::TGaussianCorrFunction, URANIE::Modeler::TIsotropicGaussianCorrFunction, URANIE::Modeler::TMatern12CorrFunction, URANIE::Modeler::TMatern32CorrFunction, URANIE::Modeler::TMatern52CorrFunction, URANIE::Modeler::TMatern72CorrFunction, URANIE::Modeler::TMaternICorrFunction, URANIE::Modeler::TMaternIICorrFunction, and URANIE::Modeler::TMaternIIICorrFunction.

Referenced by ClassImp(), and ClassImp().

◆ eval()

virtual void URANIE::Modeler::TCorrelationFunction::eval	(	Int_t	n1,
		Double_t *	x1,
		Int_t	n2,
		Double_t *	x2,
		Double_t *	C
	)

pure virtual

Compute the correlation between x1 and x2.

The order of the indices in the flat arrays are the following: x[i+j*d] = X[i,j] where X is a matrix of size (d x n), i is the line index, and j the column index. The results are stored in the flat array C.

Warning: Be aware that the matrix corresponding to flat arrays x1 and x2 have input dimensions as LINE, not columns. This means that for a set of point {(a1,b1),(a2,b2),(a3,b3)}, the corresponding matrix X will be: $\left( \begin{array}{ccc} a1 & a2 & a3 \\ b1 & b2 & b3 \end{array} \right)$ and the corresponding flat array x = {a1,b1,a2,b2,a3,b3}.

Parameters

n1	(Int_t): number of elements of x1
x1	(Double_t): data set x1 represented as a flat array (size: d n1)
n2	(Int_t): number of elements of x2
x2	(Double_t): data set x2 represented as a flat array (size: d n2)
C	(Double_t): correlation matrix represented as a flat array (size: n1 n2)

Implemented in URANIE::Modeler::TExponentialCorrFunction, URANIE::Modeler::TGaussianCorrFunction, URANIE::Modeler::TIsotropicGaussianCorrFunction, URANIE::Modeler::TMatern12CorrFunction, URANIE::Modeler::TMatern32CorrFunction, URANIE::Modeler::TMatern52CorrFunction, URANIE::Modeler::TMatern72CorrFunction, URANIE::Modeler::TMaternICorrFunction, URANIE::Modeler::TMaternIICorrFunction, and URANIE::Modeler::TMaternIIICorrFunction.

Referenced by ClassImp(), and ClassImp().

◆ getCorrLengths()

Double_t * URANIE::Modeler::TCorrelationFunction::getCorrLengths ( )

inline

Returns an array containing only the correlation lengths.

References _lCorrLengths.

Referenced by ClassImp().

◆ getLog()

Bool_t URANIE::Modeler::TCorrelationFunction::getLog ( )

inline

References _blog.

◆ getNCorrLengths()

Int_t URANIE::Modeler::TCorrelationFunction::getNCorrLengths ( )

inline

Return the number of correlation lengths.

References nbCorrLengths.

Referenced by ClassImp(), and URANIE::Modeler::TKriging::getNCorrLengths().

◆ getNDimensions()

Int_t URANIE::Modeler::TCorrelationFunction::getNDimensions ( )

inline

Return the number of dimensions of the input space.

References nbDimensions.

Referenced by ClassImp().

◆ getNParameters()

Int_t URANIE::Modeler::TCorrelationFunction::getNParameters ( )

inline

Return the number of parameters of the correlation function.

References nbParameters.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), and URANIE::Modeler::TKriging::getNCorrFunctionParams().

◆ getParameters()

Double_t * URANIE::Modeler::TCorrelationFunction::getParameters ( )

inline

Returns an array containing the parameters of the function.

References parameters.

Referenced by ClassImp(), and URANIE::Modeler::TKriging::getCorrFunctionParams().

◆ printLog()

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

virtual

Reimplemented in URANIE::Modeler::TExponentialCorrFunction, URANIE::Modeler::TGaussianCorrFunction, URANIE::Modeler::TIsotropicGaussianCorrFunction, URANIE::Modeler::TMatern12CorrFunction, URANIE::Modeler::TMatern32CorrFunction, URANIE::Modeler::TMatern52CorrFunction, URANIE::Modeler::TMatern72CorrFunction, URANIE::Modeler::TMaternICorrFunction, URANIE::Modeler::TMaternIICorrFunction, and URANIE::Modeler::TMaternIIICorrFunction.

Referenced by ClassImp().

◆ setCorrLengths()

virtual void URANIE::Modeler::TCorrelationFunction::setCorrLengths ( Double_t * corrLength )

pure virtual

Sets the values of the correlation lengths.

Parameters

corrLength (Double_t*): array containing the correlation lengths.

Implemented in URANIE::Modeler::TExponentialCorrFunction, URANIE::Modeler::TGaussianCorrFunction, URANIE::Modeler::TIsotropicGaussianCorrFunction, URANIE::Modeler::TMatern12CorrFunction, URANIE::Modeler::TMatern32CorrFunction, URANIE::Modeler::TMatern52CorrFunction, URANIE::Modeler::TMatern72CorrFunction, URANIE::Modeler::TMaternICorrFunction, URANIE::Modeler::TMaternIICorrFunction, and URANIE::Modeler::TMaternIIICorrFunction.

Referenced by ClassImp().

◆ setLog()

void URANIE::Modeler::TCorrelationFunction::setLog ( )

inline

References _blog.

◆ setParameters()

virtual void URANIE::Modeler::TCorrelationFunction::setParameters ( Double_t * newParams )

pure virtual

Set the values of the function's parameters.

Parameters

newParams (Double_t*): array of nbParameters values corresponding to the parameters of the correlation function. The correlation lengths are the last elements of the array.

Implemented in URANIE::Modeler::TExponentialCorrFunction, URANIE::Modeler::TGaussianCorrFunction, URANIE::Modeler::TIsotropicGaussianCorrFunction, URANIE::Modeler::TMatern12CorrFunction, URANIE::Modeler::TMatern32CorrFunction, URANIE::Modeler::TMatern52CorrFunction, URANIE::Modeler::TMatern72CorrFunction, URANIE::Modeler::TMaternICorrFunction, URANIE::Modeler::TMaternIICorrFunction, and URANIE::Modeler::TMaternIIICorrFunction.

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

◆ unsetLog()

void URANIE::Modeler::TCorrelationFunction::unsetLog ( )

inline

References _blog.

Member Data Documentation

◆ _blog

Bool_t URANIE::Modeler::TCorrelationFunction::_blog

Boolean to decide if the log information is shown or not.

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

◆ _lCorrLengths

Double_t* URANIE::Modeler::TCorrelationFunction::_lCorrLengths

array containing only the correlation lengths.

Referenced by ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), ClassImp(), URANIE::Modeler::TIsotropicGaussianCorrFunction::getCorrelationLength(), and getCorrLengths().

◆ nbCorrLengths

Int_t URANIE::Modeler::TCorrelationFunction::nbCorrLengths

number of correlation lengths

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

◆ nbDimensions

Int_t URANIE::Modeler::TCorrelationFunction::nbDimensions

number of dimensions of the input space

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

◆ nbParameters

Int_t URANIE::Modeler::TCorrelationFunction::nbParameters

total number of parameters

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

◆ parameters

Double_t* URANIE::Modeler::TCorrelationFunction::parameters

array containing the values of the function parameters. Correlation lengths are stored last.

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

Documentation / Developer's manual

Available modules

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TCorrelationFunction()

◆ ~TCorrelationFunction()

Member Function Documentation

◆ changeLog()

◆ clone()

◆ eval()

◆ getCorrLengths()

◆ getLog()

◆ getNCorrLengths()

◆ getNDimensions()

◆ getNParameters()

◆ getParameters()

◆ printLog()

◆ setCorrLengths()

◆ setLog()

◆ setParameters()

◆ unsetLog()

Member Data Documentation

◆ _blog

◆ _lCorrLengths

◆ nbCorrLengths

◆ nbDimensions

◆ nbParameters

◆ parameters