cepgen
is hosted by
Hepforge
,
IPPP Durham
CepGen
1.2.5
Central exclusive processes event generator
Loading...
Searching...
No Matches
BoostTrapAnalyticalIntegrator.cpp
Go to the documentation of this file.
1
/*
2
* CepGen: a central exclusive processes event generator
3
* Copyright (C) 2022-2024 Laurent Forthomme
4
*
5
* This program is free software: you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License as published by
7
* the Free Software Foundation, either version 3 of the License, or
8
* any later version.
9
*
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
14
*
15
* You should have received a copy of the GNU General Public License
16
* along with this program. If not, see <http://www.gnu.org/licenses/>.
17
*/
18
19
#include <boost/math/quadrature/trapezoidal.hpp>
20
21
#include "
CepGen/Integration/AnalyticIntegrator.h
"
22
#include "
CepGen/Modules/AnalyticIntegratorFactory.h
"
23
#include "
CepGen/Utils/FunctionsWrappers.h
"
24
25
namespace
cepgen
{
27
class
BoostAnalyticalIntegrator
final :
public
AnalyticIntegrator
{
28
public
:
29
explicit
BoostAnalyticalIntegrator
(
const
ParametersList
& params)
30
:
AnalyticIntegrator
(params),
31
max_refinements_(
steerAs
<int, size_t>(
"limit"
)),
32
tol_(
steer
<double>(
"tolerance"
)) {}
33
34
static
ParametersDescription
description
() {
35
auto
desc =
AnalyticIntegrator::description
();
36
desc.setDescription(
"Boost trapezoidal integration algorithm"
);
37
desc.add<
int
>(
"limit"
, 1000).setDescription(
"maximum number of subintervals to build"
);
38
desc.add<
double
>(
"tolerance"
, 1.e-6).setDescription(
"maximal tolerance"
);
39
return
desc;
40
}
41
42
double
integrate
(
const
utils::Function1D
& func,
void
* =
nullptr
,
const
Limits
& lim = {})
const
override
{
43
const
double
xmin = (lim.hasMin() ? lim.min() :
range_
.
min
());
44
const
double
xmax = (lim.hasMax() ? lim.max() :
range_
.
max
());
45
return
boost::math::quadrature::trapezoidal(func, xmin, xmax, tol_, max_refinements_);
46
}
47
48
private
:
49
const
size_t
max_refinements_;
50
const
double
tol_;
51
};
52
}
// namespace cepgen
53
using
cepgen::BoostAnalyticalIntegrator
;
54
REGISTER_ANALYTIC_INTEGRATOR
(
"boost"
,
BoostAnalyticalIntegrator
);
AnalyticIntegratorFactory.h
REGISTER_ANALYTIC_INTEGRATOR
#define REGISTER_ANALYTIC_INTEGRATOR(name, obj)
Add a generic analytical integrator object builder definition.
Definition
AnalyticIntegratorFactory.h:25
AnalyticIntegrator.h
FunctionsWrappers.h
cepgen::AnalyticIntegrator
Analytic (functional) integration algorithm.
Definition
AnalyticIntegrator.h:32
cepgen::AnalyticIntegrator::range_
const Limits range_
Definition
AnalyticIntegrator.h:57
cepgen::AnalyticIntegrator::description
static ParametersDescription description()
Definition
AnalyticIntegrator.cpp:33
cepgen::BoostAnalyticalIntegrator
Trapezoidal integration algorithm.
Definition
BoostTrapAnalyticalIntegrator.cpp:27
cepgen::BoostAnalyticalIntegrator::BoostAnalyticalIntegrator
BoostAnalyticalIntegrator(const ParametersList ¶ms)
Definition
BoostTrapAnalyticalIntegrator.cpp:29
cepgen::BoostAnalyticalIntegrator::description
static ParametersDescription description()
Definition
BoostTrapAnalyticalIntegrator.cpp:34
cepgen::BoostAnalyticalIntegrator::integrate
double integrate(const utils::Function1D &func, void *=nullptr, const Limits &lim={}) const override
Evaluate the integral of a function at a given value.
Definition
BoostTrapAnalyticalIntegrator.cpp:42
cepgen::Limits
Validity interval for a variable.
Definition
Limits.h:28
cepgen::Limits::min
double min() const
Lower limit to apply on the variable.
Definition
Limits.h:52
cepgen::Limits::max
double max() const
Upper limit to apply on the variable.
Definition
Limits.h:54
cepgen::ParametersDescription
A description object for parameters collection.
Definition
ParametersDescription.h:26
cepgen::ParametersList
Definition
ParametersList.h:52
cepgen::Steerable::steerAs
U steerAs(const std::string &key) const
Retrieve a recasted parameters as previously steered.
Definition
Steerable.h:44
cepgen::Steerable::steer
T steer(const std::string &key) const
Retrieve a parameters as previously steered.
Definition
Steerable.h:39
cepgen::utils::Function1D
Wrapper to a 1-dimensional function with optional parameters.
Definition
FunctionsWrappers.h:29
cepgen
Common namespace for this Monte Carlo generator.
Definition
CommandLineHandler.cpp:36
CepGenAddOns
BoostWrapper
BoostTrapAnalyticalIntegrator.cpp
Generated on Mon Jul 29 2024 for CepGen by
1.9.7