Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::Math::IntegrandTransform Class Reference

Auxiliary inner class for mapping infinite and semi-infinite integrals.

Definition at line 234 of file GaussIntegrator.h.

Public Types

typedef IBaseFunctionOneDim BaseFunc
enum  ESemiInfinitySign { kMinus = -1 , kPlus = +1 }

Public Member Functions

 IntegrandTransform (const double boundary, ESemiInfinitySign sign, const IGenFunction *integrand)
 IntegrandTransform (const IGenFunction *integrand)
IGenFunction * Clone () const override
 Clone a function.
double Derivative (const double *x) const
 Compatibility method with multi-dimensional interface for partial derivative.
double Derivative (double x) const
 Return the derivative of the function at a point x Use the private method DoDerivative.
double DoEval (double x) const override
 implementation of the evaluation function. Must be implemented by derived classes
void FdF (const double *x, double &f, double *df) const
 Compatibility method with multi-dimensional interface for Gradient and function evaluation.
virtual void FdF (double x, double &f, double &df) const
 Optimized method to evaluate at the same time the function value and derivative at a point x.
void Gradient (const double *x, double *g) const
 Compatibility method with multi-dimensional interface for Gradient.
virtual bool HasGradient () const
double operator() (const double *x) const
 Evaluate the function at a point x[].
double operator() (double x) const

Private Member Functions

virtual double DoDerivative (double) const
 Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.
double DoEval (double x, double boundary, int sign) const

Private Attributes

double fBoundary
bool fInfiniteInterval
const IGenFunction * fIntegrand
ESemiInfinitySign fSign

#include <Math/GaussIntegrator.h>

Inheritance diagram for ROOT::Math::IntegrandTransform:
ROOT::Math::IBaseFunctionOneDim

Member Typedef Documentation

◆ BaseFunc

typedef IBaseFunctionOneDim ROOT::Math::IBaseFunctionOneDim::BaseFunc
inherited

Definition at line 161 of file IFunction.h.

Member Enumeration Documentation

◆ ESemiInfinitySign

enum ROOT::Math::IntegrandTransform::ESemiInfinitySign
Enumerator
kMinus 
kPlus 

Definition at line 236 of file GaussIntegrator.h.

Constructor & Destructor Documentation

◆ IntegrandTransform() [1/2]

ROOT::Math::IntegrandTransform::IntegrandTransform ( const IGenFunction * integrand)

Definition at line 225 of file GaussIntegrator.cxx.

◆ IntegrandTransform() [2/2]

ROOT::Math::IntegrandTransform::IntegrandTransform ( const double boundary,
ESemiInfinitySign sign,
const IGenFunction * integrand )

Definition at line 229 of file GaussIntegrator.cxx.

Member Function Documentation

◆ Clone()

IGenFunction * ROOT::Math::IntegrandTransform::Clone ( ) const
overridevirtual

Clone a function.

Each derived class will implement their version of the private DoClone method.

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 247 of file GaussIntegrator.cxx.

◆ Derivative() [1/2]

double ROOT::Math::IBaseFunctionOneDim::Derivative ( const double * x) const
inlineinherited

Compatibility method with multi-dimensional interface for partial derivative.

Definition at line 186 of file IFunction.h.

◆ Derivative() [2/2]

double ROOT::Math::IBaseFunctionOneDim::Derivative ( double x) const
inlineinherited

Return the derivative of the function at a point x Use the private method DoDerivative.

Definition at line 183 of file IFunction.h.

◆ DoDerivative()

virtual double ROOT::Math::IBaseFunctionOneDim::DoDerivative ( double ) const
inlineprivatevirtualinherited

Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.

Reimplemented in ROOT::Math::GradFunctor1D, ROOT::Math::Polynomial, and ROOT::Math::WrappedTF1.

Definition at line 210 of file IFunction.h.

◆ DoEval() [1/2]

double ROOT::Math::IntegrandTransform::DoEval ( double x) const
overridevirtual

implementation of the evaluation function. Must be implemented by derived classes

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 233 of file GaussIntegrator.cxx.

◆ DoEval() [2/2]

double ROOT::Math::IntegrandTransform::DoEval ( double x,
double boundary,
int sign ) const
private

Definition at line 238 of file GaussIntegrator.cxx.

◆ FdF() [1/2]

void ROOT::Math::IBaseFunctionOneDim::FdF ( const double * x,
double & f,
double * df ) const
inlineinherited

Compatibility method with multi-dimensional interface for Gradient and function evaluation.

Definition at line 202 of file IFunction.h.

◆ FdF() [2/2]

virtual void ROOT::Math::IBaseFunctionOneDim::FdF ( double x,
double & f,
double & df ) const
inlinevirtualinherited

Optimized method to evaluate at the same time the function value and derivative at a point x.

Often both value and derivatives are needed and it is often more efficient to compute them at the same time. Derived class should implement this method if performances play an important role and if it is faster to evaluate value and derivative at the same time.

Reimplemented in ROOT::Math::Polynomial, and ROOT::Math::WrappedTF1.

Definition at line 195 of file IFunction.h.

◆ Gradient()

void ROOT::Math::IBaseFunctionOneDim::Gradient ( const double * x,
double * g ) const
inlineinherited

Compatibility method with multi-dimensional interface for Gradient.

Definition at line 189 of file IFunction.h.

◆ HasGradient()

virtual bool ROOT::Math::IBaseFunctionOneDim::HasGradient ( ) const
inlinevirtualinherited

Reimplemented in ROOT::Math::IGradientFunctionOneDim.

Definition at line 179 of file IFunction.h.

◆ operator()() [1/2]

double ROOT::Math::IBaseFunctionOneDim::operator() ( const double * x) const
inlineinherited

Evaluate the function at a point x[].

Compatible method with multi-dimensional functions.

Definition at line 175 of file IFunction.h.

◆ operator()() [2/2]

double ROOT::Math::IntegrandTransform::operator() ( double x) const

Definition at line 243 of file GaussIntegrator.cxx.

Member Data Documentation

◆ fBoundary

double ROOT::Math::IntegrandTransform::fBoundary
private

Definition at line 245 of file GaussIntegrator.h.

◆ fInfiniteInterval

bool ROOT::Math::IntegrandTransform::fInfiniteInterval
private

Definition at line 246 of file GaussIntegrator.h.

◆ fIntegrand

const IGenFunction* ROOT::Math::IntegrandTransform::fIntegrand
private

Definition at line 244 of file GaussIntegrator.h.

◆ fSign

ESemiInfinitySign ROOT::Math::IntegrandTransform::fSign
private

Definition at line 243 of file GaussIntegrator.h.

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