BornAgain  1.19.79
Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering
RangedDistributionGaussian Class Reference

Description

Gaussian distribution with standard deviation std_dev.

Inheritance diagram for RangedDistributionGaussian:

Public Member Functions

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

Protected Member Functions

IDistribution1D * distribution_impl (double mean, double stddev) const override
 Returns underlying IDistribution1D object. More...
 

Constructor & Destructor Documentation

◆ RangedDistributionGaussian() [1/3]

RangedDistributionGaussian::RangedDistributionGaussian ( )

◆ RangedDistributionGaussian() [2/3]

RangedDistributionGaussian::RangedDistributionGaussian ( size_t  n_samples,
double  sigma_factor,
const RealLimits limits = RealLimits::limitless() 
)

◆ RangedDistributionGaussian() [3/3]

RangedDistributionGaussian::RangedDistributionGaussian ( 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).

◆ ~RangedDistributionGaussian()

RangedDistributionGaussian::~RangedDistributionGaussian ( )
overridedefault

Member Function Documentation

◆ clone()

RangedDistributionGaussian* RangedDistributionGaussian::clone ( ) const
override

◆ distribution_impl()

IDistribution1D* RangedDistributionGaussian::distribution_impl ( double  mean,
double  stddev 
) const
overrideprotected

Returns underlying IDistribution1D object.

◆ name()

std::string RangedDistributionGaussian::name ( ) const
override

Returns distribution name for python-formatted text.