SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size > Class Template Reference

A simplified pool which stores values instead of pointers and doesn't redefine operator new/delete. More...

#include <smallstack_type.hpp>

Data Structures
struct	SimplePoolPoolItem

Public Member Functions
std::mutex &	GetMutex ()
	Get the mutex.
Titem &	Get (Tindex index)
	Get the item at position index.
Tindex	Create ()
	Create a new item and return its index.
void	Destroy (Tindex index)
	Destroy (or rather invalidate) the item at the given index.

Private Member Functions
Tindex	FindFirstFree ()

Private Attributes
Tindex	first_unused
Tindex	first_free
std::mutex	mutex
std::vector< SimplePoolPoolItem >	data

Detailed Description

template<typename Titem, typename Tindex, Tindex Tgrowth_step, Tindex Tmax_size>
class SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >

A simplified pool which stores values instead of pointers and doesn't redefine operator new/delete.

It also never zeroes memory and always reuses it.

Definition at line 21 of file smallstack_type.hpp.

Constructor & Destructor Documentation

SimplePool()

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::SimplePool ( )

inline

Definition at line 23 of file smallstack_type.hpp.

Member Function Documentation

Create()

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

Tindex SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::Create ( )

inline

Create a new item and return its index.

Returns

Index of new item.

Definition at line 42 of file smallstack_type.hpp.

Referenced by SmallStack< Titem, Tindex, Tinvalid, Tgrowth_step, Tmax_size >::Push().

Destroy()

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

void SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::Destroy ( Tindex  index )

inline

Destroy (or rather invalidate) the item at the given index.

Parameters

index

Index of item to be destroyed.

Definition at line 57 of file smallstack_type.hpp.

Referenced by SmallStack< Titem, Tindex, Tinvalid, Tgrowth_step, Tmax_size >::Pop().

FindFirstFree()

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

Tindex SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::FindFirstFree ( )

inlineprivate

Definition at line 65 of file smallstack_type.hpp.

Get()

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

Titem & SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::Get ( Tindex  index )

inline

Get the item at position index.

Returns

Item at index.

Definition at line 36 of file smallstack_type.hpp.

Referenced by SmallStack< Titem, Tindex, Tinvalid, Tgrowth_step, Tmax_size >::Branch(), SmallStack< Titem, Tindex, Tinvalid, Tgrowth_step, Tmax_size >::Contains(), SmallStack< Titem, Tindex, Tinvalid, Tgrowth_step, Tmax_size >::Pop(), and SmallStack< Titem, Tindex, Tinvalid, Tgrowth_step, Tmax_size >::Push().

GetMutex()

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

std::mutex & SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::GetMutex ( )

inline

Get the mutex.

We don't lock the mutex in the pool methods as the SmallStack isn't necessarily in a consistent state after each method.

Returns

Mutex.

Definition at line 30 of file smallstack_type.hpp.

Field Documentation

data

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

std::vector<SimplePoolPoolItem> SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::data

private

Definition at line 86 of file smallstack_type.hpp.

first_free

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

Tindex SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::first_free

private

Definition at line 83 of file smallstack_type.hpp.

first_unused

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

Tindex SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::first_unused

private

Definition at line 82 of file smallstack_type.hpp.

mutex

template<typename Titem , typename Tindex , Tindex Tgrowth_step, Tindex Tmax_size>

std::mutex SimplePool< Titem, Tindex, Tgrowth_step, Tmax_size >::mutex

private

Definition at line 85 of file smallstack_type.hpp.

---

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

• src/core/smallstack_type.hpp