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

#include <SM_MultiStochasticFunctions.h>

Inheritance diagram for SM_MultiStochasticFunctions< F >:

[legend]

Collaboration diagram for SM_MultiStochasticFunctions< F >:

[legend]

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

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

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

F &	operator[] (const tInteger &threadId)
	operator for getting stochatic function at thread id More...

const F &	operator[] (const tInteger &threadId) const
	operator for getting stochatic function at thread id More...

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

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

virtual void	setSeed () final
	set seed

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

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

virtual tString	toString () const override
	return the string representation of the multi stochastic functions More...

Public Member Functions inherited from SM_MultiStochasticFunctionsInterface
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...

Static Public Member Functions
static CORE_UniquePointer< SelfClass >	New ()
	build a new instance of default class factory 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...

Protected Member Functions
	SM_MultiStochasticFunctions (void)
	create

virtual	~SM_MultiStochasticFunctions (void)
	destroy

Protected Member Functions inherited from SM_MultiStochasticFunctionsInterface
	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

Detailed Description

template<class F>
class SM_MultiStochasticFunctions< F >

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

Template Parameters

F	: class wich implements SM_StochasticFunctions

Author: Stephane Despreaux

Version: 1.0

Member Function Documentation

◆ getContentsMemorySize()

template<class F >

virtual tMemSize SM_MultiStochasticFunctions< F >::getContentsMemorySize ( ) const

inlineoverridevirtual

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

◆ getMemorySize()

template<class F >

virtual tMemSize SM_MultiStochasticFunctions< F >::getMemorySize ( ) const

inlineoverridevirtual

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

◆ getSize()

template<class F >

virtual tInteger SM_MultiStochasticFunctions< F >::getSize ( ) const

inlinefinalvirtual

get the number of stochastic functions

Returns: the numbe rof stochastic functions

Implements SM_MultiStochasticFunctionsInterface.

◆ jump()

template<class F >

virtual void SM_MultiStochasticFunctions< F >::jump	(	const tInteger &	coresNumber,
		const tInteger &	coreIndex,
		const tULLInt &	jumpsNumber,
		const tULLInt &	nRNGs
	)

inlinefinalvirtual

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

Implements SM_MultiStochasticFunctionsInterface.

◆ New()

template<class F >

static CORE_UniquePointer<SelfClass> SM_MultiStochasticFunctions< F >::New ( )

inlinestatic

build a new instance of default class factory

Returns: an unique pointer to the class

◆ operator()()

template<class F >

virtual SM_StochasticFunctionsInterface& SM_MultiStochasticFunctions< F >::operator() ( const tInteger & threadId )

inlineoverridevirtual

operator for getting stochatic function at thread id

Parameters

[in] threadId index of the thread

Implements SM_MultiStochasticFunctionsInterface.

◆ operator[]() [1/2]

template<class F >

F& SM_MultiStochasticFunctions< F >::operator[] ( const tInteger & threadId )

inline

operator for getting stochatic function at thread id

Parameters

[in] threadId index of the thread

◆ operator[]() [2/2]

template<class F >

const F& SM_MultiStochasticFunctions< F >::operator[] ( const tInteger & threadId ) const

inline

operator for getting stochatic function at thread id

Parameters

[in] threadId index of the thread

◆ randomSeed()

template<class F >

virtual void SM_MultiStochasticFunctions< F >::randomSeed	(	const tInteger &	coresNumber,
		const tInteger &	coreIndex
	)

inlinefinalvirtual

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

Implements SM_MultiStochasticFunctionsInterface.

◆ setSeed()

template<class F >

virtual void SM_MultiStochasticFunctions< F >::setSeed ( const tULLInt & seed )

inlinefinalvirtual

void set seed

Parameters

[in] seed : initial seed of the stochastic function

Implements SM_MultiStochasticFunctionsInterface.

◆ toString()

template<class F >

virtual tString SM_MultiStochasticFunctions< F >::toString ( ) const

inlineoverridevirtual

return the string representation of the multi stochastic functions

Returns: the string repesentation of the class

Reimplemented from CORE_Object.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

template<class F> class SM_MultiStochasticFunctions< F >

Member Function Documentation

◆ getContentsMemorySize()

◆ getMemorySize()

◆ getSize()

◆ jump()

◆ New()

◆ operator()()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ randomSeed()

◆ setSeed()

◆ toString()

template<class F>
class SM_MultiStochasticFunctions< F >