This class implements a stochastic function with a normal law implemented from the boost library. More...

#include <SMS_BoostUniformFunction.h>

Inheritance diagram for SMS_BoostUniformFunction:

[legend]

Collaboration diagram for SMS_BoostUniformFunction:

[legend]

Public Member Functions
	SMS_BoostUniformFunction ()
	create an object More...

virtual	~SMS_BoostUniformFunction (void)
	destroy an object. More...

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

virtual void	initializeSeed (const tULLInt &seed) override
	initialize the seed More...

void	setSupport (const tReal &a, const tReal &b)
	set the support More...

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

virtual tReal	random () const override
	random return a random numbers in range More...

tReal	templatedRandom () const
	random return a random numbers in range More...

RNGType &	getRNGenerator ()
	get the generator More...

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< SMS_BoostUniformFunction >	New ()
	build a new instance of the stochasticfunction More...

static void	initSeed ()
	init the seed More...

static void	initSeed (const tULLInt &v)
	init the seed More...

static tBoolean	EnableMemoryStack (const tBoolean &isMemoryChecked)
	enable the memory stack More...

static void	EnableMemoryStack ()
	enable the memory stack More...

static void	DisableMemoryStack ()
	disable the memory stack More...

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

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

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

Private Member Functions
template<class T >
std::shared_ptr< T >	setThis (std::unique_ptr< T, CORE_Object::Delete > &up)
	set the shared pointer from an unique pointer More...

virtual tString	toString () const override
	turn the class into a string More...

Private Attributes
boost::math::uniform_distribution< tReal > *	mDistribution

boost::uniform_real< tReal > *	mRandomDistribution

boost::random::variate_generator< RNGType &, boost::uniform_real< tReal > > *	mGenerator

std::weak_ptr< CORE_Object >	mThis

Static Private Attributes
static RNGType	mRNGenerator

static tBoolean	INIT_SEED =true

Detailed Description

This class implements a stochastic function with a normal law implemented from the boost library.

Author: St�phane Despr�aux

Version: 1.0

Constructor & Destructor Documentation

◆ SMS_BoostUniformFunction()

SMS_BoostUniformFunction::SMS_BoostUniformFunction ( )

create an object

References mDistribution, mGenerator, mRandomDistribution, and setProperties().

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~SMS_BoostUniformFunction()

SMS_BoostUniformFunction::~SMS_BoostUniformFunction ( void )

virtual

destroy an object.

References mDistribution, mGenerator, and mRandomDistribution.

Member Function Documentation

◆ DisableMemoryStack()

static void CORE_Object::DisableMemoryStack ( )

inlinestaticinherited

disable the memory stack

Referenced by CORE_Object::EnableMemoryStack().

Here is the caller graph for this function:

◆ EnableMemoryStack() [1/2]

static void CORE_Object::EnableMemoryStack ( )

inlinestaticinherited

enable the memory stack

Referenced by CORE_Object::EnableMemoryStack(), and CORE_Run::SetDebugOptions().

Here is the caller graph for this function:

◆ EnableMemoryStack() [2/2]

static tBoolean CORE_Object::EnableMemoryStack ( const tBoolean & isMemoryChecked )

inlinestaticinherited

enable the memory stack

Parameters

[in] isMemoryChecked : true to verify memory allocation of CORE_Object classes

Returns: true if the memroy is checked

References CORE_Object::DisableMemoryStack(), CORE_Object::EnableMemoryStack(), and CORE_Object::IsMemoryStackEnabled().

Here is the call graph for this function:

◆ getClassName()

tString CORE_Object::getClassName ( ) const

inlineinherited

return the name of the class

Returns: the string name of the class

Referenced by CORE_Object::getIdentityString(), and CORE_Test::testTypes().

Here is the caller graph for this function:

◆ getConstSharedPointer()

template<class T >

std::shared_ptr<const T> CORE_Object::getConstSharedPointer ( ) const

inlineinherited

return a const shared pointer for this

Returns: the shared pointer as a type T

References CORE_Object::mThis.

◆ getContentsMemorySize()

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

References CORE_Object::getContentsMemorySize(), mDistribution, mGenerator, mRandomDistribution, and tMemSize.

Referenced by getMemorySize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const

inlineinherited

retrun the string identification of the class

Returns: the string identity of the class

