Base class for a buffer. More...

#include <Buffer.h>

Inheritance diagram for MooseUtils::Buffer< T >:

Public Types
typedef std::vector< T >::iterator	iterator

typedef std::vector< T >::const_iterator	const_iterator

Public Member Functions
	Buffer ()
	Create an empty buffer.

	Buffer (const std::size_t capacity)
	Create a buffer with a specific capacity.

virtual	~Buffer ()

void	setCapacity (const std::size_t capacity)
	Resize the capacity.

std::size_t	capacity () const
	Get the capacity.

void	setSize (const std::size_t size)
	Set the size.

std::size_t	size () const
	Get the size.

bool	empty () const
	Whether or not the buffer is empty.

void	push_back (const T &value)
	Add a new entry on the end.

void	move (T &value)
	Moves the object into the buffer (calls std::move())

void	append (const_iterator in_begin, const_iterator in_end)
	Add new entries to the end.

void	append (const std::vector< T > &vals)
	Add new entries to the end.

void	clear ()
	Remove all entries (does not change the capacity) Note: this does NOT at all free any entries.

virtual void	erase (const std::size_t num)=0
	Remove the first num elements.

virtual void	eraseChunk (const std::size_t chunk_size)=0

iterator	begin ()
	Iterator for the first entry in the buffer.

const_iterator	begin () const
	Const iterator for the first entry in the buffer.

iterator	end ()
	Iterator for the last entry in the buffer.

const_iterator	end () const
	Const iterator for the last entry in the buffer.

virtual iterator	beginChunk (const std::size_t chunk_size)=0
	Iterator for the first entry with a given chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

virtual const_iterator	beginChunk (const std::size_t chunk_size) const =0
	Const iterator for the first entry with a given chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

virtual iterator	endChunk (const std::size_t chunk_size)=0
	Iterator for the last entry of a chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

virtual const_iterator	endChunk (const std::size_t chunk_size) const =0
	Const iterator for the last entry of a chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

T &	operator[] (const std::size_t index)
	Access an entry at index.

const T &	operator[] (const std::size_t index) const
	Const access an entry at an index.

void	swap (std::vector< T > &in_data)
	Use in_data as our data vector.

const std::vector< T > &	data ()
	Access the raw underlying storage.

std::size_t	dataBeginPos () const
	The current beginning position of the buffer in data().

std::size_t	dataEndPos () const
	The current end position of the buffer in data().

Protected Member Functions
virtual std::size_t	newEnd (const std::size_t new_end)=0
	Find out where the new end will be.

Protected Attributes
std::vector< T >	_data
	The raw data.

std::size_t	_begin_pos
	The beginning position.

std::size_t	_end_pos
	The ending position.

Detailed Description

template<typename T>
class MooseUtils::Buffer< T >

Base class for a buffer.

Enables the controlled access of an underlying raw vector for storage, which can be used to limit memory allocation and copies for various buffer types while providing a useful public API.

Definition at line 28 of file Buffer.h.

Member Typedef Documentation

◆ const_iterator

template<typename T >

typedef std::vector<T>::const_iterator MooseUtils::Buffer< T >::const_iterator

Definition at line 32 of file Buffer.h.

◆ iterator

template<typename T >

typedef std::vector<T>::iterator MooseUtils::Buffer< T >::iterator

Definition at line 31 of file Buffer.h.

Constructor & Destructor Documentation

◆ Buffer() [1/2]

template<typename T >

MooseUtils::Buffer< T >::Buffer ( )

Create an empty buffer.

Definition at line 214 of file Buffer.h.

                  : _begin_pos(0), _end_pos(0)
{
}

◆ Buffer() [2/2]

template<typename T >

MooseUtils::Buffer< T >::Buffer ( const std::size_t capacity )

Create a buffer with a specific capacity.

Definition at line 219 of file Buffer.h.

                                          : _data(capacity), _begin_pos(0), _end_pos(0)
{
}

◆ ~Buffer()

template<typename T >

virtual MooseUtils::Buffer< T >::~Buffer ( )

inlinevirtual

Definition at line 44 of file Buffer.h.

44{}

Member Function Documentation

◆ append() [1/2]

template<typename T >

void MooseUtils::Buffer< T >::append ( const std::vector< T > & vals )

Add new entries to the end.

Definition at line 253 of file Buffer.h.

{
  this->append(vals.begin(), vals.end());
}

◆ append() [2/2]

template<typename T >

void MooseUtils::Buffer< T >::append	(	const_iterator	in_begin,
		const_iterator	in_end
	)

Add new entries to the end.

Everything in [in_begin, in_end) is appended

Definition at line 241 of file Buffer.h.

