C++ main module for stochmagnet Package  1.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SM_NoiseRateFunction Class Referenceabstract

This class describes a noise rate function. More...

#include <SM_NoiseRateFunction.h>

Inheritance diagram for SM_NoiseRateFunction:
Inheritance graph
[legend]
Collaboration diagram for SM_NoiseRateFunction:
Collaboration graph
[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...
 
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 getName () const =0
 the the name of the system More...
 
virtual tReal computeFunction (const tReal &t) const =0
 compute the noise rate function 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 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...
 

Protected Member Functions

 SM_NoiseRateFunction (void)
 create More...
 
virtual ~SM_NoiseRateFunction (void)
 destroy More...
 

Private Member Functions

 SM_NoiseRateFunction (const SM_NoiseRateFunction &f)
 create a copy of instance of function 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 a noise rate function.

Author
Stephane Despreaux
Version
1.0

Constructor & Destructor Documentation

◆ SM_NoiseRateFunction() [1/2]

SM_NoiseRateFunction::SM_NoiseRateFunction ( void  )
inlineprotected

create

References mNoisePower, and mNoiseRate.

◆ SM_NoiseRateFunction() [2/2]

SM_NoiseRateFunction::SM_NoiseRateFunction ( const SM_NoiseRateFunction &  f)
inlineprivate

create a copy of instance of function f

Parameters
[in]ffunction to copy copy constructor is not peermitted

◆ ~SM_NoiseRateFunction()

virtual SM_NoiseRateFunction::~SM_NoiseRateFunction ( void  )
inlineprotectedvirtual

destroy

Member Function Documentation

◆ computeFunction()

virtual tReal SM_NoiseRateFunction::computeFunction ( const tReal &  t) const
pure virtual

compute the noise rate function

Parameters
[in]t: time value
Returns
getNoiseRate()

Implemented in SM_InverseNoiseRateFunction, and SM_ConstantNoiseRateFunction.

Referenced by SM_Beam::computeL2Convergence(), SM_System::makeRelaxation(), and SM_Output::saveStochasticIndicators().

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(), SM_InverseNoiseRateFunction::getMemorySize(), SM_LandauLifschitzFunction::getMemorySize(), 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_NoiseRateFunction::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_TemplatedNoiseRateFunction< DerivedClass >, SM_TemplatedNoiseRateFunction< SM_ConstantNoiseRateFunction >, SM_TemplatedNoiseRateFunction< SM_InverseNoiseRateFunction >, SM_InverseNoiseRateFunction, and SM_ConstantNoiseRateFunction.

References CORE_Object::getContentsMemorySize().

Here is the call graph for this function:

◆ getName()

virtual tString SM_NoiseRateFunction::getName ( ) const
pure virtual

the the name of the system

Implemented in SM_InverseNoiseRateFunction, and SM_ConstantNoiseRateFunction.

Referenced by toString().

Here is the caller graph for this function:

◆ getNoisePower()

const tReal& SM_NoiseRateFunction::getNoisePower ( ) const
inline

get the noise power

Returns
the noise power

References mNoisePower.

Referenced by SM_InverseNoiseRateFunction::computeTemplatedFunction().

Here is the caller graph for this function:

◆ getNoiseRate()

const tReal& SM_NoiseRateFunction::getNoiseRate ( ) const
inline

get the noise rate

Returns
the noise rate

References mNoiseRate.

Referenced by SM_ConstantNoiseRateFunction::computeTemplatedFunction(), and SM_InverseNoiseRateFunction::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:

◆ setNoisePower()

void SM_NoiseRateFunction::setNoisePower ( const tReal &  eps)
inline

set the noise power

Parameters
[in]epsnoise power

References mNoisePower.

◆ setNoiseRate()

void SM_NoiseRateFunction::setNoiseRate ( const tReal &  eps)
inline

set the noise rate

Parameters
[in]epsnoise rate

References 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]upunique 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
inlinefinalvirtual

return the string reprsentation or the class

Returns
the stringrepresentation of the class

Reimplemented from CORE_Object.

References getName(), mNoisePower, and mNoiseRate.

Here is the call graph for this function:

Member Data Documentation

◆ mNoisePower

tReal SM_NoiseRateFunction::mNoisePower
private

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

◆ mNoiseRate

tReal SM_NoiseRateFunction::mNoiseRate
private

Referenced by getNoiseRate(), setNoiseRate(), SM_NoiseRateFunction(), and 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:
Generated on Wed Mar 8 2023 09:58:12 for C++ main module for stochmagnet Package by doxygen 1.9.1