SM_Field< T, K, D > Class Template Reference

This class describes a field with a T type with index of type K of size D. More...

#include <SM_Field.h>

Inheritance diagram for SM_Field< T, K, D >:

Collaboration diagram for SM_Field< T, K, D >:

Public Member Functions
	SM_Field ()
	create a field of dim D and size 1
	SM_Field (std::initializer_list< T > &&values)
	create a field of dim 3 and size values.size()/3 initialized with values list values More...
virtual	~SM_Field (void)
	destroy the interface
virtual tMemSize	getMemorySize () const
	return the memory size of the class and the memory size of all its attributes/associations More...
Self &	operator= (const T &v)
	copy operator More...
Self &	operator= (const std::initializer_list< T > &cpy)
	copy operator More...
Self &	operator= (std::initializer_list< T > &&cpy)
	copy operator More...
Self &	operator= (const std::valarray< T > &cpy)
	copy operator More...
Self &	operator= (const std::array< T, D > &cpy)
	copy operator More...
Self &	operator= (const Self &cpy)
	copy operator More...
Self &	operator= (Self &&cpy)
	copy operator More...
template<class R >
requires functions_type::isRealType< R > void	addStochasticNoise (const R &epsilon, SM_MultiStochasticFunctionsInterface &fs)
	add a stochastic noise the the field More...
template<class R , class StochF >
void	addscStochasticNoise (const R &epsilon, SM_MultiStochasticFunctions< StochF > &fs)
	add a stochastic noise the the field by static casting method More...
Public Member Functions inherited from CORE_StdPtrField< T, K, D >
	CORE_StdPtrField ()
	build an array of T*
virtual	~CORE_StdPtrField ()
	destroy an array of T*
Self &	operator= (const T &v)
	fill the values of the array with v More...
Self &	operator= (std::initializer_list< T > &&values)
	build an array by a copy of c More...
Self &	operator= (const std::initializer_list< T > &values)
	build an array by a copy of c More...
template<size_t N, typename Q >
Self &	operator= (const std::array< Q, N > &values)
	build an array by a copy of c More...
template<typename Q >
Self &	operator= (const std::valarray< Q > &values)
	build an array by a copy of c More...
template<typename Q >
Self &	operator= (const std::vector< Q > &values)
	build an array by a copy of c More...
Self &	operator= (const Self &values)
	build an array by a copy of c More...
Self &	operator= (Self &&values)
	build an array by a copy of c More...
template<typename Q , class S1 , class I1 >
Self &	operator= (const CORE_Field< Q, K, D, S1, I1 > &values)
	build an array by a copy of c More...
template<typename Q , class S1 , class I1 >
Self &	operator= (CORE_Field< Q, K, D, S1, I1 > &&values)
	build an array by a copy of c More...
template<typename Q >
void	initialize (const Q &v)
	initailize all the values with v More...
template<typename Q >
void	initialize (const std::array< Q, D > &a)
	copy at element element the array of size D More...
template<typename Q >
tBoolean	setSharedValues (const tIndex &capacity, const tIndex &size, Q *values)
	set shared values with the capacity and size More...
template<typename Q >
tBoolean	setSharedValues (const tIndex &capacity, Q *values)
	set shared values with the capacity and size More...
template<typename Q , class I1 >
tBoolean	setSharedValues (CORE_PtrArray< Q, I1 > &array)
	share the values of array More...
Self &	operator+= (const T &v)
	add operator More...
Self &	operator-= (const T &v)
	sub operator More...
Self &	operator*= (const T &v)
	multiplicator operator More...
Self &	operator/= (const T &v)
	divisor operator More...
Self &	operator%= (const T &v) requires functions_type
	modulo operator More...
template<class Q , class S , class I >
Self &	operator-= (const CORE_Field< Q, K, D, S, I > &X)
	array sub operator More...
template<class Q , class S , class I >
Self &	operator*= (const CORE_Field< Q, K, D, S, I > &X)
	array multiply operator More...
template<class Q , class S , class I >
Self &	operator/= (const CORE_Field< Q, K, D, S, I > &X)
	array divisor operator More...
template<typename LambdaFct >
void	elementsTransform (LambdaFct &&F)
	apply the transform element with the lambda function Xid = F(Xid) More...
void	normalize ()
	normalize all the elements of the field return false if the method is not compatible with the floating point type
