A dynamically resizable PtrList with allocation management. More...

Inheritance diagram for PtrDynList< T, SizeMin >:

Public Member Functions
constexpr	PtrDynList () noexcept
	Construct null. More...

	PtrDynList (const label len)
	Construct with given capacity. More...

	PtrDynList (const PtrDynList< T, SizeMin > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrDynList (PtrDynList< T, SizeMin > &&list)
	Move construct. More...

	PtrDynList (UList< T * > &list)
	Take ownerskip of pointers in the list, set old pointers to null. More...

	~PtrDynList ()=default
	Destructor. More...

label	capacity () const noexcept
	Size of the underlying storage. More...

void	setCapacity (const label nElem)
	Alter the size of the underlying storage. More...

void	resize (const label newLen)
	Alter the addressed list size. More...

void	setSize (const label newLen)
	Same as resize() More...

void	reserve (const label nElem)
	Reserve allocation space for at least this size. More...

void	clear ()
	Clear the addressed list, i.e. set the size to zero. More...

void	clearStorage ()
	Clear the list and delete storage. More...

label	expandStorage ()
	Expand the addressable size to fit the allocated capacity. More...

void	shrink ()
	Shrink the allocated space to the number of elements used. More...

label	squeezeNull ()

void	append (T *ptr)
	Append an element to the end of the list. More...

void	append (const autoPtr< T > &aptr)
	Move append an element to the end of the list. More...

void	append (const tmp< T > &tptr)
	Move or clone append a tmp to the end of the list. More...

void	append (PtrList< T > &&other)
	Move append another list to the end of this list. More...

template<int AnySizeMin>
void	append (PtrDynList< T, AnySizeMin > &&other)
	Move append another list to the end of this list. More...

autoPtr< T >	remove ()
	Remove and return the top element. More...

const T *	set (const label i) const
	Return const pointer to element (if set) or nullptr. More...

autoPtr< T >	set (const label i, T *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< T >	set (const label i, const autoPtr< T > &aptr)
	Set element to given autoPtr and return old element. More...

autoPtr< T >	set (const label i, const tmp< T > &tptr)
	Set element to given tmp and return old element. More...

void	reorder (const labelUList &oldToNew)
	Reorder elements. Reordering must be unique (ie, shuffle). More...

void	operator= (const PtrList< T > &list)
	Copy (clone) assignment. More...

void	operator= (const PtrDynList< T, SizeMin > &list)
	Copy (clone) assignment. More...

template<int AnySizeMin>
void	operator= (const PtrDynList< T, AnySizeMin > &list)
	Copy (clone) assignment with different sizing parameters. More...

void	operator= (PtrList< T > &&list)
	Move assignment. More...

void	operator= (PtrDynList< T, SizeMin > &&list)
	Move assignment. More...

template<int AnySizeMin>
void	operator= (PtrDynList< T, AnySizeMin > &&list)
	Move assignment with different sizing parameters. More...

Detailed Description

template<class T, int SizeMin = 64>
class Foam::PtrDynList< T, SizeMin >

A dynamically resizable PtrList with allocation management.

See also: Foam::UPtrList Foam::PtrList

Source files

Definition at line 53 of file PtrDynList.H.

Constructor & Destructor Documentation

◆ PtrDynList() [1/5]

constexpr PtrDynList ( )

inlineconstexprnoexcept

Construct null.

Definition at line 43 of file PtrDynListI.H.

◆ PtrDynList() [2/5]

PtrDynList ( const label len )

inlineexplicit

Construct with given capacity.

Definition at line 51 of file PtrDynListI.H.

◆ PtrDynList() [3/5]

PtrDynList ( const PtrDynList< T, SizeMin > & list )

inline

Copy construct using 'clone()' method on each element.

Definition at line 62 of file PtrDynListI.H.

◆ PtrDynList() [4/5]

PtrDynList ( PtrDynList< T, SizeMin > && list )

inline

Move construct.

Definition at line 73 of file PtrDynListI.H.

◆ PtrDynList() [5/5]

PtrDynList ( UList< T * > & list )

inlineexplicit

Take ownerskip of pointers in the list, set old pointers to null.

Definition at line 85 of file PtrDynListI.H.

◆ ~PtrDynList()

~PtrDynList ( )

default

Destructor.

Member Function Documentation

◆ capacity()

Foam::label capacity ( ) const

inlinenoexcept

Size of the underlying storage.

Definition at line 95 of file PtrDynListI.H.

Referenced by PtrDynList< Foam::profilingInformation >::operator=().

Here is the caller graph for this function:

◆ setCapacity()

void setCapacity ( const label nElem )

inline

Alter the size of the underlying storage.

Definition at line 102 of file PtrDynListI.H.

◆ resize()

void resize ( const label newLen )

inline

Alter the addressed list size.

Definition at line 136 of file PtrDynListI.H.

◆ setSize()

void setSize ( const label newLen )

inline

Same as resize()

Definition at line 170 of file PtrDynListI.H.

◆ reserve()

void reserve ( const label nElem )

inline

Reserve allocation space for at least this size.

Never shrinks the allocated size, use setCapacity() for that.

Definition at line 119 of file PtrDynListI.H.

◆ clear()

void clear ( )

inline

Clear the addressed list, i.e. set the size to zero.

Allocated size does not change

Definition at line 177 of file PtrDynListI.H.

◆ clearStorage()

void clearStorage ( )

inline

Clear the list and delete storage.

Definition at line 185 of file PtrDynListI.H.

Referenced by PtrDynList< Foam::profilingInformation >::operator=(), and PtrDynList< Foam::profilingInformation >::PtrDynList().

Here is the caller graph for this function:

◆ expandStorage()

Foam::label expandStorage ( )

inline

Expand the addressable size to fit the allocated capacity.

Returns the previous addressable size.

Definition at line 193 of file PtrDynListI.H.

◆ shrink()

void shrink ( )

inline

Shrink the allocated space to the number of elements used.

Definition at line 205 of file PtrDynListI.H.

◆ squeezeNull()

Foam::label squeezeNull ( )

inline

Squeeze out intermediate nullptr entries in the list of pointers and adjust the addressable size accordingly.

Returns: the number of non-null entries

Definition at line 222 of file PtrDynListI.H.

◆ append() [1/5]

void append ( T * ptr )

inline

Append an element to the end of the list.

Definition at line 231 of file PtrDynListI.H.

◆ append() [2/5]

void append ( const autoPtr< T > & aptr )

inline

Move append an element to the end of the list.

Definition at line 240 of file PtrDynListI.H.

◆ append() [3/5]

void append ( const tmp< T > & tptr )

inline

Move or clone append a tmp to the end of the list.

Definition at line 247 of file PtrDynListI.H.

◆ append() [4/5]

void append ( PtrList< T > && other )

inline

Move append another list to the end of this list.

Definition at line 254 of file PtrDynListI.H.

◆ append() [5/5]

void append ( PtrDynList< T, AnySizeMin > && other )

inline

Move append another list to the end of this list.

Definition at line 273 of file PtrDynListI.H.

◆ remove()

Foam::autoPtr< T > remove ( )

inline

Remove and return the top element.

Definition at line 292 of file PtrDynListI.H.

◆ set() [1/4]

const T * set ( const label i ) const

inline

Return const pointer to element (if set) or nullptr.

The return value can be tested as a bool.

Definition at line 311 of file PtrDynListI.H.

◆ set() [2/4]

Foam::autoPtr< T > set	(	const label	i,
		T *	ptr
	)

inline

Set element to given pointer and return old element (can be null)

Definition at line 319 of file PtrDynListI.H.

◆ set() [3/4]

Foam::autoPtr< T > set	(	const label	i,
		const autoPtr< T > &	aptr
	)

inline

Set element to given autoPtr and return old element.

Definition at line 335 of file PtrDynListI.H.

◆ set() [4/4]

Foam::autoPtr< T > set	(	const label	i,
		const tmp< T > &	tptr
	)

inline

Set element to given tmp and return old element.

Definition at line 346 of file PtrDynListI.H.

◆ reorder()

void reorder ( const labelUList & oldToNew )

inline

Reorder elements. Reordering must be unique (ie, shuffle).

Definition at line 356 of file PtrDynListI.H.

◆ operator=() [1/6]

void operator= ( const PtrList< T > & list )

inline

Copy (clone) assignment.

Definition at line 368 of file PtrDynListI.H.

◆ operator=() [2/6]

void operator= ( const PtrDynList< T, SizeMin > & list )

inline

Copy (clone) assignment.

Definition at line 384 of file PtrDynListI.H.

◆ operator=() [3/6]

void operator= ( const PtrDynList< T, AnySizeMin > & list )

inline

Copy (clone) assignment with different sizing parameters.

Definition at line 401 of file PtrDynListI.H.

◆ operator=() [4/6]

void operator= ( PtrList< T > && list )

inline

Move assignment.

Definition at line 417 of file PtrDynListI.H.

◆ operator=() [5/6]

void operator= ( PtrDynList< T, SizeMin > && list )

inline

Move assignment.

Definition at line 434 of file PtrDynListI.H.

◆ operator=() [6/6]

void operator= ( PtrDynList< T, AnySizeMin > && list )

inline

Move assignment with different sizing parameters.

Definition at line 452 of file PtrDynListI.H.

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

src/OpenFOAM/containers/PtrLists/PtrDynList/PtrDynList.H
src/OpenFOAM/containers/PtrLists/PtrDynList/PtrDynListI.H

Public Member Functions

Detailed Description

template<class T, int SizeMin = 64> class Foam::PtrDynList< T, SizeMin >

Constructor & Destructor Documentation

◆ PtrDynList() [1/5]

◆ PtrDynList() [2/5]

◆ PtrDynList() [3/5]

◆ PtrDynList() [4/5]

◆ PtrDynList() [5/5]

◆ ~PtrDynList()

Member Function Documentation

◆ capacity()

◆ setCapacity()

◆ resize()

◆ setSize()

◆ reserve()

◆ clear()

◆ clearStorage()

◆ expandStorage()

◆ shrink()

◆ squeezeNull()

◆ append() [1/5]

◆ append() [2/5]

◆ append() [3/5]

◆ append() [4/5]

◆ append() [5/5]

◆ remove()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ reorder()

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

template<class T, int SizeMin = 64>
class Foam::PtrDynList< T, SizeMin >