References CORE_Object::getClassName(), and core_functions::pointerToString().

Referenced by CORE_Test::testArray(), CORE_Test::testField(), CORE_Test::testTypes(), CORE_Object::toString(), CORE_ClassFactory::toString(), and CORE_Field< T, K, D, S, I >::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMemorySize()

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

References getContentsMemorySize().

Here is the call graph for this function:

◆ getPointerString()

tString CORE_Object::getPointerString ( ) const

inlineinherited

retrun the pointer of the class as a string

Returns: the pointer of the calss as a string

References core_functions::pointerToString().

Here is the call graph for this function:

◆ GetRegisteredClassesNumber()

static tIndex CORE_Object::GetRegisteredClassesNumber ( )

inlinestaticinherited

get the memory stack in string

Returns: the string representation of the memory stack

◆ getRNGenerator()

RNGType& SMS_BoostRandomFunction::getRNGenerator ( )

inlineinherited

get the generator

References SMS_BoostRandomFunction::mRNGenerator.

Referenced by SMS_BoostNormalFunction::setProperties(), and setSupport().

Here is the caller graph for this function:

◆ getSharedPointer()

template<class T >

std::shared_ptr<T> CORE_Object::getSharedPointer ( )

inlineinherited

return the shared pointer for this

Returns: the shared pointer as a type T

References CORE_Object::mThis.

◆ initializeSeed()

virtual void SMS_BoostUniformFunction::initializeSeed ( const tULLInt & seed )

inlineoverridevirtual

initialize the seed

Parameters

seed	: init value of the seed for generating random numbers

Implements SM_StochasticFunction.

References SMS_BoostRandomFunction::initSeed().

Referenced by SM_Test::linedParticlesTestCase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSeed() [1/2]

void SMS_BoostRandomFunction::initSeed ( )

staticinherited

init the seed

Referenced by SMS_BoostNormalFunction::initializeSeed(), initializeSeed(), and SMS_BoostRandomFunction::SMS_BoostRandomFunction().

Here is the caller graph for this function:

◆ initSeed() [2/2]

void SMS_BoostRandomFunction::initSeed ( const tULLInt & v )

staticinherited

init the seed

References SMS_BoostRandomFunction::INIT_SEED, and SMS_BoostRandomFunction::mRNGenerator.

◆ isInstanceOf()

template<class T >

tBoolean CORE_Object::isInstanceOf ( ) const

inlineinherited

test if the clas T is an instance of this class

Returns: true if the object is an instance of T

Referenced by SM_Beam::templatedSimulate().

Here is the caller graph for this function:

◆ IsMemoryStackEnabled()

static tBoolean CORE_Object::IsMemoryStackEnabled ( )

inlinestaticinherited

return trur if the memory stack is enabled

Referenced by CORE_Object::EnableMemoryStack(), and main().

Here is the caller graph for this function:

◆ MemoryStackToString()

static tString CORE_Object::MemoryStackToString ( )

inlinestaticinherited

get the memory stack in string

Returns: the string representation of the memory stack

Referenced by main().

Here is the caller graph for this function:

◆ New()

static CORE_UniquePointer<SMS_BoostUniformFunction> SMS_BoostUniformFunction::New ( )

inlinestatic

build a new instance of the stochasticfunction

Returns: an unique pointer of the stochastic function

References SMS_BoostUniformFunction().

Here is the call graph for this function:

◆ random()

virtual tReal SMS_BoostUniformFunction::random ( ) const

inlineoverridevirtual

random return a random numbers in range

Implements SM_StochasticFunction.

References templatedRandom().

Here is the call graph for this function:

◆ setProperties()

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

overridevirtual

set the properties of the stochastic function

Parameters

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

Implements SM_StochasticFunction.

References setSupport().

Referenced by SMS_BoostUniformFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSupport()

void SMS_BoostUniformFunction::setSupport	(	const tReal &	a,
		const tReal &	b
	)

set the support

Parameters

[in]	a	min value
[in]	b	max value

References SMS_BoostRandomFunction::getRNGenerator(), mDistribution, mGenerator, and mRandomDistribution.

Referenced by SM_Test::linedParticlesTestCase(), and setProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setThis()

template<class T >

std::shared_ptr<T> CORE_Object::setThis ( std::unique_ptr< T, CORE_Object::Delete > & up )

inlineprivateinherited