template<class I >
void	mod2 (CORE_Array< T, I > &X) const
	return the norm2 array per each element More...
template<class Q , class S1 , class I1 >
T &	scalarProduct (const CORE_Field< Q, K, D, S1, I1 > &X, T &s) const
	return the weight scalar product More...
template<class Q , class S1 , class I1 >
T &	scalarProduct (const std::valarray< Q > &weights, const CORE_Field< Q, K, D, S1, I1 > &X, T &s) const
	return the scalar product More...
Public Member Functions inherited from CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >
virtual tMemSize	getContentsMemorySize () const override
	return the memory size of the included associations More...
void	setElementsNumber (const tInteger &n)
	set the number of element of the container More...
void	fitToElementsNumber (const tInteger &n)
	set the number of element of the container without erasing values More...
tIndex	getElementsNumber () const
	return the number values of the container More...
void	setSize (const tIndex &n)
	set the number of values of the container More...
void	resize (const tIndex &n)
	set the number of values of the container More...
tIndex	getSize () const
	return the number values of the container More...
K	getDimension () const
	get the dimension of the field More...
const T &	operator[] (const tIndex &i) const
	get the i-th value for reading. More...
T &	operator[] (const tIndex &i)
	get the i-th value for writting. More...
const T &	operator() (const tInteger &i, const K &d) const
	get the i-th element for reading. Do not verify the bounds More...
T &	operator() (const tInteger &i, const K d)
	get the i-th element for writting. Do not verify the bounds More...
const T *	operator() (const tInteger &i) const
	get the i-th element for reading. Do not verify the bounds More...
T *	operator() (const tInteger &i)
	get the i-th element for writting. Do not verify the bounds More...
constexpr auto	cbegin () const
	return begin iterator for reading More...
constexpr auto	cend () const
	return end iterator for reading More...
auto	begin ()
	return begin iterator for writing More...
auto	end ()
	return end iterator for writing More...
auto	rbegin ()
	return reverse begin iterator for writing More...
auto	rend ()
	return reverse end iterator for writing More...
constexpr auto	crbegin () const
	return reverse begin iterator for reading More...
constexpr auto	crend () const
	return reverse end iterator for reading More...
auto	sbegin ()
	return begin stride iterator for writing More...
auto	send ()
	return end N-stride iterator for writing More...
constexpr auto	csbegin () const
	return begin N-stride const iterator for writing More...
constexpr auto	csend () const
	return end N-stride const iterator for writing More...
const T &	get (const tIndex &i, const K &d) const
	get the d-th coordinate of the i-th element for reading More...
T &	get (const tIndex &i, const K &d)
	get the d-th coordinate of the i-th element for writting More...
const T *	getValues () const
	get the values of the array for reading More...
T *	getValues ()
	get the values of the array More...
const CORE_StdPtrArray< T > &	getStorage () const
	get the storage More...
CORE_StdPtrArray< T > &	getStorage ()
	get the storage More...
Self &	operator= (const T &v)
	fill the values of the field with v More...
Self &	operator= (const std::initializer_list< T > &values)
	build an field by a copy of c More...
Self &	operator= (std::initializer_list< T > &&values)
	build an field by a copy of c More...
Self &	operator= (const std::array< Q, N > &values)
	build an field by a copy of c More...
Self &	operator= (const std::array< Q, D > &values)
	build an field by a copy of c More...
Self &	operator= (const std::valarray< Q > &values)
	build an field by a copy of c More...
Self &	operator= (const std::vector< Q > &values)
	build an field by a copy of c More...
Self &	operator= (const Self &cpy)
	build a field by a copy of cpy More...
Self &	operator= (Self &&cpy)
	build an field by a copy of cpy More...
Self &	operator= (const CORE_Field< Q, K, D, S1, I1 > &cpy)
	build a field by a copy of cpy More...
Self &	operator= (CORE_Field< Q, K, D, S1, I1 > &&cpy)
	build an field by a copy of cpy More...
void	copy (const tIndex &n, const Q *vs)
	initialize the field to the values of pointer of size n More...
void	copy (const std::array< Q, N > &vs)
	initialize the field at eche element with Vs More...
void	copy (const std::array< Q, D > &vs)
	initialize the field to the values of array of size D More...
void	copy (const std::valarray< Q > &vs)
	initialize the field to the values of val array More...
void	copy (std::valarray< Q > &&vs)
	initialize the field to the values of val array More...
