bslstp.h

Go to the documentation of this file.

/// @file bslstp.h
///
///
/// @defgroup bslstp Package bslstp
/// @brief  Basic Standard Library STlPort types (bslstp)
/// @addtogroup bsl
/// @{
/// @addtogroup bslstp
/// [bslstp]: group__bslstp.html
/// @{
///
/// # Purpose {#bslstp-purpose}
/// Provide replacement classes (adopted from STLport) for STL.
///
///@INTERNAL_DEPRECATED: Do not use directly.
///
/// # Mnemonic {#bslstp-mnemonic}
/// Basic Standard Library STlPort types (bslstp)
///
/// # Description {#bslstp-description}
/// This package mainly provides replacement classes, adopted from
/// STLport, for STL constructs that required modification to (inter)operate with
/// BDE libraries.  In addition to STL replacement classes, this package also
/// provides helper components for the STL implementation classes.
///
/// In general, the components in this package conform to the STL interface.
/// However, the components (and hence the headers) are intended for private use
/// only.  Clients should use the standard headers directly (e.g., include
/// '<bsl_hash_map.h>' instead of '<bslstp_hashmap.h>').
///
/// ## Hierarchical Synopsis
///
/// The 'bslstp' package currently has 10 components having 3 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
///  3. bslstp_hashmap                                      !DEPRECATED!
///     bslstp_hashset                                      !DEPRECATED!
///
///  2. bslstp_hashtable                                    !DEPRECATED!
///     bslstp_slist                                        !DEPRECATED!
///
///  1. bslstp_alloc                                        !DEPRECATED!
///     bslstp_exfunctional                                 !DEPRECATED!
///     bslstp_hash                                         !DEPRECATED!
///     bslstp_iterator                                     !DEPRECATED!
///     bslstp_slistbase                                    !DEPRECATED!
///     bslstp_util                                         !DEPRECATED!
/// @endcode
///
/// ## Component Synopsis
///
///  @ref bslstp_alloc :                                        !DEPRECATED!
///       Provide facilities for STLPort implementation.
/// 
///  @ref bslstp_exfunctional :                                 !DEPRECATED!
///       Provide a namespace for functional extensions.
/// 
///  @ref bslstp_hash :                                         !DEPRECATED!
///       Provide a namespace for hash functions.
/// 
///  @ref bslstp_hashmap :                                      !DEPRECATED!
///       Provide containers indexed by a hashed key value.
/// 
///  @ref bslstp_hashset :                                      !DEPRECATED!
///       Provide containers hashed by value.
/// 
///  @ref bslstp_hashtable :                                    !DEPRECATED!
///       Provide facilities for STLPort implementation.
/// 
///  @ref bslstp_iterator :                                     !DEPRECATED!
///       Provide facility for STLPort implementation.
/// 
///  @ref bslstp_slist :                                        !DEPRECATED!
///       Provide a singly linked list container.
/// 
///  @ref bslstp_slistbase :                                    !DEPRECATED!
///       Provide facility for STLPort implementation.
/// 
///  @ref bslstp_util :                                         !DEPRECATED!
///       Provide a namespace for utility functions for STL functionality.
///
/// @}
/** @} */