cepgen is hosted by Hepforge, IPPP Durham
CepGen 1.2.3
A generic central exclusive processes event generator
Loading...
Searching...
No Matches
BoostGaussLegendreAnalyticalIntegrator< N > Class Template Referencefinal

Gauss-Legendre integration algorithm. More...

+ Inheritance diagram for BoostGaussLegendreAnalyticalIntegrator< N >:
+ Collaboration diagram for BoostGaussLegendreAnalyticalIntegrator< N >:

Public Member Functions

 BoostGaussLegendreAnalyticalIntegrator (const ParametersList &params)
 
double integrate (const utils::Function1D &func, void *=nullptr, const Limits &lim={}) const override
 Evaluate the integral of a function at a given value.
 
double integrate (const std::function< double(double)> &func, const Limits &range={}) const
 Evaluate the integral of a function at a given value.
 
template<typename T >
double integrate (const utils::Function1D &func, const T &obj, const Limits &range={}) const
 Evaluate the integral of a function at a given value.
 
const std::string & name () const
 Module unique indexing name.
 
bool operator== (const SteeredObject &oth) const
 Equality operator.
 
bool operator!= (const SteeredObject &oth) const
 Inequality operator.
 
const ParametersListparameters () const override
 Module user-defined parameters.
 
virtual void setParameters (const ParametersList &params) override
 Set module parameters.
 
void setDescribedParameters (const ParametersList &params_orig)
 Set (documented) module parameters.
 

Static Public Member Functions

static ParametersDescription description ()
 

Protected Member Functions

template<typename T >
steer (const std::string &key) const
 Retrieve a parameters as previously steered.
 
template<typename T , typename U >
U steerAs (const std::string &key) const
 Retrieve a recasted parameters as previously steered.
 
std::string steerName () const
 Retrieve module name from parameters.
 
std::string steerPath (const std::string &key) const
 Retrieve a path from common search paths.
 

Protected Attributes

const Limits range_
 
const ParametersList func_params_
 
const int verbosity_
 Integrator verbosity.
 
const std::string name_
 Module unique indexing name.
 
ParametersList params_
 Module parameters.
 

Detailed Description

template<size_t N>
class cepgen::BoostGaussLegendreAnalyticalIntegrator< N >

Definition at line 28 of file BoostGaussLegendreAnalyticalIntegrator.cpp.

Constructor & Destructor Documentation

◆ BoostGaussLegendreAnalyticalIntegrator()

template<size_t N>
BoostGaussLegendreAnalyticalIntegrator ( const ParametersList params)
explicit

Definition at line 30 of file BoostGaussLegendreAnalyticalIntegrator.cpp.

Member Function Documentation

◆ description()

template<size_t N>
static ParametersDescription description ( )
static

Definition at line 32 of file BoostGaussLegendreAnalyticalIntegrator.cpp.

◆ integrate() [1/3]

double integrate ( const std::function< double(double)> &  func,
const Limits range = {} 
) const
inherited
Parameters
[in]funcfunction to integrate
[in]range(optional) integration range

Definition at line 29 of file AnalyticIntegrator.cpp.

◆ integrate() [2/3]

template<typename T >
double integrate ( const utils::Function1D func,
const T &  obj,
const Limits range = {} 
) const
inherited
Parameters
[in]funcfunction to integrate
[in]objspecific parameters object
[in]range(optional) integration range

Definition at line 47 of file AnalyticIntegrator.h.

◆ integrate() [3/3]

template<size_t N>
double integrate ( const utils::Function1D func,
void *  obj = nullptr,
const Limits range = {} 
) const
overridevirtual
Parameters
[in]funcfunction to integrate
[in]obj(optional) parameters object
[in]range(optional) integration range

Implements AnalyticIntegrator.

Definition at line 38 of file BoostGaussLegendreAnalyticalIntegrator.cpp.

◆ name()

const std::string & name ( ) const
inherited

Definition at line 42 of file NamedModule.h.

◆ operator!=()

template<typename T >
bool operator!= ( const SteeredObject< T > &  oth) const
inherited

Definition at line 51 of file SteeredObject.h.

◆ operator==()

template<typename T >
bool operator== ( const SteeredObject< T > &  oth) const
inherited

Definition at line 49 of file SteeredObject.h.

◆ parameters()

template<typename T >
const ParametersList & parameters ( ) const
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

◆ setDescribedParameters()

template<typename T >
void setDescribedParameters ( const ParametersList params_orig)
inherited

Definition at line 73 of file SteeredObject.h.

◆ setParameters()

template<typename T >
virtual void setParameters ( const ParametersList params)
overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

◆ steer()

template<typename T >
T steer ( const std::string &  key) const
protectedinherited

Definition at line 39 of file Steerable.h.

◆ steerAs()

template<typename T , typename U >
U steerAs ( const std::string &  key) const
protectedinherited

Definition at line 44 of file Steerable.h.

◆ steerName()

std::string steerName ( ) const
protectedinherited

Definition at line 48 of file Steerable.h.

◆ steerPath()

std::string steerPath ( const std::string &  key) const
protectedinherited

Definition at line 30 of file Steerable.cpp.

Member Data Documentation

◆ func_params_

const ParametersList func_params_
protectedinherited

Definition at line 58 of file AnalyticIntegrator.h.

◆ name_

const std::string name_
protectedinherited

Definition at line 45 of file NamedModule.h.

◆ params_

ParametersList params_
mutableprotectedinherited

Definition at line 50 of file Steerable.h.

◆ range_

const Limits range_
protectedinherited

Definition at line 57 of file AnalyticIntegrator.h.

◆ verbosity_

const int verbosity_
protectedinherited

Definition at line 59 of file AnalyticIntegrator.h.