void	copy (const std::vector< Q > &vs)
	initialize the field to the values of vector More...
void	copy (const std::initializer_list< T > &vs)
	initialize the field to the values of list More...
void	copy (std::initializer_list< T > &&vs)
	initialize the field to the values of list More...
void	copy (const CORE_Field< Q, K, D, S1, I1 > &cpy)
	copy the the field More...
void	copy (CORE_Field< Q, K, D, S1, I1 > &&cpy)
	copy the field : mv is destroyed after this More...
void	initialize (const T &v)
	initialize the field to v More...
void	initialize (const std::array< Q, D > &vs)
	initialize the field to the values of array of size D More...
void	setUniformRandomizeSeed (const tULLInt &seed)
	set the uniform randomize seed More...
void	setUniformRandomizeSeed ()
	set the uniform randomize seed
void	uniformRandomize (const T &min, const T &max)
	randomize the field More...
Self &	operator+= (const T &v)
	add operator More...
Self &	operator-= (const T &v)
	sub operator More...
Self &	operator-= (const CORE_Field< T1, K, D, S1, I1 > &v)
	array sub operator More...
Self &	operator*= (const T &v)
	multiplicator operator More...
Self &	operator*= (const CORE_Field< T1, K, D, S1, I1 > &v)
	array multiply operator More...
Self &	operator/= (const T &v)
	divisor operator More...
Self &	operator/= (const CORE_Field< T1, K, D, S1, I1 > &v)
	array divisor operator More...
Self &	operator%= (const T &v) requires functions_type
	modulo operator More...
void	transform (LambdaFct &&F)
	transform the transform element with the lambda function Ti = F(Ti) More...
void	transform (LambdaFct &&F, const Self &X)
	transform the transform element with the lambda function Ti = F(Xi) More...
void	transform (LambdaFct &&F, const Self &X, const Self &Y)
	transform the transform element with the lambda function Ti = F(Xi,Yi) More...
void	elementsTransform (LambdaFct &&F)
	apply the transform element with the lambda function Xid = F(Xid) More...
void	swap (CORE_Array< T, CORE_StdPtrField< T, K, D > > &a)
	swap the contents of the array More...
void	swap (CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > > &a)
	swap the contents of the array More...
void	normalize ()
	normalize all the elements of the field return false if the method is not compatible with the floating point type
void	axpy (const Q &alpha, const CORE_Field< Q, K, D, S1, I1 > &X, const T &beta)
	compute This=beta.This+ alpha .X More...
tBoolean	isNANContained () const
	return true if one value is Not A Number More...
void	mod2 (CORE_Array< T, I1 > &X) const
	return the norm2 array per each element More...
tReal	linfNorm (tIndex &i) const
	compute the L infinity norm More...
tReal	linfDistance (const CORE_Field< Q, K, D, CORE_StdPtrArray< T >, I1 > &X, tIndex &i) const
	compute the Linfinitty norm More...
void	sum (T &s) const
	return the sum of all the elements More...
void	prod (T &p) const
	return the produc of all the elements More...
T &	scalarProduct (const CORE_Field< Q, K, D, S1, I1 > &X, T &s) const
	return the scalar product More...
T &	scalarProduct (const std::valarray< Q > &weights, const CORE_Field< Q, K, D, S1, I1 > &X, T &s) const
	return the scalar product More...
void	min (T &m) const requires functions_type
	return the min value of all the elements More...
tBoolean	loadFromFile (const tString &filename, tString &comment, tInt &retCode)
	load the field from a txt file with the format : More...
virtual tString	toString () const override
	return the string representation of the object node More...
Public Member Functions inherited from CORE_Collection< T, I >
void	setSize (const tIndex &n)
	set the size of the container More...
tIndex	getSize () const
	return the size of the container More...
void	resize (const tIndex &n)
	modify the size of the array and keep its old values
const T &	operator[] (const tIndex &i) const
	get the i-th element for reading. Do not verify the bounds More...
T &	operator[] (const tIndex &i)
	get the i-th element for writting. Do not verify the bounds More...
constexpr auto	cbegin () const
	return begin iterator for reading More...
constexpr auto	cend () const
	return end iterator for reading More...
auto	begin ()
	return begin iterator for writing More...
auto	end ()
	return end iterator for writing More...
auto	rbegin ()
	return reverse begin iterator for writing More...
