bdldfp.h

Go to the documentation of this file.

/// @file bdldfp.h
///
///
/// @defgroup bdldfp Package bdldfp
/// @brief  Basic Development Library Decimal Floating-Point (bdldfp)
/// @addtogroup bdl
/// @{
/// @addtogroup bdldfp
/// [bdldfp]: group__bdldfp.html
/// @{
///
/// # Purpose {#bdldfp-purpose}
/// Provide IEEE-754 2008 decimal floating-point types and utilities.
///
/// # Mnemonic {#bdldfp-mnemonic}
/// Basic Development Library Decimal Floating-Point (bdldfp)
///
/// # Description {#bdldfp-description}
/// The 'bdldfp' package provides IEEE-754 2008 decimal floating-
/// point types and utilities.
///
/// ## Hierarchical Synopsis
///
/// The 'bdldfp' package currently has 11 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. bdldfp_decimalconvertutil
///
///  7. bdldfp_decimalconvertutil_inteldfp                               !PRIVATE!
///     bdldfp_decimalutil
///
///  6. bdldfp_decimal
///
///  5. bdldfp_decimalimputil
///
///  4. bdldfp_decimalimputil_inteldfp                                   !PRIVATE!
///
///  3. bdldfp_decimalstorage
///
///  2. bdldfp_intelimpwrapper
///
///  1. bdldfp_decimalformatconfig
///     bdldfp_decimalplatform
///     bdldfp_uint128
/// @endcode
///
/// ## Component Synopsis
///
///  @ref bdldfp_decimal :
///       Provide IEEE-754 decimal floating-point types.
/// 
///  @ref bdldfp_decimalconvertutil :
///       Provide decimal floating-point conversion functions.
/// 
///  'bdldfp_decimalconvertutil_inteldfp':                               !PRIVATE!
///       Provide decimal floating-point conversion functions for Intel DFP.
/// 
///  @ref bdldfp_decimalformatconfig :
///       Provide an attribute class to configure decimal formatting.
/// 
///  @ref bdldfp_decimalimputil :
///       Provide a unified low-level interface for decimal floating point.
/// 
///  'bdldfp_decimalimputil_inteldfp':                                   !PRIVATE!
///       Provide utility to implement decimal `float`s on the Intel library.
/// 
///  @ref bdldfp_decimalplatform :
///       Provide decimal floating-point platform information macros.
/// 
///  @ref bdldfp_decimalstorage :
///       Utilities for working with Decimal Storage types.
/// 
///  @ref bdldfp_decimalutil :
///       Provide utilities dealing with floating point decimal objects.
/// 
///  @ref bdldfp_intelimpwrapper :
///       Provide a central mechanism to configure the Intel DFP library.
/// 
///  @ref bdldfp_uint128 :
///       Provide a representation of a 128-bit `int` for bitwise operations.
///
/// @}
/** @} */