{
  const auto additional_size = std::distance(in_begin, in_end);
  if (additional_size == 0)
    return;
 
  this->_end_pos = this->newEnd(this->_end_pos + additional_size);
  std::copy(in_begin, in_end, this->end() - additional_size);
}

◆ begin() [1/2]

template<typename T >

iterator MooseUtils::Buffer< T >::begin ( )

inline

Iterator for the first entry in the buffer.

Definition at line 113 of file Buffer.h.

113{ return this->_data.begin() + this->_begin_pos; }

◆ begin() [2/2]

template<typename T >

const_iterator MooseUtils::Buffer< T >::begin ( ) const

inline

Const iterator for the first entry in the buffer.

Definition at line 117 of file Buffer.h.

117{ return this->_data.begin() + this->_begin_pos; }

◆ beginChunk() [1/2]

template<typename T >

virtual const_iterator MooseUtils::Buffer< T >::beginChunk ( const std::size_t chunk_size ) const

pure virtual

Const iterator for the first entry with a given chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

◆ beginChunk() [2/2]

template<typename T >

virtual iterator MooseUtils::Buffer< T >::beginChunk ( const std::size_t chunk_size )

pure virtual

Iterator for the first entry with a given chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

◆ capacity()

template<typename T >

std::size_t MooseUtils::Buffer< T >::capacity ( ) const

inline

Get the capacity.

Definition at line 53 of file Buffer.h.

53{ return this->_data.size(); }

◆ clear()

template<typename T >

void MooseUtils::Buffer< T >::clear ( )

Remove all entries (does not change the capacity) Note: this does NOT at all free any entries.

Definition at line 260 of file Buffer.h.

{
  this->_begin_pos = 0;
  this->_end_pos = 0;
}

◆ data()

template<typename T >

const std::vector< T > & MooseUtils::Buffer< T >::data ( )

inline

Access the raw underlying storage.

This is considered an advanced interface. Typically, you should use the begin(), beginChunk(), end(), and endChunk() methods for accessing the data. This should really only be used in unit tests for verifying the underlying storage.

Definition at line 172 of file Buffer.h.

172{ return _data; }

◆ dataBeginPos()

template<typename T >

std::size_t MooseUtils::Buffer< T >::dataBeginPos ( ) const

inline

The current beginning position of the buffer in data().

This is considered an advanced interface because data() is the internal storage for the buffer. It should really only be used in unit tests for verifying the underlying storage.

Definition at line 182 of file Buffer.h.

182{ return _begin_pos; }

◆ dataEndPos()

template<typename T >

std::size_t MooseUtils::Buffer< T >::dataEndPos ( ) const

inline

The current end position of the buffer in data().

This is considered an advanced interface because data() is the internal storage for the buffer. It should really only be used in unit tests for verifying the underlying storage.

Definition at line 192 of file Buffer.h.

192{ return _end_pos; }

◆ empty()

template<typename T >

bool MooseUtils::Buffer< T >::empty ( ) const

inline

Whether or not the buffer is empty.

Definition at line 67 of file Buffer.h.

67{ return !size(); }

MooseUtils::Buffer::size

std::size_t size() const

Get the size.

Definition Buffer.h:62

◆ end() [1/2]

template<typename T >

iterator MooseUtils::Buffer< T >::end ( )

inline

Iterator for the last entry in the buffer.

Definition at line 122 of file Buffer.h.

122{ return this->_data.begin() + this->_end_pos; }

◆ end() [2/2]

template<typename T >

const_iterator MooseUtils::Buffer< T >::end ( ) const

inline

Const iterator for the last entry in the buffer.

Definition at line 126 of file Buffer.h.

126{ return this->_data.begin() + this->_end_pos; }

◆ endChunk() [1/2]

template<typename T >

virtual const_iterator MooseUtils::Buffer< T >::endChunk ( const std::size_t chunk_size ) const

pure virtual

Const iterator for the last entry of a chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

◆ endChunk() [2/2]

template<typename T >

virtual iterator MooseUtils::Buffer< T >::endChunk ( const std::size_t chunk_size )

pure virtual

Iterator for the last entry of a chunk size in the buffer If chunk_size is greater than the size of the buffer, the full range will be given.

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

◆ erase()

template<typename T >

virtual void MooseUtils::Buffer< T >::erase ( const std::size_t num )

pure virtual

Remove the first num elements.

Note that erased items are not guaranteed to be freed immediately

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

◆ eraseChunk()

template<typename T >

virtual void MooseUtils::Buffer< T >::eraseChunk ( const std::size_t chunk_size )

pure virtual

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

◆ move()

template<typename T >

void MooseUtils::Buffer< T >::move ( T & value )

Moves the object into the buffer (calls std::move())

Definition at line 233 of file Buffer.h.

{
  this->_end_pos = newEnd(this->_end_pos + 1);
  this->_data[this->_end_pos - 1] = std::move(value);
}

