Decimal.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/

#pragma once

#include <string>
#include <stdexcept>
#include <iosfwd>

#include <OnixS/Tradeweb/MarketData/Apa/ABI.h>
#include <OnixS/Tradeweb/MarketData/Apa/Defines.h>

namespace OnixS
{
    namespace Tradeweb
    {
        namespace MarketData
        {
            namespace Apa
            {
                typedef SInt64 DecimalMantissa;
                typedef SInt32 DecimalExponent;

                /// Decimal type for better precision.
                ///
                class ONIXS_TRADEWEB_APA_API Decimal
                {
                public:

                    /// Default constructor. Initializes the decimal value to zero.
                    ///
                    Decimal ();

                    /// Initializes instance from compound components.
                    ///
                    Decimal (DecimalMantissa mantissa, DecimalExponent exponent);

                    /// Initializes instance with zero exponent.
                    ///
                    explicit Decimal (SInt32 value);

                    /// Converts from Double value using
                    /// default conversion precision.
                    explicit Decimal (Double value);

                    /// Converts Double value to decimal.
                    /// @param value double precision floating-point value.
                    /// @param precision defines conversion precision.
                    Decimal (Double value, size_t precision);

                    /// Initializes as copy of given value.
                    ///
                    Decimal (const Decimal& other);

                    /// Returns mantissa part of decimal.
                    ///
                    DecimalMantissa mantissa() const;

                    /// Returns exponent part of decimal.
                    ///
                    DecimalExponent exponent() const;

                    /// Compares two numbers.
                    ///
                    bool operator == (const Decimal&) const;

                    /// Compares two numbers.
                    ///
                    bool operator != (const Decimal&) const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @throw domain_error exception on failure.
                    operator SInt32() const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @throw domain_error exception on failure.
                    operator UInt32() const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @throw domain_error exception on failure.
                    operator SInt64() const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @throw domain_error exception on failure.
                    operator UInt64() const;

                    /// Casts to whole floating point as regular
                    /// value is casted to a smaller precision.
                    /// @throw domain_error exception on failure.
                    operator Double() const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @return false if conversion fails.
                    bool toNumber (SInt32&) const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @return false if conversion fails.
                    bool toNumber (UInt32&) const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @return false if conversion fails.
                    bool toNumber (SInt64&) const;

                    /// Casts to whole integer number as regular
                    /// floating point value is casted.
                    /// @return false if conversion fails.
                    bool toNumber (UInt64&) const;

                    /// Casts to floating point number.
                    /// @return false if conversion fails.
                    bool toNumber (Double&) const;

                    /// Appends text presentation to given string.
                    ///
                    void toString (std::string&) const;

                    /// Returns text presentation of decimal.
                    ///
                    std::string toString() const;

                    /// Reinitializes instance from another one.
                    ///
                    Decimal&
                    operator = (
                    const Decimal& other);

                    /// Attempts to parse decimal value
                    /// from its string/text presentation.
                    /// @return false on parsing failure.
                    static
                    bool tryParse (const char* buffer, size_t bufferSize, Decimal&);

                    /// Parses decimal from string presentation.
                    /// @throw std::exception on failure.
                    static
                    Decimal parse (const char* buffer, size_t bufferSize);

                private:
                    /// Mantissa.
                    ///
                    DecimalMantissa mantissa_;

                    /// Exponent.
                    ///
                    DecimalExponent exponent_;
                };

                ONIXS_TRADEWEB_APA_API bool operator < (const Decimal& l, const Decimal& r);
                ONIXS_TRADEWEB_APA_API bool operator > (const Decimal& l, const Decimal& r);
                ONIXS_TRADEWEB_APA_API bool operator <= (const Decimal& l, const Decimal& r);
                ONIXS_TRADEWEB_APA_API bool operator >= (const Decimal& l, const Decimal& r);

                inline Decimal::Decimal ()
                        : mantissa_ (0),
                          exponent_ (0)
                {
                }

                inline DecimalMantissa Decimal::mantissa() const
                {
                    return mantissa_;
                }

                inline DecimalExponent Decimal::exponent() const
                {
                    return exponent_;
                }

                inline Decimal::operator SInt32() const
                {
                    SInt32 number;

                    if (toNumber (number) )
                        return number;

                    throw std::domain_error ("Cannot cast value to target type. ");
                }

                inline Decimal::operator UInt32() const
                {
                    UInt32 number;

                    if (toNumber (number) )
                        return number;

                    throw std::domain_error ("Cannot cast value to target type. ");
                }

                inline Decimal::operator SInt64() const
                {
                    SInt64 number;

                    if (toNumber (number) )
                        return number;

                    throw std::domain_error ("Cannot cast value to target type. ");
                }

                inline Decimal::operator UInt64() const
                {
                    UInt64 number;

                    if (toNumber (number) )
                        return number;

                    throw std::domain_error ("Cannot cast value to target type. ");
                }

                inline Decimal::operator Double() const
                {
                    Double number;

                    if (toNumber (number) )
                        return number;

                    throw std::domain_error ("Cannot cast value to target type. ");
                }

                inline std::string Decimal::toString() const
                {
                    std::string presentation;
                    toString (presentation);
                    return presentation;
                }


                inline
                void toStr(std::string& str, const Decimal& value)
                {
                    std::string presentation;
                    value.toString (presentation);
                    str += presentation;
                }
            }
        }
    }
}

namespace std
{
    /// Outputs into standard stream.
    ///
    ONIXS_TRADEWEB_APA_API std::ostream& operator <<(std::ostream&, const OnixS::Tradeweb::MarketData::Apa::Decimal&);
}