bdlma.h

Go to the documentation of this file.

/// @file bdlma.h
///
///
/// @defgroup bdlma Package bdlma
/// @brief  Basic Development Library Memory Allocators (bdlma)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlma
/// [bdlma]: group__bdlma.html
/// @{
///
/// # Purpose {#bdlma-purpose}
/// Provide allocators, pools, and other memory-management tools.
///
/// # Mnemonic {#bdlma-mnemonic}
/// Basic Development Library Memory Allocators (bdlma)
///
/// # Description {#bdlma-description}
/// The 'bdlma' package provides concrete allocators derived from the
/// 'bslma::Allocator' protocol.
///
/// ## Hierarchical Synopsis
///
/// The 'bdlma' package currently has 31 components having 8 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  8. bdlma_localbufferedobject
///     bdlma_multipoolallocator
///
///  7. bdlma_aligningallocator
///     bdlma_localsequentialallocator
///     bdlma_multipool
///
///  6. bdlma_bufferedsequentialallocator
///
///  5. bdlma_bufferedsequentialpool
///     bdlma_concurrentmultipoolallocator
///     bdlma_sequentialallocator
///
///  4. bdlma_concurrentfixedpool
///     bdlma_concurrentmultipool
///     bdlma_concurrentpoolallocator
///     bdlma_sequentialpool
///
///  3. bdlma_buffermanager
///     bdlma_concurrentpool
///     bdlma_defaultdeleter
///     bdlma_factory
///     bdlma_pool
///
///  2. bdlma_alignedallocator
///     bdlma_autoreleaser
///     bdlma_blocklist
///     bdlma_bufferimputil
///     bdlma_concurrentallocatoradapter
///     bdlma_countingallocator
///     bdlma_deleter
///     bdlma_guardingallocator
///     bdlma_heapbypassallocator
///     bdlma_infrequentdeleteblocklist
///     bdlma_managedallocator
///     bdlma_memoryblockdescriptor
///
///  1. bdlma_localbufferedobject_cpp03                                  !PRIVATE!
/// @endcode
///
/// ## Component Synopsis
///
///  @ref bdlma_alignedallocator :
///       Provide a protocol for memory allocators that support alignment.
/// 
///  @ref bdlma_aligningallocator :
///       Provide an allocator-wrapper to allocate with a minimum alignment.
/// 
///  @ref bdlma_autoreleaser :
///       Release memory to a managed allocator or pool at destruction.
/// 
///  @ref bdlma_blocklist :
///       Provide allocation and management of a sequence of memory blocks.
/// 
///  @ref bdlma_bufferedsequentialallocator :
///       Provide an efficient managed allocator using an external buffer.
/// 
///  @ref bdlma_bufferedsequentialpool :
///       Provide sequential memory using an external buffer and a fallback.
/// 
///  @ref bdlma_bufferimputil :
///       Provide pure procedures for allocating memory from a buffer.
/// 
///  @ref bdlma_buffermanager :
///       Provide a memory manager that manages an external buffer.
/// 
///  @ref bdlma_concurrentallocatoradapter :
///       Provide a thread-enabled adapter for the allocator protocol.
/// 
///  @ref bdlma_concurrentfixedpool :
///       Provide thread-safe pool of limited # of blocks of uniform size.
/// 
///  @ref bdlma_concurrentmultipool :
///       Provide a memory manager to manage pools of varying block sizes.
/// 
///  @ref bdlma_concurrentmultipoolallocator :
///       Provide an allocator to manage pools of varying object sizes.
/// 
///  @ref bdlma_concurrentpool :
///       Provide thread-safe allocation of memory blocks of uniform size.
/// 
///  @ref bdlma_concurrentpoolallocator :
///       Provide thread-safe memory-pooling allocator of fixed-size blocks.
/// 
///  @ref bdlma_countingallocator :
///       Provide a memory allocator that counts allocated bytes.
/// 
///  @ref bdlma_defaultdeleter :
///       Provide a concrete default deleter w/optionally-supplied allocator.
/// 
///  @ref bdlma_deleter :
///       Provide a protocol for deleting objects of parameterized type.
/// 
///  @ref bdlma_factory :
///       Provide a protocol for creator/deleter of parameterized objects.
/// 
///  @ref bdlma_guardingallocator :
///       Provide a memory allocator that guards against buffer overruns.
/// 
///  @ref bdlma_heapbypassallocator :
///       Support memory allocation directly from virtual memory.
/// 
///  @ref bdlma_infrequentdeleteblocklist :
///       Provide allocation and management of infrequently deleted blocks.
/// 
///  @ref bdlma_localbufferedobject :
///       Provide easy way to create an object with a local arena allocator.
/// 
///  'bdlma_localbufferedobject_cpp03':                                  !PRIVATE!
///       Provide C++03 implementation for bdlma_localbufferedobject.h
/// 
///  @ref bdlma_localsequentialallocator :
///       Provide an efficient managed allocator using a local buffer.
/// 
///  @ref bdlma_managedallocator :
///       Provide a protocol for memory allocators that support `release`.
/// 
///  @ref bdlma_memoryblockdescriptor :
///       Provide a class describing a block of memory.
/// 
///  @ref bdlma_multipool :
///       Provide a memory manager to manage pools of varying block sizes.
/// 
///  @ref bdlma_multipoolallocator :
///       Provide a memory-pooling allocator of heterogeneous block sizes.
/// 
///  @ref bdlma_pool :
///       Provide efficient allocation of memory blocks of uniform size.
/// 
///  @ref bdlma_sequentialallocator :
///       Provide a managed allocator using dynamically-allocated buffers.
/// 
///  @ref bdlma_sequentialpool :
///       Provide sequential memory using dynamically-allocated buffers.
///
/// @}
/** @} */