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

Cosine distribution. More...

+ Inheritance diagram for RangedDistributionCosine:

Public Member Functions

 RangedDistributionCosine (size_t n_samples, double sigma_factor, const RealLimits &limits=RealLimits::limitless())
 
 RangedDistributionCosine (size_t n_samples, double sigma_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...
 
RangedDistributionCosineclone () const override
 
std::string name () const override
 Returns distribution name for python-formatted text.
 

Protected Member Functions

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

Detailed Description

Cosine distribution.

Constructor & Destructor Documentation

◆ RangedDistributionCosine()

RangedDistributionCosine::RangedDistributionCosine ( size_t  n_samples,
double  sigma_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, sigma_factor = 2.0, while the limits are (-inf, +inf).