Description of a variety of different statistical distribution. More...

#include "DistributionDescription.hpp"

Inheritance diagram for DistributionDescription:

Public Types
enum	Distribution { none, normal, chiSquare, exponential, fisher, poisson, rayleigh, students }
	supported distributions More...

enum	Value { nummeric, min, max, mean, median, mode, stdDev, stdDevMAD, rms, skewness }
	supported distributions

Public Member Functions
	DistributionDescription (const opals::String &rep)

	DistributionDescription (Distribution type, double param1)
	initialize single parameter distributions

	DistributionDescription (Distribution type, Value param1)
	initialize single parameter distributions

	DistributionDescription (Distribution type, double param1, double param2)
	initialize dual parameter distributions

	DistributionDescription (Distribution type, Value param1, double param2)
	initialize dual parameter distributions

	DistributionDescription (Distribution type, Value param1, Value param2)
	initialize dual parameter distributions

bool	isEmpty () const

void	reset ()

Distribution	getDistribution () const

unsigned	getParamCount () const

double	getParamValue (unsigned idx) const

Value	getParamType (unsigned idx) const

DistributionDescription	copyFill (double min, double max, double mean, double median, double mode, double stdDev, double stdDevMAD, double rms, double skewness) const
	creates new DistributionDescription object and fill in all non numeric parameters with the given values

void	setDistribution (Distribution type)

void	setParam (unsigned degrees_of_freedom1)

void	setParam (unsigned degrees_of_freedom1, unsigned degrees_of_freedom2)

void	setParam (double param1)

void	setParam (Value param1, Value param2)

void	setParam (Value param1, double param2)

void	setParam (double param1, double param2)

void	setParam (double param1, Value param2)

void	validate () const
	validates combination of parameters and throws exception if they are invalid

void	setNormal (Value mean, Value stdDev)

void	setNormal (Value mean, double stdDev)

void	setNormal (double mean, double stdDev)

void	setNormal (double mean, Value stdDev)

void	setChiSquare (unsigned degrees_of_freedom)

void	setExponential (double lambda)

void	setExponential (Value lambda)

void	setFisher (unsigned degrees_of_freedom1, unsigned degrees_of_freedom2)

void	setPoisson (double mean)

void	setPoisson (Value mean)

void	setRayleigh (Value sigma)

void	setStudents (unsigned degrees_of_freedom)

Static Public Member Functions
static const char *	help (bool)

static const char *	syntax ()

static bool	exportsPythonType ()

Static Public Member Functions inherited from CustomOptionType< DistributionDescription >
static const char *	_help (bool forDoxygen)
	get general help on this type

static const char *	_syntax ()
	get the syntax used for parsing this type

static bool	_exportsPythonType ()
	returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)

Protected Member Functions
void	clearParam ()

void	addValue (Value v)

void	addValue (double v)

void	addValue (unsigned v)

Protected Member Functions inherited from CustomOptionType< DistributionDescription >
	~CustomOptionType ()
	protected, must be derived from

Protected Attributes
Distribution	distribution

opals::Vector< Value >	valueTypes

opals::Vector< double >	nummericValues

Friends
struct	DistributionDescriptionAccess

Detailed Description

Description of a variety of different statistical distribution.

Author: JO

Date: 01.09.2023

Member Enumeration Documentation

◆ Distribution

enum Distribution

strong

supported distributions

Enumerator
normal	Normal (Gaussian) Distribution (2 parameters: mean, stdDev)
chiSquare	Chi Squared Distribution (1 parameter: degrees of freedom)
exponential	Exponential Distribution (1 parameter: lambda)
fisher	F Distribution (2 parameters: degrees of freedom1, degrees of freedom2)
poisson	Poisson Distribution (1 parameter: mean)
rayleigh	Rayleigh Distribution (1 parameter: sigma)
students	Students t Distribution (1 parameter: degrees of freedom)

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Distribution