This class implements a stochastic function with a int uniform law in [a,b] implemented from the std library. More...

#include <RNDSTD_UniformIntDistribution.h>

Inheritance diagram for RNDSTD_UniformIntDistribution:

[legend]

Collaboration diagram for RNDSTD_UniformIntDistribution:

[legend]

Public Member Functions
	RNDSTD_UniformIntDistribution ()
	create an object

virtual	~RNDSTD_UniformIntDistribution (void)
	destroy an object.

virtual tMemSize	getMemorySize () const
	return the memory size of the class and the memory size of all its attributes/associations More...

virtual tMemSize	getContentsMemorySize () const
	return the memory size of the included associations More...

void	setSupport (const T &a, const T &b)
	set the support of the random function More...

void	setProperties (const tReal &mean, const tReal &sd)
	set the properties of the stochastic futcion More...

Public Member Functions inherited from RAND_RandomNumberDistribution< tRelativeInteger, std::uniform_int_distribution< tRelativeInteger >, RNDSTD_UniformIntDistribution >
tRelativeInteger	random (RAND_RandomNumberGenerator< T1, G, D1 > &generator)
	random a number More...

std::uniform_int_distribution< tRelativeInteger > &	getDistribution ()
	get distribution More...

tRelativeInteger	minValue () const
	return the min value

tRelativeInteger	maxValue () const
	return the max value

tReal	pdf (const tRelativeInteger &x) const
	return the probility density function More...

tReal	cdf (const tRelativeInteger &x) const
	return the cumulative density function More...

tReal	icdf (const tRelativeInteger &y) const
	return the inverse of the cumulative density function More...

Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T >	getSharedPointer ()
	return the shared pointer for this More...

template<class T >
std::shared_ptr< const T >	getConstSharedPointer () const
	return a const shared pointer for this More...

template<class T >
tBoolean	isInstanceOf () const
	test if the clas T is an instance of this class More...

tString	getClassName () const
	return the name of the class More...

tString	getPointerString () const
	retrun the pointer of the class as a string More...

tString	getIdentityString () const
	retrun the string identification of the class More...

virtual tString	toString () const
	return the string representation of the object node More...

Static Public Member Functions
static CORE_UniquePointer< RNDSTD_UniformIntDistribution >	New ()
	build a new instance of the stochasticfunction More...

Static Public Member Functions inherited from CORE_Object
static tBoolean	EnableMemoryStack (const tBoolean &isMemoryChecked)
	enable the memory stack More...

static void	EnableMemoryStack ()
	enable the memory stack

static void	DisableMemoryStack ()
	disable the memory stack

static tBoolean	IsMemoryStackEnabled ()
	return trur if the memory stack is enabled

static tString	MemoryStackToString ()
	get the memory stack in string More...

static tIndex	GetRegisteredClassesNumber ()
	get the memory stack in string More...

Additional Inherited Members
Protected Member Functions inherited from RAND_RandomNumberDistribution< tRelativeInteger, std::uniform_int_distribution< tRelativeInteger >, RNDSTD_UniformIntDistribution >
	RAND_RandomNumberDistribution (void)
	create

virtual	~RAND_RandomNumberDistribution (void)
	destroy

void	initialize (std::uniform_int_distribution< tRelativeInteger > &dist)
	initiliaze generator

Protected Member Functions inherited from RAND_Object
	RAND_Object (void)
	create the class

virtual	~RAND_Object (void)
	delete the class

Protected Member Functions inherited from CORE_Object
	CORE_Object ()
	build an instance of the object

virtual	~CORE_Object ()
	destroy the instance of object std

Detailed Description

This class implements a stochastic function with a int uniform law in [a,b] implemented from the std library.

Author: Stephane Despreaux

Version: 1.0

Member Function Documentation

◆ getContentsMemorySize()

virtual tMemSize RNDSTD_UniformIntDistribution::getContentsMemorySize ( ) const

inlinevirtual

return the memory size of the included associations

Returns: the memory size of the storage in bytes 1 Kb = 1024 bytes 1 Mb = 1024 Kb 1 Gb = 1024 Mb 1 Tb = 1024 Gb 1 Hb = 1024 Tb

Reimplemented from RAND_RandomNumberDistribution< tRelativeInteger, std::uniform_int_distribution< tRelativeInteger >, RNDSTD_UniformIntDistribution >.

◆ getMemorySize()

virtual tMemSize RNDSTD_UniformIntDistribution::getMemorySize ( ) const

inlinevirtual

return the memory size of the class and the memory size of all its attributes/associations

Returns

the memory size of the class and the memory size of its attributes/associations in bytes The mamory size is :

the added size of the base classes which contains:
- the primary attributes size depends on the order: (first delare the smallest attributes size
- all virtual functions costs <pointer-size> (4 32xor 8 64x) bytes by virtual function
- virtual inherihtance will increase of (4 or 8) bytes
we add the size of the contains values of the attributes : for example the size of a string is the length of the string 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from RAND_RandomNumberDistribution< tRelativeInteger, std::uniform_int_distribution< tRelativeInteger >, RNDSTD_UniformIntDistribution >.

◆ New()

static CORE_UniquePointer<RNDSTD_UniformIntDistribution> RNDSTD_UniformIntDistribution::New ( )

inlinestatic

build a new instance of the stochasticfunction

Returns: an unique pointer of the stochastic function

◆ setProperties()

void RNDSTD_UniformIntDistribution::setProperties	(	const tReal &	mean,
		const tReal &	sd
	)

inline

set the properties of the stochastic futcion

Parameters

[in]	mean	: mean of the random function
[in]	sd	: standart deviation of the random function

\( E=\frac{a+b}{2}\)
\( S_d=\frac{b-a}{2.\sqrt{3}} \)

In the reverse way:

\( a=E-\sqrt{3} S_d \)
\( b=E+\sqrt{3} S_d \)

◆ setSupport()

void RNDSTD_UniformIntDistribution::setSupport	(	const T &	a,
		const T &	b
	)

inline

set the support of the random function

Parameters

[in]	a	min value of the uniform random value
[in]	b	max value of the uniform random value

The documentation for this class was generated from the following file:

/home/despreau/Developpement/CPP/devcpp20/include/math/random/std/RNDSTD_UniformIntDistribution.h

Public Member Functions

Static Public Member Functions