Description

Lorentz distribution with median and hwhm.

Inheritance diagram for RangedDistributionLorentz:

Public Member Functions
	RangedDistributionLorentz ()

	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). By default n_samples = 5, hwhm_factor = 2.0, while the limits are (-inf, +inf). More...

	~RangedDistributionLorentz () override=default

RangedDistributionLorentz *	clone () const override

std::string	name () const override
	Returns distribution name for python-formatted text. More...

Protected Member Functions
IDistribution1D *	distribution_impl (double median, double hwhm) const override
	Returns underlying IDistribution1D object. More...

Constructor & Destructor Documentation

◆ RangedDistributionLorentz() [1/3]

RangedDistributionLorentz::RangedDistributionLorentz ( )

◆ RangedDistributionLorentz() [2/3]

RangedDistributionLorentz::RangedDistributionLorentz	(	size_t	n_samples,
		double	hwhm_factor,
		const RealLimits &	limits = `RealLimits::limitless()`
	)

◆ RangedDistributionLorentz() [3/3]

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).

◆ ~RangedDistributionLorentz()

RangedDistributionLorentz::~RangedDistributionLorentz ( )

overridedefault

Member Function Documentation

◆ clone()

RangedDistributionLorentz* RangedDistributionLorentz::clone ( ) const

override

◆ distribution_impl()

IDistribution1D* RangedDistributionLorentz::distribution_impl	(	double	median,
		double	hwhm
	)		const

overrideprotected

Returns underlying IDistribution1D object.

◆ name()

std::string RangedDistributionLorentz::name ( ) const