This class describes a stochastic functions based on same random number generator which implement random methods. More...

#include <SM_StochasticFunctionsInterface.h>

Inheritance diagram for SM_StochasticFunctionsInterface:

[legend]

Collaboration diagram for SM_StochasticFunctionsInterface:

[legend]

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

virtual void	setSeed (const tULLInt &seed)=0
	void set seed More...

virtual void	setSeed ()=0
	set seed

virtual void	jump (const tInteger &jumps, const tULLInt &seed)=0
	jump a number of virtual random number generator More...

virtual tReal	normalRandom ()=0
	compute a normal random number More...

virtual tReal	uniformRandom ()=0
	compute a uniform random number in [0,1] More...

Public Member Functions inherited from SM_Object
	SM_Object (void)
	create

virtual	~SM_Object (void)
	destroy

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

virtual tMemSize	getContentsMemorySize () const
	return nthe memory size of the included associations 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 tBoolean	IsThreadSafe ()
	set if the stochastic function is thread safe

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

Protected Member Functions
	SM_StochasticFunctionsInterface (void)
	create

virtual	~SM_StochasticFunctionsInterface (void)
	destroy

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

virtual	~CORE_Object ()
	destroy the instance of object std

Static Protected Member Functions
static void	SetIsThreadSafe (const tBoolean &b)
	set if the sochastic function is thread safe More...

Detailed Description

This class describes a stochastic functions based on same random number generator which implement random methods.

It defines the virtual abstract methods:

normalRandom() : generate normal distribution
uniformRandom() : generate uniform distribution
setSeed() initialize the seed
jump() to simulate random numbes without doing it

Author: Stephane Despreaux

Version: 1.0

Member Function Documentation

◆ getMemorySize()

virtual tMemSize SM_StochasticFunctionsInterface::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 SM_Object.

◆ jump()

virtual void SM_StochasticFunctionsInterface::jump	(	const tInteger &	jumps,
		const tULLInt &	seed
	)

pure virtual

jump a number of virtual random number generator

Parameters

[in]	jumps	number of jumps to do
[in]	seed	default seed if the jump method is not implemented

Implemented in SM_BoostStochasticFunctions< G >, SM_TRNGStochasticFunctions< G >, SM_TRNGStochasticFunctions_MT19937, SM_STDStochasticFunctions< G >, and SM_MTStochasticFunctions< G >.

◆ normalRandom()

virtual tReal SM_StochasticFunctionsInterface::normalRandom ( )

pure virtual

compute a normal random number

Returns: a random number

Implemented in SM_StochasticFunctions< I >, SM_StochasticFunctions< SM_MTStochasticFunctions< G > >, SM_StochasticFunctions< SM_TRNGStochasticFunctions_MT19937 >, SM_StochasticFunctions< SM_STDStochasticFunctions< G > >, SM_StochasticFunctions< SM_TRNGStochasticFunctions< G > >, and SM_StochasticFunctions< SM_BoostStochasticFunctions< G > >.

◆ SetIsThreadSafe()

static void SM_StochasticFunctionsInterface::SetIsThreadSafe ( const tBoolean & b )

inlinestaticprotected

set if the sochastic function is thread safe

Parameters

[in] b : true if the stochastic random function can be parallelelized with openmp

◆ setSeed()

virtual void SM_StochasticFunctionsInterface::setSeed ( const tULLInt & seed )

pure virtual

void set seed

Parameters

[in] seed : initial seed of the stochastic function

Implemented in SM_TRNGStochasticFunctions_MT19937, SM_TRNGStochasticFunctions< G >, SM_STDStochasticFunctions< G >, SM_MTStochasticFunctions< G >, and SM_BoostStochasticFunctions< G >.

◆ uniformRandom()

virtual tReal SM_StochasticFunctionsInterface::uniformRandom ( )

pure virtual

compute a uniform random number in [0,1]

Returns: a random number

Implemented in SM_StochasticFunctions< I >, SM_StochasticFunctions< SM_MTStochasticFunctions< G > >, SM_StochasticFunctions< SM_TRNGStochasticFunctions_MT19937 >, SM_StochasticFunctions< SM_STDStochasticFunctions< G > >, SM_StochasticFunctions< SM_TRNGStochasticFunctions< G > >, and SM_StochasticFunctions< SM_BoostStochasticFunctions< G > >.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/core/SM_StochasticFunctionsInterface.h
/home/despreau/Developpement/CPP/devcpp20/src/stochmagnet/core/SM_StochasticFunctionsInterface.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ getMemorySize()

◆ jump()

◆ normalRandom()

◆ SetIsThreadSafe()

◆ setSeed()

◆ uniformRandom()