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

#include <SM_MultiStochasticFunctionsInterface.h>

Inheritance diagram for SM_MultiStochasticFunctionsInterface:

[legend]

Collaboration diagram for SM_MultiStochasticFunctionsInterface:

[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 tMemSize	getContentsMemorySize () const
	return nthe memory size of the included associations More...

virtual SM_StochasticFunctionsInterface &	operator() (const tInteger &threadId)=0
	operator for getting stochatic function at thread id More...

virtual tInteger	getSize () const =0
	get the number of stochastic functions More...

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

virtual void	setSeed ()=0
	set seed

virtual void	randomSeed (const tInteger &coresNumber, const tInteger &coreIndex)=0
	jump a number of virtual random number generator More...

virtual void	jump (const tInteger &coresNumber, const tInteger &coreIndex, const tULLInt &jumpsNumber, const tULLInt &nRNGs)=0
	jump a number of virtual random number generator More...

tBoolean	isThreadSafe () const
	return true if the random method can be parallelized 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...

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

Protected Member Functions
	SM_MultiStochasticFunctionsInterface (void)
	create

virtual	~SM_MultiStochasticFunctionsInterface (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

Additional Inherited Members
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...

Detailed Description

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

Author: Stephane Despreaux

Version: 1.0

Member Function Documentation

◆ getContentsMemorySize()

virtual tMemSize SM_MultiStochasticFunctionsInterface::getContentsMemorySize ( ) const

inlinevirtual

return nthe 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 CORE_Object.

Reimplemented in SM_MultiStochasticFunctions< F >.

◆ getMemorySize()

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

Reimplemented in SM_MultiStochasticFunctions< F >.

◆ getSize()

virtual tInteger SM_MultiStochasticFunctionsInterface::getSize ( ) const

pure virtual

get the number of stochastic functions

Returns: the number of stochastic functions

Implemented in SM_MultiStochasticFunctions< F >.

◆ isThreadSafe()

tBoolean SM_MultiStochasticFunctionsInterface::isThreadSafe ( ) const

inline

return true if the random method can be parallelized

Returns: rue if the random method can be parallelized

◆ jump()

virtual void SM_MultiStochasticFunctionsInterface::jump	(	const tInteger &	coresNumber,
		const tInteger &	coreIndex,
		const tULLInt &	jumpsNumber,
		const tULLInt &	nRNGs
	)

pure virtual

jump a number of virtual random number generator

Parameters

[in]	coresNumber	: number of the cores of random generator
[in]	coreIndex	: index of the core of random generator
[in]	jumpsNumber	: jumps number for core id 0
[in]	nRNGs	number of random numbers generated for the coreIndex

Implemented in SM_MultiStochasticFunctions< F >.

◆ operator()()

virtual SM_StochasticFunctionsInterface& SM_MultiStochasticFunctionsInterface::operator() ( const tInteger & threadId )

pure virtual

operator for getting stochatic function at thread id

Parameters

[in] threadId : index of the thread

Implemented in SM_MultiStochasticFunctions< F >.

◆ randomSeed()

virtual void SM_MultiStochasticFunctionsInterface::randomSeed	(	const tInteger &	coresNumber,
		const tInteger &	coreIndex
	)

pure virtual

jump a number of virtual random number generator

Parameters

[in]	coresNumber	: number of the cores of random generator
[in]	coreIndex	: index of the core of random generator

Implemented in SM_MultiStochasticFunctions< F >.

◆ setSeed()

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

pure virtual

void set seed

Parameters

[in] seed : initial seed of the stochastic function

Implemented in SM_MultiStochasticFunctions< F >.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/core/SM_MultiStochasticFunctionsInterface.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getContentsMemorySize()

◆ getMemorySize()

◆ getSize()

◆ isThreadSafe()

◆ jump()

◆ operator()()

◆ randomSeed()

◆ setSeed()