bdlc.h

Go to the documentation of this file.

/// @file bdlc.h
///
///
/// @defgroup bdlc Package bdlc
/// @brief  Basic Development Library Container (bdlc)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlc
/// @{
/// * <a href="#bdlc-purpose"> Purpose</a>
/// * <a href="#bdlc-mnemonic"> Mnemonic </a>
/// * <a href="#bdlc-description"> Description </a>
///   * <a href="#bdlc-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bdlc-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bdlc-purpose}
/// Provide container vocabulary types.
///
/// # Mnemonic {#bdlc-mnemonic}
/// Basic Development Library Container (bdlc)
///
/// # Description {#bdlc-description}
/// The 'bdlc' ("Basic Development Library Container") package
/// provides container vocabulary types.
///
/// ## Hierarchical Synopsis {#bdlc-hierarchical-synopsis}
///
/// The 'bdlc' package currently has 14 components having 4 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
///  4. bdlc_flathashmap
///     bdlc_flathashset
///
///  3. bdlc_compactedarray
///     bdlc_flathashtable
///     bdlc_packedintarrayutil
///
///  2. bdlc_bitarray
///     bdlc_flathashmap_cpp03                                           !PRIVATE!
///     bdlc_flathashtable_groupcontrol                                  !PRIVATE!
///     bdlc_hashtable
///     bdlc_indexclerk
///     bdlc_packedintarray
///     bdlc_queue                                          !DEPRECATED!
///
///  1. bdlc_flathashset_cpp03                                           !PRIVATE!
///     bdlc_flathashtable_cpp03                                         !PRIVATE!
/// @endcode
///
/// ## Component Synopsis {#bdlc-component-synopsis}
///
///  @ref bdlc_bitarray :
///       Provide a space-efficient, sequential container of boolean values.
/// 
///  @ref bdlc_compactedarray :
///       Provide a compacted array of `const` user-defined objects.
/// 
///  @ref bdlc_flathashmap :
///       Provide an open-addressed unordered map container.
/// 
///  @ref bdlc_flathashmap_cpp03 :                                           !PRIVATE!
///       Provide C++03 implementation for bdlc_flathashmap.h
/// 
///  @ref bdlc_flathashset :
///       Provide an open-addressed unordered set container.
/// 
///  @ref bdlc_flathashset_cpp03 :                                           !PRIVATE!
///       Provide C++03 implementation for bdlc_flathashset.h
/// 
///  @ref bdlc_flathashtable :
///       Provide an open-addressed hash table like Abseil @ref flat_hash_map .
/// 
///  @ref bdlc_flathashtable_cpp03 :                                         !PRIVATE!
///       Provide C++03 implementation for bdlc_flathashtable.h
/// 
///  @ref bdlc_flathashtable_groupcontrol :                                  !PRIVATE!
///       Provide inquiries to a flat hash table group of control values.
/// 
///  @ref bdlc_hashtable :
///       Provide a double-hashed table with utility.
/// 
///  @ref bdlc_indexclerk :
///       Provide a manager of reusable, non-negative integer indices.
/// 
///  @ref bdlc_packedintarray :
///       Provide an extensible, packed array of integral values.
/// 
///  @ref bdlc_packedintarrayutil :
///       Provide common non-primitive operations on `bdlc::PackedIntArray`.
/// 
///  @ref bdlc_queue :                                          !DEPRECATED!
///       Provide an in-place double-ended queue of `T` values.
///
/// @}
/** @} */