CORE_Collection< T, I > Class Template Reference

this class describes a general container of values of type T where implemented class is I More...

#include <CORE_Collection.h>

Inheritance diagram for CORE_Collection< T, I >:

Collaboration diagram for CORE_Collection< T, 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...
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...
virtual tString	toString () const override
	return the string representation of the object node 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...
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...

Protected Member Functions
	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

Additional Inherited Members
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...

Detailed Description

template<typename T, class I>
class CORE_Collection< T, I >

this class describes a general container of values of type T where implemented class is I

Class I must implement the folowing static polymorphic methods:

• For allocation methods:
  • void setSize(const tIndex)
  • tIndex getSize() const
  • void resize(const tIndex)
• For accessor operators:
  • const T& operator[const tIndex] const
  • T& operator[const tIndex]*
• For accessor iterators:
  • constexpr auto cbegin() const
  • constexpr auto cend() const
  • constexpr auto crbegin() const
  • constexpr auto crend() const
  • auto begin()
  • auto end()
  • auto rbegin()
  • auto rend()
• For transform methods:
  • void transform(LambdaFct&& F)

Member Function Documentation

begin()

template<typename T , class I >

auto CORE_Collection< T, I >::begin ( )

inline

return begin iterator for writing

Returns

begin iterator

cbegin()

template<typename T , class I >

constexpr auto CORE_Collection< T, I >::cbegin ( ) const

inlineconstexpr

return begin iterator for reading

Returns

begin iterator

cend()

template<typename T , class I >

constexpr auto CORE_Collection< T, I >::cend ( ) const

inlineconstexpr

return end iterator for reading

Returns

end iterator

crbegin()

template<typename T , class I >

constexpr auto CORE_Collection< T, I >::crbegin ( ) const

inlineconstexpr

return reverse begin iterator for reading

Returns

begin iterator

crend()

template<typename T , class I >

constexpr auto CORE_Collection< T, I >::crend ( ) const

inlineconstexpr

return reverse end iterator for reading

Returns

end iterator

end()

template<typename T , class I >

auto CORE_Collection< T, I >::end ( )

inline

return end iterator for writing

Returns

end iterator

getDataTypeName()

template<typename T , class I >

tString CORE_Collection< T, I >::getDataTypeName ( ) const

inline

get the type of data

Returns

the type of data as string

getMemorySize()

template<typename T , class I >

virtual tMemSize CORE_Collection< T, I >::getMemorySize ( ) const

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 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from CORE_Object.

Reimplemented in OMP_ValField< T, K, D >, OMP_ValArray< T >, OMP_PtrField< T, K, D >, OMP_PtrArray< T >, CORE_VectorList< T, I >, CORE_VectorList< tString, CORE_StringsList >, CORE_ValArray< T, I >, CORE_ValArray< T, CORE_StdValArray< T > >, CORE_ValArray< T, OMP_ValArray< T > >, CORE_StringsList, CORE_StdValField< T, K, D >, CORE_StdValArray< T >, CORE_StdPtrField< T, K, D >, CORE_StdPtrArray< T >, CORE_PtrArray< T, I >, CORE_PtrArray< T, CORE_StdPtrArray< T > >, CORE_PtrArray< T, OMP_PtrArray< T > >, CORE_List< T, K, I >, CORE_List< T, tIndex, I >, CORE_Field< T, K, D, S, I >, CORE_Field< T, K, D, OMP_ValArray< T >, OMP_ValField< T, K, D > >, CORE_Field< T, K, D, OMP_PtrArray< T >, OMP_PtrField< T, K, D > >, 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_Array< T, I >, SM_Field< T, K, D >, and SM_Field< tReal, tDimension, SM_Constants::DIM >.

getSize()

template<typename T , class I >

tIndex CORE_Collection< T, I >::getSize ( ) const

inline

return the size of the container

Returns

the size container

operator[]() [1/2]

template<typename T , class I >

T& CORE_Collection< T, I >::operator[] ( const tIndex &  i )

inline

get the i-th element for writting. Do not verify the bounds

Parameters

[in]

i

index of the element

operator[]() [2/2]

template<typename T , class I >

const T& CORE_Collection< T, I >::operator[] ( const tIndex &  i ) const

inline

get the i-th element for reading. Do not verify the bounds

Parameters

[in]

i

index of the element

rbegin()

template<typename T , class I >

auto CORE_Collection< T, I >::rbegin ( )

inline

return reverse begin iterator for writing

Returns

begin iterator

rend()

template<typename T , class I >

auto CORE_Collection< T, I >::rend ( )

inline

return reverse end iterator for writing

Returns

end iterator

setSize()

template<typename T , class I >

void CORE_Collection< T, I >::setSize ( const tIndex &  n )

inline

set the size of the container

Parameters

[in]

n

:size of the container

toString()

template<typename T , class I >

virtual tString CORE_Collection< T, I >::toString ( ) const

inlineoverridevirtual

return the string representation of the object node

Returns

the string representation of the object node

Reimplemented from CORE_Object.

Reimplemented in CORE_Field< T, K, D, S, I >, CORE_Field< T, K, D, OMP_ValArray< T >, OMP_ValField< T, K, D > >, CORE_Field< T, K, D, OMP_PtrArray< T >, OMP_PtrField< T, K, D > >, CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >, and CORE_Field< T, K, D, CORE_StdValArray< T >, CORE_StdValField< T, K, D > >.

transform()

template<typename T , class I >

template<typename LambdaFct >

void CORE_Collection< T, I >::transform ( LambdaFct &&  F )

inline

transform the transform element with the lambda function Ti = F(Ti)

Parameters

[in]

F

: lambda function with one variable

---

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

• /home/despreau/Developpement/CPP/devcpp20/include/core/CORE_Collection.h