hep-mc  0.8
Public Member Functions | List of all members
hep::distribution_parameters< T > Class Template Reference
Differential Distributions

Detailed Description

template<typename T>
class hep::distribution_parameters< T >

Defines the parameters of a one- or two-dimensional distribution.

Examples:
two_dimensional_distribution.cpp.

Public Member Functions

 distribution_parameters (std::size_t bins_x, std::size_t bins_y, T x_min, T x_max, T y_min, T y_max, std::string const &name)
 
 distribution_parameters (std::size_t bins, T x_min, T x_max, std::string const &name)
 
 distribution_parameters (std::istream &in)
 
std::size_t bins_x () const
 
std::size_t bins_y () const
 
std::string const & name () const
 
T x_min () const
 
T y_min () const
 
T bin_size_x () const
 
T bin_size_y () const
 
void serialize (std::ostream &out) const
 

Constructor & Destructor Documentation

◆ distribution_parameters() [1/3]

template<typename T >
hep::distribution_parameters< T >::distribution_parameters ( std::size_t  bins_x,
std::size_t  bins_y,
T  x_min,
T  x_max,
T  y_min,
T  y_max,
std::string const &  name 
)
inline

Constructor. Constructs a two dimensional distribution.

◆ distribution_parameters() [2/3]

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

Constructor. Constructs a one-dimensional distribution.

◆ distribution_parameters() [3/3]

template<typename T >
hep::distribution_parameters< T >::distribution_parameters ( std::istream &  in)
inlineexplicit

Deserialization constructor.

Member Function Documentation

◆ bin_size_x()

template<typename T >
T hep::distribution_parameters< T >::bin_size_x ( ) const
inline

Size of the bins in x-direction.

◆ bin_size_y()

template<typename T >
T hep::distribution_parameters< T >::bin_size_y ( ) const
inline

Size of the bins in y-direction.

◆ bins_x()

template<typename T >
std::size_t hep::distribution_parameters< T >::bins_x ( ) const
inline

Returns the number of bins in x-direction.

◆ bins_y()

template<typename T >
std::size_t hep::distribution_parameters< T >::bins_y ( ) const
inline

Returns the number of bins in y-direction.

◆ name()

template<typename T >
std::string const& hep::distribution_parameters< T >::name ( ) const
inline

Name of the distribution.

◆ serialize()

template<typename T >
void hep::distribution_parameters< T >::serialize ( std::ostream &  out) const
inline

Serializes this object.

◆ x_min()

template<typename T >
T hep::distribution_parameters< T >::x_min ( ) const
inline

Smallest x-value of a point that would still be accumulated into the distribution.

◆ y_min()

template<typename T >
T hep::distribution_parameters< T >::y_min ( ) const
inline

Smallest y-value of a point that would still be accumulated into the distribution.