ieee_float.h

// Description: IEEE floating point numbers
// Documentation: bit_tricks.txt

#ifndef PASTELSYS_IEEE_FLOAT_H
#define PASTELSYS_IEEE_FLOAT_H

#include "pastel/sys/mytypes.h"
#include "pastel/sys/real/scientific_notation_fwd.h"

#include <type_traits>

namespace Pastel
{

    //! Returns the bits of the closest IEEE floating-point number.
    /*!
   Preconditions:
   Bits > 0
   E > 0
   M > 0
   E + M <= Bits

   returns:
   The closest floating-point number representative for
   (-1)^negative * 2^exponent * (1 + scaledMantissa / 2^64).
   The result will never be a not-a-number (NaN). Overflows
   return (-1)^negative infinity, and underflows return 
   (-1)^negative 0.
   */
    template <
        integer Bits,
        integer E,
        integer M>
    UIntegerOfSize<Bits> asIeeeFloatBits(
        const ScientificNotation& scientific);

    //! Returns the closest 32-bit IEEE floating-point number.
    /*!
   See the documentation for ieeeFloatBits().
   */
    template <
        typename Float_Ieee,
        Requires<std::is_same<Float_Ieee, real32_ieee>> = 0>
    Float_Ieee asIeeeFloat(
        const ScientificNotation& scientific);

    //! Returns the closest 64-bit IEEE floating-point number.
    /*!
   See the documentation for ieeeFloatBits().
   */
    template <
        typename Float_Ieee,
        Requires<std::is_same<Float_Ieee, real64_ieee>> = 0>
    Float_Ieee asIeeeFloat(
        const ScientificNotation& scientific);

    //! Returns a 32-bit IEEE floating-point number in scientific notation.
    template <
        typename Type,
        Requires<std::is_same<Type, real32_ieee>> = 0>
    ScientificNotation ieeeFloatAsScientific(Type that);

    //! Returns a 64-bit IEEE floating-point number in scientific notation.
    template <
        typename Type,
        Requires<std::is_same<Type, real64_ieee>> = 0>
    ScientificNotation ieeeFloatAsScientific(Type that);

}

#include "pastel/sys/real/ieee_float.hpp"

#endif