Ceylan::Maths::Random::NormalProbabilityFunction Class Reference

Probability function used for gaussian (normal) distributions. More...

#include <CeylanNormalProbability.h>

Inheritance diagram for Ceylan::Maths::Random::NormalProbabilityFunction:

[legend]

Collaboration diagram for Ceylan::Maths::Random::NormalProbabilityFunction:

[legend]

List of all members.

Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	NormalProbabilityFunction (Sample mean, Deviation sigma)
	Creates the distribution.
virtual	~NormalProbabilityFunction () throw ()
	Basic virtual destructor.
virtual Probability	operator() (Sample aSample) const
	The callable method, returns the probability that this sample is realized.
virtual const std::string	toString (VerbosityLevels level=high) const
	Returns a user-friendly description of the state of this object.
Static Public Member Functions
static const std::string	ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
	Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat	GetOutputFormat ()
	Returns the current overall text format to be used by TextDisplayable instances.
static void	SetOutputFormat (TextOutputFormat newOutputFormat)
	Sets the current overall text format to be used by TextDisplayable instances.
Protected Attributes
Sample	_mean
	The mean value for the normal law.
Deviation	_sigma
	The standard deviation for the normal law.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.

Detailed Description

Probability function used for gaussian (normal) distributions.

Definition at line 55 of file CeylanNormalProbability.h.

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

Constructor & Destructor Documentation

NormalProbabilityFunction::NormalProbabilityFunction	(	Sample	mean,
		Deviation	sigma
	)

Creates the distribution.

Parameters:

	mean	the mean value
	sigma	the standard deviation, must not be null or almost null.

Exceptions:

MathsException

if sigma is zero.

Definition at line 41 of file CeylanNormalProbability.cc.

References _sigma, and Ceylan::Maths::IsNull().

NormalProbabilityFunction::~NormalProbabilityFunction ( ) throw () [virtual]

Basic virtual destructor.

Definition at line 56 of file CeylanNormalProbability.cc.

Member Function Documentation

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat ( ) [static, inherited]

Returns the current overall text format to be used by TextDisplayable instances.

Definition at line 63 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().

Probability NormalProbabilityFunction::operator() ( Sample aSample ) const [virtual]

The callable method, returns the probability that this sample is realized.

For normal law, it is:

P(x) = exp( -1/2*((x-mean)/sigma)�) / (sigma * sqrt(2.Pi))

Implements Ceylan::Maths::Random::ProbabilityFunction.

Definition at line 63 of file CeylanNormalProbability.cc.

References _mean, _sigma, Ceylan::Maths::Exp(), Ceylan::Maths::Pi, Ceylan::Maths::Pow(), and Ceylan::Maths::Sqrt().

void TextDisplayable::SetOutputFormat ( TextOutputFormat newOutputFormat ) [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:

newOutputFormat

the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

const std::string TextDisplayable::ToString	(	std::list< TextDisplayable * >	displayables,
		Ceylan::VerbosityLevels	level = `Ceylan::high`
	)			`[static, inherited]`