bdldfp_decimalstorage.h

Go to the documentation of this file.

/// @file bdldfp_decimalstorage.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdldfp_decimalstorage.h                                            -*-C++-*-
#ifndef INCLUDED_BDLDFP_DECIMALSTORAGE
#define INCLUDED_BDLDFP_DECIMALSTORAGE
 
#include <bsls_ident.h>
BSLS_IDENT("$Id$")
 
/// @defgroup bdldfp_decimalstorage bdldfp_decimalstorage
/// @brief  Utilities for working with Decimal Storage types.
/// @addtogroup bdl
/// @{
/// @addtogroup bdldfp
/// @{
/// @addtogroup bdldfp_decimalstorage
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdldfp_decimalstorage-purpose"> Purpose</a>
/// * <a href="#bdldfp_decimalstorage-classes"> Classes </a>
/// * <a href="#bdldfp_decimalstorage-description"> Description </a>
///   * <a href="#bdldfp_decimalstorage-usage"> Usage </a>
///     * <a href="#bdldfp_decimalstorage-example-1-tbd"> Example 1: TBD </a>
///
/// # Purpose {#bdldfp_decimalstorage-purpose}
/// Utilities for working with Decimal Storage types.
///
/// # Classes {#bdldfp_decimalstorage-classes}
///
/// -  bdldfp::DecimalStorage: namespace for Decimal Storage types.
///
/// @see  bdldfp_decimal, bdldfp_decimalplatform,
///
/// # Description {#bdldfp_decimalstorage-description}
/// This component provides a namespace, `bdldfp::DecimalStorage`,
/// that supplies the necessary types for storing a Binary Integral Decimal
/// (BID) representation of a decimal floating point value.
///
/// ## Usage {#bdldfp_decimalstorage-usage}
///
///
/// This section shows the intended use of this component.
///
/// ### Example 1: TBD {#bdldfp_decimalstorage-example-1-tbd}
///
///
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdldfp
 * @{
 */
/** @addtogroup bdldfp_decimalstorage
 * @{
 */
 
#include <bdlscm_version.h>
 
#include <bdldfp_intelimpwrapper.h>
 
 
namespace bdldfp {
 
                        // ====================
                        // class DecimalStorage
                        // ====================
 
/// This `struct` provides a namespace for types for storing Binary Integral
/// Decimal representation of a decimal floating point value.
///
/// See @ref bdldfp_decimalstorage 
struct DecimalStorage {
 
    // TYPES
    typedef BID_UINT32  Type32;
    typedef BID_UINT64  Type64;
    typedef BID_UINT128 Type128;
};
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2014 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */