Foam general-purpose integration algorithm as developed by S. Jadach (Institute of Nuclear Physics, Krakow, PL) More...

Inheritance diagram for FoamIntegrator:

Collaboration diagram for FoamIntegrator:

Public Member Functions
	FoamIntegrator (const ParametersList &params)

Value	integrate (Integrand &integrand) override
	Perform the multidimensional Monte Carlo integration.

double	Density (int ndim, double *x) override
	Compute the weight for a given phase space point.

void	checkLimits (const Integrand &)
	Ensure the integration bounds are properly set.

virtual void	setLimits (const std::vector< Limits > &limits)
	Specify the variables limits on integration.

virtual double	eval (Integrand &, const std::vector< double > &) const
	Compute the function value at the given phase space point.

virtual double	uniform (const Limits &={0., 1.}) const
	Generate a uniformly distributed (between 0 and 1) random number.

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 ParametersList &	parameters () 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 ()

static Value	integrate (const std::function< double(const std::vector< double > &)> &, const ParametersList &, size_t)
	Perform an integration with a given functional and a given set of parameters.

static Value	integrate (const std::function< double(const std::vector< double > &)> &, const ParametersList &, const std::vector< Limits > &)
	Perform an integration with a given functional and a given set of parameters.

Protected Member Functions
template<typename T >
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 std::unique_ptr< utils::RandomGenerator >	rnd_gen_

int	verbosity_
	Integrator verbosity.

std::vector< Limits >	limits_
	List of per-variable integration limits.

const std::string	name_
	Module unique indexing name.

ParametersList	params_
	Module parameters.

Detailed Description

Definition at line 33 of file FoamIntegrator.cpp.

Constructor & Destructor Documentation

◆ FoamIntegrator()

FoamIntegrator ( const ParametersList & params )

explicit

Definition at line 35 of file FoamIntegrator.cpp.

Member Function Documentation

◆ checkLimits()

void checkLimits ( const Integrand & integrand )

inherited

Definition at line 32 of file Integrator.cpp.

◆ Density()

double Density	(	int	ndim,
		double *	x
	)

override

Definition at line 105 of file FoamIntegrator.cpp.

◆ description()

static ParametersDescription description ( )

static

Definition at line 37 of file FoamIntegrator.cpp.

◆ eval()

double eval	(	Integrand &	integrand,
		const std::vector< double > &	x
	)		const

virtualinherited

Definition at line 52 of file Integrator.cpp.

◆ integrate() [1/3]

Value integrate	(	const std::function< double(const std::vector< double > &)> &	func,
		const ParametersList &	params,
		const std::vector< Limits > &	limits
	)

staticinherited

Definition at line 62 of file Integrator.cpp.

◆ integrate() [2/3]

Value integrate	(	const std::function< double(const std::vector< double > &)> &	func,
		const ParametersList &	params,
		size_t	num_vars
	)

staticinherited

Definition at line 56 of file Integrator.cpp.

◆ integrate() [3/3]

Value integrate ( Integrand & result )

overridevirtual

Parameters

[out] result integral computed over the full phase space

Implements Integrator.

Definition at line 50 of file FoamIntegrator.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.

◆ setLimits()

virtual void setLimits ( const std::vector< Limits > & limits )

virtualinherited

Reimplemented in GSLIntegrator, BasesIntegrator, NaiveBoostIntegrator, Integrator, and Integrator.

Definition at line 38 of file Integrator.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.

◆ uniform()

double uniform ( const Limits & lim = {0., 1.} ) const

virtualinherited

Definition at line 54 of file Integrator.cpp.

Member Data Documentation

◆ limits_

std::vector<Limits> limits_

protectedinherited

Definition at line 58 of file Integrator.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.

◆ rnd_gen_

const std::unique_ptr<utils::RandomGenerator> rnd_gen_

protectedinherited

Definition at line 56 of file Integrator.h.

◆ verbosity_

int verbosity_

protectedinherited

Definition at line 57 of file Integrator.h.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FoamIntegrator()

Member Function Documentation

◆ checkLimits()

◆ Density()

◆ description()

◆ eval()

◆ integrate() [1/3]

◆ integrate() [2/3]

◆ integrate() [3/3]

◆ name()

◆ operator!=()

◆ operator==()

◆ parameters()

◆ setDescribedParameters()

◆ setLimits()

◆ setParameters()

◆ steer()

◆ steerAs()

◆ steerName()

◆ steerPath()

◆ uniform()

Member Data Documentation

◆ limits_

◆ name_

◆ params_

◆ rnd_gen_

◆ verbosity_