auto	rend ()
	return reverse end iterator for writing More...
constexpr auto	crbegin () const
	return reverse begin iterator for reading More...
constexpr auto	crend () const
	return reverse end iterator for reading More...
template<typename LambdaFct >
void	transform (LambdaFct &&F)
	transform the transform element with the lambda function Ti = F(Ti) More...
tString	getDataTypeName () const
	get the type of data More...
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< Self >	New ()
	build a new instance of a SM_Field More...
Static Public Member Functions inherited from CORE_StdPtrField< T, K, D >
static CORE_UniquePointer< Self >	New ()
	return a new unique pointer of this More...
template<typename LambdaFct >
static void	ElementsTransform (LambdaFct &&F, Self &X)
	apply the transform element with the lambda function Ri = F(Xi) More...
static void	Normalize (const tIndex &n, T *values)
	normalize all the elements of the field 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...

Additional Inherited Members
Protected Member Functions inherited from CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >
	CORE_Field ()
	instanciation method of a class
virtual	~CORE_Field ()
	destroy an instance of class
Protected Member Functions inherited from CORE_Collection< T, I >
	CORE_Collection ()
	build an array of T*
virtual	~CORE_Collection ()
	destroy an array of T*
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<typename T, typename K, tUCInt D>
class SM_Field< T, K, D >

This class describes a field with a T type with index of type K of size D.

A real field as a size of N (SM_Field::setSize()) and a dimension dim (SM_Field::setDimension()). So the size of the allocated array is N x dim.

Author

Stephane Despreaux

Version

1.0

Constructor & Destructor Documentation

SM_Field()

template<typename T , typename K , tUCInt D>

SM_Field< T, K, D >::SM_Field ( std::initializer_list< T > &&  values )

inline

create a field of dim 3 and size values.size()/3 initialized with values list values

Parameters

[in]

values

:values of the field

Member Function Documentation

addscStochasticNoise()

template<typename T , typename K , tUCInt D>

template<class R , class StochF >

void SM_Field< T, K, D >::addscStochasticNoise ( const R &  epsilon, SM_MultiStochasticFunctions< StochF > &  fs  )

inline

add a stochastic noise the the field by static casting method

Parameters

[in]	epsilon	: the amplitude of the noise
[in]	fs	the stochastic noise simulation per thread This+=epsilon * fs|threadId].normalRandom()

addStochasticNoise()

template<typename T , typename K , tUCInt D>

template<class R >

requires functions_type::isRealType<R> void SM_Field< T, K, D >::addStochasticNoise ( const R &  epsilon, SM_MultiStochasticFunctionsInterface &  fs  )

inline

add a stochastic noise the the field

Parameters

[in]	epsilon	: the amplitude of the noise
[in]	fs	the stochastic noise simulator per thread This+=epsilon * fs[threadId].normalRandom()

getMemorySize()

template<typename T , typename K , tUCInt D>

virtual tMemSize SM_Field< T, K, D >::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 CORE_StdPtrField< T, K, D >.

New()

template<typename T , typename K , tUCInt D>

static CORE_UniquePointer<Self> SM_Field< T, K, D >::New ( )

inlinestatic

build a new instance of a SM_Field

Returns

an unique pointer of SM_Field

operator=() [1/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( const Self &  cpy )

inline

copy operator

Parameters

[in]

cpy

: field to copy

Returns

this

operator=() [2/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( const std::array< T, D > &  cpy )

inline

copy operator

Parameters

[in]

cpy

: initializer list

Returns

this

operator=() [3/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( const std::initializer_list< T > &  cpy )

inline

copy operator

Parameters

[in]

cpy

: initializer list

Returns

this

operator=() [4/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( const std::valarray< T > &  cpy )

inline

copy operator

Parameters

[in]

cpy

: initializer list

Returns

this

operator=() [5/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( const T &  v )

inline

copy operator

Parameters

[in]

v

: initialize value

Returns

this

operator=() [6/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( Self &&  cpy )

inline

copy operator

Parameters

[in]

cpy

: field to copy

Returns

this

operator=() [7/7]

template<typename T , typename K , tUCInt D>

Self& SM_Field< T, K, D >::operator= ( std::initializer_list< T > &&  cpy )

inline

copy operator

Parameters

[in]

cpy

: initializer list

Returns

this

---

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

• /home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/core/SM_Field.h