ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
Public Methods | Protected Fields | List of all members
BitBuffer Class Reference

#include <bitbuffer.hpp>

Inheritance diagram for BitBuffer:
[legend]
Collaboration diagram for BitBuffer:
[legend]

Class 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 493 of file bitbuffer.hpp.

Public Methods

 BitBuffer (uinteger initialCapacity)
 
virtual uinteger Capacity () const override
 
virtual bool EnsureCapacity (uinteger bitsRequired, BitBufferBase::Index idx) override
 
- Public Methods inherited from BitBufferBase
 BitBufferBase () noexcept
 
virtual ~BitBufferBase ()
 
char * CharStream (Index idx=Index(0, 0))
 
TStorageData () 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)
 

Protected Fields

std::vector< TStoragestorage
 
- Protected Fields inherited from BitBufferBase
TStoragedata
 

Additional Inherited Members

- Public Types inherited from BitBufferBase
using TStorage = unsigned int
 

Constructor & Destructor Documentation

◆ BitBuffer()

BitBuffer ( uinteger  initialCapacity)
inline

Constructor.

Parameters
initialCapacityThe requested initial capacity of the buffer in bits.

Definition at line 504 of file bitbuffer.hpp.

Here is the call graph for this function:

Member Function Documentation

◆ 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 513 of file bitbuffer.hpp.

◆ EnsureCapacity()

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

Checks if the given required storage space is internally reserved. If not, the internal capacity is doubled, or, if more is required, set to the required space.

Parameters
bitsRequiredThe number of bits required.
idxThe index of current buffer use.
Returns
true if the the space is available or could be made available, false otherwise.

Implements BitBufferBase.

Definition at line 527 of file bitbuffer.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ storage

std::vector<TStorage> storage
protected

The vector that holds the data.

Definition at line 497 of file bitbuffer.hpp.


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