BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
RangedDistributionLorentz Class Reference

Lorentz distribution with median and hwhm. More...

+ Inheritance diagram for RangedDistributionLorentz:

Public Member Functions

 RangedDistributionLorentz (size_t n_samples, double hwhm_factor, const RealLimits &limits=RealLimits::limitless())
 
 RangedDistributionLorentz (size_t n_samples, double hwhm_factor, double min, double max)
 Initializes Ranged distribution with given number of samples, sigma factor (range in standard deviations to take into account during sample generation) and limits (either RealLimits object or just min and max limits). More...
 
RangedDistributionLorentzclone () const override
 
std::string name () const override
 Returns distribution name for python-formatted text.
 

Protected Member Functions

std::unique_ptr< IDistribution1D > distribution_impl (double median, double hwhm) const override
 Returns underlying IDistribution1D object.
 

Detailed Description

Lorentz distribution with median and hwhm.

Constructor & Destructor Documentation

◆ RangedDistributionLorentz()

RangedDistributionLorentz::RangedDistributionLorentz ( size_t  n_samples,
double  hwhm_factor,
double  min,
double  max 
)

Initializes Ranged distribution with given number of samples, sigma factor (range in standard deviations to take into account during sample generation) and limits (either RealLimits object or just min and max limits).

By default n_samples = 5, hwhm_factor = 2.0, while the limits are (-inf, +inf).