set the shared pointer from an unique pointer

Parameters

[in,out] up unique pointer of the class at input, points to null pointer at output

Returns: the shared pointer of the class

Method only calledby the friend class CORE_ClassFactory::NewSharedInstance()

References CORE_Object::mThis.

◆ templatedRandom()

tReal SMS_BoostUniformFunction::templatedRandom ( ) const

inline

random return a random numbers in range

References mGenerator.

Referenced by SM_Test::linedParticlesTestCase(), and random().

Here is the caller graph for this function:

◆ toString() [1/2]

virtual tString CORE_Object::toString ( ) const

inlinevirtualinherited

return the string representation of the object node

Returns: the string representation of the object node

Reimplemented in SM_TimeStepper, SM_System, SM_StochasticFunction, SM_Network, SM_LandauLifschitzFunction, SM_Beam, CORE_Field< T, K, D, S, I >, CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >, CORE_Field< T, K, D, CORE_StdValArray< T >, CORE_StdValField< T, K, D > >, CORE_Collection< T, I >, CORE_ClassFactory, and SM_NoiseRateFunction.

References CORE_Object::getIdentityString().

Referenced by SM_Run::run(), CORE_Collection< T, I >::toString(), SM_Beam::toString(), SM_Network::toString(), SM_StochasticFunction::toString(), SM_System::toString(), and SM_TimeStepper::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString() [2/2]

virtual tString SM_StochasticFunction::toString ( ) const

inlineoverridevirtualinherited

turn the class into a string

Returns: the string representation of the class

Reimplemented from CORE_Object.

References CORE_Object::toString().

Here is the call graph for this function:

Member Data Documentation

◆ INIT_SEED

tBoolean SMS_BoostRandomFunction::INIT_SEED =true

staticprivateinherited

Referenced by SMS_BoostRandomFunction::initSeed(), and SMS_BoostRandomFunction::SMS_BoostRandomFunction().

◆ mDistribution

boost::math::uniform_distribution<tReal>* SMS_BoostUniformFunction::mDistribution

private

Referenced by getContentsMemorySize(), setSupport(), SMS_BoostUniformFunction(), and ~SMS_BoostUniformFunction().

◆ mGenerator

boost::random::variate_generator<RNGType&, boost::uniform_real<tReal> >* SMS_BoostUniformFunction::mGenerator

private

Referenced by getContentsMemorySize(), setSupport(), SMS_BoostUniformFunction(), templatedRandom(), and ~SMS_BoostUniformFunction().

◆ mRandomDistribution

boost::uniform_real<tReal>* SMS_BoostUniformFunction::mRandomDistribution

private

Referenced by getContentsMemorySize(), setSupport(), SMS_BoostUniformFunction(), and ~SMS_BoostUniformFunction().

◆ mRNGenerator

RNGType SMS_BoostRandomFunction::mRNGenerator

staticprivateinherited

Referenced by SMS_BoostRandomFunction::getRNGenerator(), and SMS_BoostRandomFunction::initSeed().

◆ mThis

std::weak_ptr<CORE_Object> CORE_Object::mThis

privateinherited

Referenced by CORE_Object::getConstSharedPointer(), CORE_Object::getSharedPointer(), and CORE_Object::setThis().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SMS_BoostUniformFunction()

◆ ~SMS_BoostUniformFunction()

Member Function Documentation

◆ DisableMemoryStack()

◆ EnableMemoryStack() [1/2]

◆ EnableMemoryStack() [2/2]

◆ getClassName()

◆ getConstSharedPointer()

◆ getContentsMemorySize()

◆ getIdentityString()

◆ getMemorySize()

◆ getPointerString()

◆ GetRegisteredClassesNumber()

◆ getRNGenerator()

◆ getSharedPointer()

◆ initializeSeed()

◆ initSeed() [1/2]

◆ initSeed() [2/2]

◆ isInstanceOf()

◆ IsMemoryStackEnabled()

◆ MemoryStackToString()

◆ New()

◆ random()

◆ setProperties()

◆ setSupport()

◆ setThis()

◆ templatedRandom()

◆ toString() [1/2]

◆ toString() [2/2]

Member Data Documentation

◆ INIT_SEED

◆ mDistribution

◆ mGenerator

◆ mRandomDistribution

◆ mRNGenerator

◆ mThis