Description:

A bit buffer using dynamic allocation.

See also: Two alternatives are provided with BitBufferMA , which uses monotonic allocation and BitBufferLocal , which uses local (stack) memory.

Definition at line 478 of file bitbuffer.hpp.

#include <bitbuffer.hpp>

Inheritance diagram for BitBuffer:

Collaboration diagram for BitBuffer:

Public Method Index:
	BitBuffer (uinteger initialCapacity)

virtual uinteger	Capacity () const override

virtual bool	EnsureCapacity (uinteger bitsRequired, BitBufferBase::Index idx) override

Public Method Index: inherited from BitBufferBase
	BitBufferBase () noexcept

virtual	~BitBufferBase ()

char *	CharStream (Index idx=Index(0, 0))

TStorage *	Data () const

ALIB_API void	FromLittleEndianEncoding (const Index &startIndex, const Index &endIndex)

TStorage	GetWord (const Index &index) const

uinteger	RemainingSize (const Index &idx) const

void	SetWord (const Index &index, TStorage value)

ALIB_API Index	Terminate (Index writerIndex)

ALIB_API void	ToLittleEndianEncoding (const Index &startIndex, const Index &endIndex)

ALIB_API Index	Unterminate (Index terminationIndex)

Additional Inherited Members
Public Type Index: inherited from BitBufferBase
using	TStorage = unsigned int

Field Details:

◆ storage

std::vector<TStorage> storage

protected

The vector that holds the data.

Definition at line 482 of file bitbuffer.hpp.

Constructor(s) / Destructor Details::

◆ BitBuffer()

BitBuffer ( uinteger initialCapacity )

inline

Constructor.

Parameters

initialCapacity The requested initial capacity of the buffer in bits.

Definition at line 489 of file bitbuffer.hpp.

Here is the call graph for this function:

Method Details:

◆ Capacity()

virtual uinteger Capacity ( ) const

inlineoverridevirtual

Returns the (currently allocated) capacity.

Returns: The size of the internal storage in bits.

Implements BitBufferBase.

Definition at line 498 of file bitbuffer.hpp.

◆ EnsureCapacity()

virtual bool EnsureCapacity	(	uinteger	bitsRequired,
		BitBufferBase::Index	idx )