◆ newEnd()

template<typename T >

virtual std::size_t MooseUtils::Buffer< T >::newEnd ( const std::size_t new_end )

protectedpure virtual

Find out where the new end will be.

This will resize/copy data as necessary

Parameters

new_end the proposed new_end position

Returns: The actual position of the new ending

Implemented in MooseUtils::CircularBuffer< T >, and MooseUtils::LIFOBuffer< T >.

Referenced by MooseUtils::Buffer< T >::setSize().

◆ operator[]() [1/2]

template<typename T >

T & MooseUtils::Buffer< T >::operator[] ( const std::size_t index )

Access an entry at index.

Definition at line 268 of file Buffer.h.

{
  mooseAssert(this->_begin_pos + index < this->_end_pos, "Attempt to access off end of Buffer!");
  return this->_data[this->_begin_pos + index];
}

◆ operator[]() [2/2]

template<typename T >

const T & MooseUtils::Buffer< T >::operator[] ( const std::size_t index ) const

Const access an entry at an index.

Definition at line 276 of file Buffer.h.

{
  mooseAssert(this->_begin_pos + index < this->_end_pos, "Attempt to access off end of Buffer!");
  return this->_data[this->_begin_pos + index];
}

◆ push_back()

template<typename T >

void MooseUtils::Buffer< T >::push_back ( const T & value )

Add a new entry on the end.

Definition at line 225 of file Buffer.h.

{
  this->_end_pos = newEnd(this->_end_pos + 1);
  this->_data[this->_end_pos - 1] = value;
}

◆ setCapacity()

template<typename T >

void MooseUtils::Buffer< T >::setCapacity ( const std::size_t capacity )

inline

Resize the capacity.

Definition at line 49 of file Buffer.h.

49{ this->_data.resize(capacity); }

◆ setSize()

template<typename T >

void MooseUtils::Buffer< T >::setSize ( const std::size_t size )

inline

Set the size.

Definition at line 58 of file Buffer.h.

58{ this->_end_pos = this->newEnd(this->_begin_pos + size); }

◆ size()

template<typename T >

std::size_t MooseUtils::Buffer< T >::size ( ) const

inline

Get the size.

Definition at line 62 of file Buffer.h.

62{ return this->_end_pos - this->_begin_pos; }

Referenced by MooseUtils::Buffer< T >::empty().

◆ swap()

template<typename T >

void MooseUtils::Buffer< T >::swap ( std::vector< T > & in_data )

Use in_data as our data vector.

Definition at line 284 of file Buffer.h.

{
  std::swap(in_data, _data);
  this->_begin_pos = 0;
  this->_end_pos = this->_data.size();
}

Member Data Documentation

◆ _begin_pos

template<typename T >

std::size_t MooseUtils::Buffer< T >::_begin_pos

protected

The beginning position.

Definition at line 208 of file Buffer.h.

Referenced by MooseUtils::Buffer< T >::begin(), MooseUtils::Buffer< T >::begin(), MooseUtils::Buffer< T >::dataBeginPos(), MooseUtils::Buffer< T >::setSize(), and MooseUtils::Buffer< T >::size().

◆ _data

template<typename T >

std::vector<T> MooseUtils::Buffer< T >::_data

protected

The raw data.

Definition at line 205 of file Buffer.h.

Referenced by MooseUtils::Buffer< T >::begin(), MooseUtils::Buffer< T >::begin(), MooseUtils::Buffer< T >::capacity(), MooseUtils::Buffer< T >::data(), MooseUtils::Buffer< T >::end(), MooseUtils::Buffer< T >::end(), and MooseUtils::Buffer< T >::setCapacity().

◆ _end_pos

template<typename T >

std::size_t MooseUtils::Buffer< T >::_end_pos

protected

The ending position.

Definition at line 210 of file Buffer.h.

Referenced by MooseUtils::Buffer< T >::dataEndPos(), MooseUtils::Buffer< T >::end(), MooseUtils::Buffer< T >::end(), MooseUtils::Buffer< T >::setSize(), and MooseUtils::Buffer< T >::size().

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

include/utils/Buffer.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ Buffer() [1/2]

◆ Buffer() [2/2]

◆ ~Buffer()

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ beginChunk() [1/2]

◆ beginChunk() [2/2]

◆ capacity()

◆ clear()

◆ data()

◆ dataBeginPos()

◆ dataEndPos()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ endChunk() [1/2]

◆ endChunk() [2/2]

◆ erase()

◆ eraseChunk()

◆ move()

◆ newEnd()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ push_back()

◆ setCapacity()

◆ setSize()

◆ size()

◆ swap()

Member Data Documentation

◆ _begin_pos

◆ _data

◆ _end_pos