This class describes a stochastic functions with templated methods. More...
#include <SM_StochasticFunctions.h>
Inheritance diagram for SM_StochasticFunctions< I >:
Collaboration diagram for SM_StochasticFunctions< I >:
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 tReal | normalRandom () final |
| compute a normal random number More... | |
| virtual tReal | uniformRandom () final |
| compute a uniforn random number in [0,1] More... | |
| tReal | scNormalRandom () |
| compute a normal random number by static casting method More... | |
| tReal | scUniformRandom () |
| compute a uniform random number in [0,1] bu static casting method More... | |
 Public Member Functions inherited from SM_StochasticFunctionsInterface | |
| 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... | |
| 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... | |
Protected Member Functions | |
| SM_StochasticFunctions (void) | |
| create | |
| virtual | ~SM_StochasticFunctions (void) |
| destroy | |
| Protected Member Functions inherited from SM_StochasticFunctionsInterface | |
| 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 | |
Additional Inherited Members | |
| Static Public Member Functions inherited from SM_StochasticFunctionsInterface | |
| 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... | |
| Static Protected Member Functions inherited from SM_StochasticFunctionsInterface | |
| static void | SetIsThreadSafe (const tBoolean &b) |
| set if the sochastic function is thread safe More... | |
Detailed Description
template<class I>
class SM_StochasticFunctions< I >
This class describes a stochastic functions with templated methods.
- Template Parameters
-
I : implemented class which implements the templated abstract methods : - scNormalRandom() : to generate a templated normal distribution
- scUniformRandom() : to generate a templated uniform distribution
It implements the virtual abstract methods of base class SM_StochasticFunctionsInterface
The package which implements this class is Stochastic functions for modeling Brownian perturbation
- Version
- 1.0
Member Function Documentation
◆ getMemorySize()
template<class I >
|
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
- the added size of the base classes which contains:
Reimplemented from SM_StochasticFunctionsInterface.
Reimplemented in SM_TRNGStochasticFunctions_MT19937, SM_TRNGStochasticFunctions< G >, SM_STDStochasticFunctions< G >, SM_MTStochasticFunctions< G >, and SM_BoostStochasticFunctions< G >.
◆ normalRandom()
template<class I >
|
inlinefinalvirtual |
◆ scNormalRandom()
template<class I >
|
inline |
compute a normal random number by static casting method
- Returns
- a random number
◆ scUniformRandom()
template<class I >
|
inline |
compute a uniform random number in [0,1] bu static casting method
- Returns
- a random number
◆ uniformRandom()
template<class I >
|
inlinefinalvirtual |
compute a uniforn random number in [0,1]
- Returns
- a random number
Implements SM_StochasticFunctionsInterface.
The documentation for this class was generated from the following file:
- /home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/core/SM_StochasticFunctions.h
