SM_InverseNoiseRateFunction Class Reference

This class describes an noise rate function of the form \( F(t)=\frac{\varepsilon}{(t+1)^\alpha}\). More...

#include <SM_InverseNoiseRateFunction.h>

Inheritance diagram for SM_InverseNoiseRateFunction:

Collaboration diagram for SM_InverseNoiseRateFunction:

Public Member Functions
	SM_InverseNoiseRateFunction (void)
	create More...
virtual	~SM_InverseNoiseRateFunction (void)
	destroy More...
virtual tMemSize	getMemorySize () const
	return the memory size of the class and the memory size of all its attributes/associations More...
virtual tString	getName () const override
	the the name of the system More...
tReal	computeTemplatedFunction (const tReal &t) const
	compute the noise rate function More...
virtual tReal	computeFunction (const tReal &t) const override
	compute the noise rate function More...
void	setNoiseRate (const tReal &eps)
	set the noise rate More...
const tReal &	getNoiseRate () const
	get the noise rate More...
void	setNoisePower (const tReal &eps)
	set the noise power More...
const tReal &	getNoisePower () const
	get the noise power More...
virtual tString	toString () const final
	return the string reprsentation or the class 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...
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...

Static Public Member Functions
static CORE_UniquePointer< SM_InverseNoiseRateFunction >	New ()
	build a new instance of a SM_NoiseRateFunction 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
	SM_InverseNoiseRateFunction (const SM_NoiseRateFunction &f)
	create a copy of instance of f More...
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...

Private Attributes
tReal	mNoiseRate
tReal	mNoisePower
std::weak_ptr< CORE_Object >	mThis

Detailed Description

This class describes an noise rate function of the form \( F(t)=\frac{\varepsilon}{(t+1)^\alpha}\).

Author

Stephane Despreaux

Version

1.0

Constructor & Destructor Documentation

SM_InverseNoiseRateFunction() [1/2]

SM_InverseNoiseRateFunction::SM_InverseNoiseRateFunction ( void  )

inline

create

Referenced by New().

Here is the caller graph for this function:

SM_InverseNoiseRateFunction() [2/2]

SM_InverseNoiseRateFunction::SM_InverseNoiseRateFunction ( const SM_NoiseRateFunction &  f )

inlineprivate

create a copy of instance of f

Parameters

[in]

f

function to copy Copy constructor is not permitted

~SM_InverseNoiseRateFunction()

virtual SM_InverseNoiseRateFunction::~SM_InverseNoiseRateFunction ( void  )

inlinevirtual

destroy

Member Function Documentation

computeFunction()

virtual tReal SM_InverseNoiseRateFunction::computeFunction ( const tReal &  t ) const

inlineoverridevirtual

compute the noise rate function

Parameters

[in]

t

: time value

Returns

getNoiseRate()

Implements SM_NoiseRateFunction.

References computeTemplatedFunction().

Referenced by SM_Test::testVirtualMethods().

Here is the call graph for this function:

Here is the caller graph for this function:

computeTemplatedFunction()

tReal SM_InverseNoiseRateFunction::computeTemplatedFunction ( const tReal &  t ) const

inline

compute the noise rate function

Parameters

[in]

t

: time value

Returns

getNoiseRate()/(t+1)^getNoisePower();

References SM_NoiseRateFunction::getNoisePower(), and SM_NoiseRateFunction::getNoiseRate().

Referenced by computeFunction(), and SM_Test::testVirtualMethods().

Here is the call graph for this function:

Here is the caller graph for this function:

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 CORE_Object::getContentsMemorySize ( ) const

inlinevirtualinherited

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 in CORE_VectorList< T, I >, CORE_VectorList< tString, CORE_StringsList >, CORE_ValArray< T, I >, CORE_ValArray< T, CORE_StdValArray< T > >, CORE_Run, CORE_PtrArray< T, I >, CORE_PtrArray< T, CORE_StdPtrArray< T > >, 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_ClassFactory, SMS_STDUniformFunction, SMS_STDNormalFunction, SMS_BoostUniformFunction, SMS_BoostNormalFunction, SM_ZeemanOperator, SM_XDMF, SM_VTK, SM_System, SM_Output, SM_Operator, SM_Network, SM_DemagnetizedOperator, SM_Beam, CORE_StringsList, and CORE_Out.

