VW::no_lock_object_pool< T, TInitializer, TCleanup > Struct Template Reference

#include <object_pool.h>

Public Member Functions
	no_lock_object_pool ()=default
	no_lock_object_pool (size_t initial_chunk_size, TInitializer initializer={}, size_t chunk_size=8)
	~no_lock_object_pool ()
void	return_object (T *obj)
T *	get_object ()
bool	empty () const
size_t	size () const
bool	is_from_pool (T *obj) const

Private Member Functions
void	new_chunk (size_t size)

Private Attributes
std::queue< T * >	m_pool
std::vector< std::pair< T *, T * > >	m_chunk_bounds
std::vector< std::unique_ptr< T[]> >	m_chunks
TInitializer	m_initializer
TCleanup	m_cleanup
size_t	m_initial_chunk_size = 0
size_t	m_chunk_size = 8

Detailed Description

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>
struct VW::no_lock_object_pool< T, TInitializer, TCleanup >

Definition at line 30 of file object_pool.h.

Constructor & Destructor Documentation

no_lock_object_pool() [1/2]

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

VW::no_lock_object_pool< T, TInitializer, TCleanup >::no_lock_object_pool ( )

default

no_lock_object_pool() [2/2]

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

VW::no_lock_object_pool< T, TInitializer, TCleanup >::no_lock_object_pool ( size_t  initial_chunk_size, TInitializer  initializer = {}, size_t  chunk_size = 8  )

inline

Definition at line 33 of file object_pool.h.

                                                                            {}, size_t chunk_size = 8)
      : m_initializer(initializer), m_initial_chunk_size(initial_chunk_size), m_chunk_size(chunk_size)
  {
    new_chunk(initial_chunk_size);
  }

~no_lock_object_pool()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

VW::no_lock_object_pool< T, TInitializer, TCleanup >::~no_lock_object_pool ( )

inline

Definition at line 39 of file object_pool.h.

  {
    while (!m_pool.empty())
    {
      auto front = m_pool.front();
      m_cleanup(front);
      m_pool.pop();
    }
  }

Member Function Documentation

empty()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

bool VW::no_lock_object_pool< T, TInitializer, TCleanup >::empty ( ) const

inline

Definition at line 67 of file object_pool.h.

{ return m_pool.empty(); }

get_object()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

T* VW::no_lock_object_pool< T, TInitializer, TCleanup >::get_object ( )

inline

Definition at line 55 of file object_pool.h.

  {
    if (m_pool.empty())
    {
      new_chunk(m_chunk_size);
    }

    auto obj = m_pool.front();
    m_pool.pop();
    return obj;
  }

is_from_pool()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

bool VW::no_lock_object_pool< T, TInitializer, TCleanup >::is_from_pool ( T *  obj ) const

inline

Definition at line 84 of file object_pool.h.

  {
    for (auto& bound : m_chunk_bounds)
    {
      if (obj >= bound.first && obj <= bound.second)
      {
        return true;
      }
    }

    return false;
  }

new_chunk()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

void VW::no_lock_object_pool< T, TInitializer, TCleanup >::new_chunk ( size_t  size )

inlineprivate

Definition at line 98 of file object_pool.h.

  {
    if (size == 0)
    {
      return;
    }

    m_chunks.push_back(std::unique_ptr<T[]>(new T[size]));
    auto& chunk = m_chunks.back();
    m_chunk_bounds.push_back({&chunk[0], &chunk[size - 1]});

    for (size_t i = 0; i < size; i++)
    {
      memset(&chunk[i], 0, sizeof(T));
      new (&chunk[i]) T{};
      m_pool.push(m_initializer(&chunk[i]));
    }
  }

return_object()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

void VW::no_lock_object_pool< T, TInitializer, TCleanup >::return_object ( T *  obj )

inline

Definition at line 49 of file object_pool.h.

  {
    assert(is_from_pool(obj));
    m_pool.push(obj);
  }

size()

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

size_t VW::no_lock_object_pool< T, TInitializer, TCleanup >::size ( ) const

inline

Definition at line 69 of file object_pool.h.

  {
    size_t size = 0;
    auto num_chunks = m_chunk_bounds.size();

    if (m_chunk_bounds.size() > 0 && m_initial_chunk_size > 0)
    {
      size += m_initial_chunk_size;
      num_chunks--;
    }

    size += num_chunks * m_chunk_size;
    return size;
  }

Member Data Documentation

m_chunk_bounds

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

std::vector<std::pair<T*, T*> > VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_chunk_bounds

private

Definition at line 118 of file object_pool.h.

m_chunk_size

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

size_t VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_chunk_size = 8

private

Definition at line 123 of file object_pool.h.

m_chunks

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

std::vector<std::unique_ptr<T[]> > VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_chunks

private

Definition at line 119 of file object_pool.h.

m_cleanup

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

TCleanup VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_cleanup

private

Definition at line 121 of file object_pool.h.

m_initial_chunk_size

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

size_t VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_initial_chunk_size = 0

private

Definition at line 122 of file object_pool.h.

m_initializer

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

TInitializer VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_initializer

private

Definition at line 120 of file object_pool.h.

m_pool

template<typename T, typename TInitializer, typename TCleanup = default_cleanup<T>>

std::queue<T*> VW::no_lock_object_pool< T, TInitializer, TCleanup >::m_pool

private

Definition at line 117 of file object_pool.h.

---

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

• /mnt/c/w/linux/vowpal_wabbit/vowpalwabbit/object_pool.h