bdlb.h

Go to the documentation of this file.

/// @file bdlb.h
///
///
/// @defgroup bdlb Package bdlb
/// @brief  Basic Development Library Basis (bdlb)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlb
/// @{
/// * <a href="#bdlb-purpose"> Purpose</a>
/// * <a href="#bdlb-mnemonic"> Mnemonic </a>
/// * <a href="#bdlb-description"> Description </a>
///   * <a href="#bdlb-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bdlb-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bdlb-purpose}
/// Provide basic types and utilities.
///
/// # Mnemonic {#bdlb-mnemonic}
/// Basic Development Library Basis (bdlb)
///
/// # Description {#bdlb-description}
/// The 'bdlb' package provides utility 'struct's in the broad areas
/// of bit manipulation, string handling, random number generation, and hashing.
/// Classes representing nullable and variant types are also provided.
///
/// ## Hierarchical Synopsis {#bdlb-hierarchical-synopsis}
///
/// The 'bdlb' package currently has 57 components having 5 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
///  5. bdlb_bitstringutil
///     bdlb_indexspanstringutil
///     bdlb_indexspanutil
///     bdlb_nullablevalueref
///
///  4. bdlb_bigendian
///     bdlb_bitstringimputil
///     bdlb_caselessstringviewequalto
///     bdlb_caselessstringviewless
///     bdlb_indexspan
///     bdlb_nullableallocatedvalue
///     bdlb_nullablevalue
///     bdlb_optionalprinter
///     bdlb_printadapter
///     bdlb_variant
///     bdlb_variantprinter
///
///  3. bdlb_bitmaskutil
///     bdlb_caselessstringviewhash
///     bdlb_doublecompareutil
///     bdlb_guidutil
///     bdlb_numericparseutil
///     bdlb_printmethods
///     bdlb_random
///     bdlb_string
///     bdlb_stringviewutil
///
///  2. bdlb_algorithmworkaroundutil
///     bdlb_arrayutil
///     bdlb_bitutil
///     bdlb_chartype
///     bdlb_cstringequalto
///     bdlb_cstringhash
///     bdlb_cstringless
///     bdlb_float
///     bdlb_functionoutputiterator
///     bdlb_guid
///     bdlb_hashutil
///     bdlb_literalutil
///     bdlb_nullableallocatedvalue_pointerbitspair                      !PRIVATE!
///     bdlb_nullopt                                        !DEPRECATED!
///     bdlb_nulloutputiterator
///     bdlb_pairutil
///     bdlb_pcgrandomgenerator
///     bdlb_print
///     bdlb_randomdevice
///     bdlb_scopeexit
///     bdlb_stringrefutil                                  !DEPRECATED!
///     bdlb_testinputiterator                              !DEPRECATED!
///     bdlb_tokenizer
///     bdlb_topologicalsortutil
///     bdlb_transformiterator
///     bdlb_transparentequalto
///     bdlb_transparenthash
///     bdlb_transparentless
///     bdlb_transparentstringhash
///
///  1. bdlb_nullableallocatedvalue_cpp03                                !PRIVATE!
///     bdlb_nullablevalue_cpp03                                         !PRIVATE!
///     bdlb_nullablevalueref_cpp03                                      !PRIVATE!
///     bdlb_variant_cpp03                                               !PRIVATE!
/// @endcode
///
/// ## Component Synopsis {#bdlb-component-synopsis}
///
///  @ref bdlb_algorithmworkaroundutil :
///       Provide a namespace for workarounds for faulty standard algorithms
/// 
///  @ref bdlb_arrayutil :
///       Provide utilities to determine properties of fixed-sized arrays.
/// 
///  @ref bdlb_bigendian :
///       Provide big-endian integer types.
/// 
///  @ref bdlb_bitmaskutil :
///       Provide simple mask values of `uint32_t` and `uint64_t` types.
/// 
///  @ref bdlb_bitstringimputil :
///       Provide functional bit-manipulation of `uint64_t` values.
/// 
///  @ref bdlb_bitstringutil :
///       Provide efficient operations on a multi-word sequence of bits.
/// 
///  @ref bdlb_bitutil :
///       Provide efficient bit-manipulation of `uint32_t`/`uint64_t` values.
/// 
///  @ref bdlb_caselessstringviewequalto :
///       Provide a case-insensitive equality predicate for string views.
/// 
///  @ref bdlb_caselessstringviewhash :
///       Provide a case-insensitive hash functor for string views.
/// 
///  @ref bdlb_caselessstringviewless :
///       Provide a case-insensitive less-than predicate for string views.
/// 
///  @ref bdlb_chartype :
///       Supply locale-independent version of `<ctype.h>` functionality.
/// 
///  @ref bdlb_cstringequalto :
///       Provide a standard compatible equality predicate for C-strings.
/// 
///  @ref bdlb_cstringhash :
///       Provide a functor enabling C-strings as unordered-container keys.
/// 
///  @ref bdlb_cstringless :
///       Provide a standard compatible less-than predicate for C-strings.
/// 
///  @ref bdlb_doublecompareutil :
///       Provide "fuzzy" equality/relational operations on `double` values.
/// 
///  @ref bdlb_float :
///       Provide floating-point classification types and functions.
/// 
///  @ref bdlb_functionoutputiterator :
///       Provides an output iterator for a client-supplied functor.
/// 
///  @ref bdlb_guid :
///       Provide a value-semantic type for Globally Unique Identifiers.
/// 
///  @ref bdlb_guidutil :
///       Provide functions that produce Globally Unique Identifiers.
/// 
///  @ref bdlb_hashutil :
///       Provide a utility of hash functions.
/// 
///  @ref bdlb_indexspan :
///       Provide a value-semantic attribute type for position and length.
/// 
///  @ref bdlb_indexspanstringutil :
///       Provide functions that operate on `IndexSpan` and string objects.
/// 
///  @ref bdlb_indexspanutil :
///       Provide functions that operate on `IndexSpan` objects.
/// 
///  @ref bdlb_literalutil :
///       Provide utility routines for programming language literals.
/// 
///  @ref bdlb_nullableallocatedvalue :
///       Provide a template for nullable allocated (out-of-place) objects.
/// 
///  @ref bdlb_nullableallocatedvalue_cpp03 :                                !PRIVATE!
///       Provide C++03 implementation for bdlb_nullableallocatedvalue.h
/// 
///  @ref bdlb_nullableallocatedvalue_pointerbitspair :                      !PRIVATE!
///       Provide a mechanism for using the unused bits of a pointer.
/// 
///  @ref bdlb_nullablevalue :
///       Provide a template for nullable (in-place) objects.
/// 
///  @ref bdlb_nullablevalue_cpp03 :                                         !PRIVATE!
///       Provide C++03 implementation for bdlb_nullablevalue.h
/// 
///  @ref bdlb_nullablevalueref :
///       *Tech* *preview* for non-owning reference to nullable objects.
/// 
///  @ref bdlb_nullablevalueref_cpp03 :                                      !PRIVATE!
///       Provide C++03 implementation for bdlb_nullablevalueref.h
/// 
///  @ref bdlb_nullopt :                                        !DEPRECATED!
///       Provide a tag type and constant indicating an empty nullable value.
/// 
///  @ref bdlb_nulloutputiterator :
///       Provide an output iterator type that discards output.
/// 
///  @ref bdlb_numericparseutil :
///       Provide conversions from text into fundamental numeric types.
/// 
///  @ref bdlb_optionalprinter :
///       Provide a suite of helper classes for printing `bsl::optional`.
/// 
///  @ref bdlb_pairutil :
///       Provide support functions for `bsl::pair`.
/// 
///  @ref bdlb_pcgrandomgenerator :
///       Provide a class to generate random numbers using the PCG algorithm.
/// 
///  @ref bdlb_print :
///       Provide platform-independent stream utilities.
/// 
///  @ref bdlb_printadapter :
///       Provide object for streaming objects using `bdlb::PrintMethods`.
/// 
///  @ref bdlb_printmethods :
///       Provide methods for uniform printing of value-semantic types.
/// 
///  @ref bdlb_random :
///       Provide a suite of procedures for random-number generation.
/// 
///  @ref bdlb_randomdevice :
///       Provide a common interface to a system's random number generator.
/// 
///  @ref bdlb_scopeexit :
///       Provide a general-purpose proctor object for scope-exit logic.
/// 
///  @ref bdlb_string :
///       Provide utility functions on STL-style and C-style strings.
/// 
///  @ref bdlb_stringrefutil :                                  !DEPRECATED!
///       Provide utility functions on `bslstl::StringRef`-erenced strings.
/// 
///  @ref bdlb_stringviewutil :
///       Provide utility functions on `bsl::string_view` containers.
/// 
///  @ref bdlb_testinputiterator :                              !DEPRECATED!
///       Provide a pure input iterator for an empty range.
/// 
///  @ref bdlb_tokenizer :
///       Provide access to user-described tokens via string references.
/// 
///  @ref bdlb_topologicalsortutil :
///       Provide a utility to topologically sort a collection of inputs.
/// 
///  @ref bdlb_transformiterator :
///       Provide a wrapping iterator that invokes a functor on dereference.
/// 
///  @ref bdlb_transparentequalto :
///       Provide a transparent equality predicate.
/// 
///  @ref bdlb_transparenthash :
///       Provide a transparent hash functor.
/// 
///  @ref bdlb_transparentless :
///       Provide a transparent less-than predicate.
/// 
///  @ref bdlb_transparentstringhash :
///       Provide a transparent hash functor.
/// 
///  @ref bdlb_variant :
///       Provide a variant (discriminated `union`-like) type.
/// 
///  @ref bdlb_variant_cpp03 :                                               !PRIVATE!
///       Provide C++03 implementation for bdlb_variant.h
/// 
///  @ref bdlb_variantprinter :
///       Provide a suite of helper classes for printing `bsl::variant`.
///
/// @}
/** @} */