Referenced by CORE_Out::getContentsMemorySize(), SM_Beam::getContentsMemorySize(), SM_Network::getContentsMemorySize(), SM_Operator::getContentsMemorySize(), SM_Output::getContentsMemorySize(), SM_System::getContentsMemorySize(), SM_VTK::getContentsMemorySize(), SMS_BoostNormalFunction::getContentsMemorySize(), SMS_BoostUniformFunction::getContentsMemorySize(), SMS_STDNormalFunction::getContentsMemorySize(), SMS_STDUniformFunction::getContentsMemorySize(), CORE_ClassFactory::getContentsMemorySize(), CORE_PtrArray< T, I >::getContentsMemorySize(), CORE_ValArray< T, I >::getContentsMemorySize(), CORE_VectorList< T, I >::getContentsMemorySize(), CORE_Object::getMemorySize(), SM_ConstantNoiseRateFunction::getMemorySize(), getMemorySize(), SM_LandauLifschitzFunction::getMemorySize(), SM_NoiseRateFunction::getMemorySize(), SM_Object::getMemorySize(), SM_StochasticFunction::getMemorySize(), SM_TemplatedNoiseRateFunction< DerivedClass >::getMemorySize(), SM_TimeStepper::getMemorySize(), SMS_BoostRandomFunction::getMemorySize(), CORE_Array< T, I >::getMemorySize(), CORE_Chrono::getMemorySize(), CORE_Collection< T, I >::getMemorySize(), CORE_IO::getMemorySize(), CORE_List< T, K, I >::getMemorySize(), CORE_OptionsReader::getMemorySize(), CORE_OutputFile::getMemorySize(), and CORE_Test::getMemorySize().

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 SM_InverseNoiseRateFunction::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_TemplatedNoiseRateFunction< SM_InverseNoiseRateFunction >.

References CORE_Object::getContentsMemorySize().

Here is the call graph for this function:

getName()

virtual tString SM_InverseNoiseRateFunction::getName ( ) const

inlineoverridevirtual

the the name of the system

Implements SM_NoiseRateFunction.

getNoisePower()

const tReal& SM_NoiseRateFunction::getNoisePower ( ) const

inlineinherited

get the noise power

Returns

the noise power

References SM_NoiseRateFunction::mNoisePower.

Referenced by computeTemplatedFunction().

Here is the caller graph for this function:

getNoiseRate()

const tReal& SM_NoiseRateFunction::getNoiseRate ( ) const

inlineinherited

get the noise rate

Returns

the noise rate

References SM_NoiseRateFunction::mNoiseRate.

Referenced by SM_ConstantNoiseRateFunction::computeTemplatedFunction(), and computeTemplatedFunction().

Here is the caller 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

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.

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<SM_InverseNoiseRateFunction> SM_InverseNoiseRateFunction::New ( )

inlinestatic

build a new instance of a SM_NoiseRateFunction

Returns

an unique pointer of SM_NoiseRateFunction

References SM_InverseNoiseRateFunction().

Referenced by SM_ClassFactory::NewInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

setNoisePower()

void SM_NoiseRateFunction::setNoisePower ( const tReal &  eps )

inlineinherited

set the noise power

Parameters

[in]

eps

noise power

References SM_NoiseRateFunction::mNoisePower.

setNoiseRate()

void SM_NoiseRateFunction::setNoiseRate ( const tReal &  eps )

inlineinherited

set the noise rate

Parameters

[in]

eps

noise rate

References SM_NoiseRateFunction::mNoiseRate.

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.

toString()

virtual tString SM_NoiseRateFunction::toString ( ) const

inlinefinalvirtualinherited

return the string reprsentation or the class

Returns

the stringrepresentation of the class

Reimplemented from CORE_Object.

References SM_NoiseRateFunction::getName(), SM_NoiseRateFunction::mNoisePower, and SM_NoiseRateFunction::mNoiseRate.

Here is the call graph for this function:

Member Data Documentation

mNoisePower

tReal SM_NoiseRateFunction::mNoisePower

privateinherited

Referenced by SM_NoiseRateFunction::getNoisePower(), SM_NoiseRateFunction::setNoisePower(), SM_NoiseRateFunction::SM_NoiseRateFunction(), and SM_NoiseRateFunction::toString().

mNoiseRate

tReal SM_NoiseRateFunction::mNoiseRate

privateinherited

Referenced by SM_NoiseRateFunction::getNoiseRate(), SM_NoiseRateFunction::setNoiseRate(), SM_NoiseRateFunction::SM_NoiseRateFunction(), and SM_NoiseRateFunction::toString().

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 file:

• SM_InverseNoiseRateFunction.h