hep-mc  0.8
Classes | Functions
Differential Distributions

Detailed Description

Generation and interpretation of differential distributions.

The generation of distributions can be done automatically if the integrand accepts a projector that specifies how the values of the integrand are binned and, during integrand creation, if the distribution parameters are correctly specified. The result of each integration algorithm (derived from plain_result) will then contain a vector of distribution_result entries that each contain the result of a separate distribution. Since version 0.8 these distributions can be two-dimensional.

The distributions that are generated are differential distributions, meaning that each bin contains the integral for this bin divided by the bin size.

Classes

class  hep::distribution_parameters< T >
 
class  hep::distribution_result< T >
 
class  hep::projector< T >
 

Functions

template<typename T >
distribution_parameters< T > hep::make_dist_params (std::size_t bins, T x_min, T x_max, std::string const &name="")
 
template<typename T >
std::vector< T > hep::mid_points_x (distribution_result< T > const &result)
 
template<typename T >
std::vector< T > hep::mid_points_y (distribution_result< T > const &result)
 

Function Documentation

◆ make_dist_params()

template<typename T >
distribution_parameters<T> hep::make_dist_params ( std::size_t  bins,
x_min,
x_max,
std::string const &  name = "" 
)

Shortcut for calling the constructor that automatically determines the numeric type.

Examples:
distributions_example.cpp.

◆ mid_points_x()

template<typename T >
std::vector<T> hep::mid_points_x ( distribution_result< T > const &  result)
inline

Returns the middle point of each bin of this distribution in the x-direction.

Examples:
distributions_example.cpp, and two_dimensional_distribution.cpp.

◆ mid_points_y()

template<typename T >
std::vector<T> hep::mid_points_y ( distribution_result< T > const &  result)
inline

Returns the middle point of each bin of this distribution in the y-direction.

Examples:
two_dimensional_distribution.cpp.