Decimal.Operations.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 <OnixS/CME/MDH/ABI.h>
 
#include <OnixS/CME/MDH/messaging/Decimal.h>
#include <OnixS/CME/MDH/messaging/Composites.h>
 
#include <limits>
#include <type_traits>
 
ONIXS_CMEMDH_MESSAGING_NAMESPACE_BEGIN

ONIXS_CMEMDH_EXPORTED
ONIXS_CMEMDH_COLDPATH
ONIXS_CMEMDH_NORETURN
void throwCannotQuantizeOrConvert();
 
//

typedef Int64 DecimalMantissa;
 typedef Int32 DecimalExponent;
typedef FloatingPointDecimal<DecimalMantissa, DecimalExponent> Decimal;
 
namespace details
{
    template <class MantissaType>
    typename std::enable_if<std::numeric_limits<MantissaType>::is_signed, bool>::type
        isMantissaInRange(Decimal::Mantissa value) noexcept
    {
        return static_cast<Decimal::Mantissa>((std::numeric_limits<MantissaType>::min)()) <= value &&
            value <= static_cast<Decimal::Mantissa>((std::numeric_limits<MantissaType>::max)());
    }
 
    template <class MantissaType>
    typename std::enable_if<!std::numeric_limits<MantissaType>::is_signed && (sizeof(MantissaType) < sizeof(Decimal::Mantissa)), bool>::type
        isMantissaInRange(Decimal::Mantissa value) noexcept
    {
        return Decimal::Mantissa() <= value &&
            value <= static_cast<Decimal::Mantissa>((std::numeric_limits<MantissaType>::max)());
    }
 
    template <class MantissaType>
    typename std::enable_if<!std::numeric_limits<MantissaType>::is_signed && (sizeof(MantissaType) >= sizeof(Decimal::Mantissa)), bool>::type
        isMantissaInRange(Decimal::Mantissa value) noexcept
    {
        return Decimal::Mantissa() <= value;
    }
 
    template <class ExponentType>
    typename std::enable_if<std::numeric_limits<ExponentType>::is_signed && (sizeof(ExponentType) < sizeof(Decimal::Exponent)), bool>::type
        isExponentInRange(Decimal::Exponent value) noexcept
    {
        return static_cast<Decimal::Exponent>((std::numeric_limits<ExponentType>::min)()) <= value &&
            value <= static_cast<Decimal::Exponent>((std::numeric_limits<ExponentType>::max)());
    }
 
    template <class ExponentType>
    typename std::enable_if<std::numeric_limits<ExponentType>::is_signed && (sizeof(ExponentType) >= sizeof(Decimal::Exponent)), bool>::type
        isExponentInRange(Decimal::Exponent) noexcept
    {
        return true;
    }
 
    template <class ExponentType>
    typename std::enable_if<!std::numeric_limits<ExponentType>::is_signed && (sizeof(ExponentType) < sizeof(Decimal::Exponent)), bool>::type
        isExponentInRange(Decimal::Exponent value) noexcept
    {
        return Decimal::Exponent() <= value &&
            value <= static_cast<Decimal::Exponent>((std::numeric_limits<ExponentType>::max)());
    }
 
    template <class ExponentType>
    typename std::enable_if<!std::numeric_limits<ExponentType>::is_signed && (sizeof(ExponentType) >= sizeof(Decimal::Exponent)), bool>::type
        isExponentInRange(Decimal::Exponent value) noexcept
    {
        return Decimal::Exponent() <= value;
    }
}

inline constexpr bool isNull(const Decimal&) noexcept
{
    return false;
}

ONIXS_CMEMDH_EXPORTED
bool quantize(const Decimal& operand, Int32 exponent, Decimal& quantized);

ONIXS_CMEMDH_EXPORTED
ONIXS_CMEMDH_NODISCARD
Decimal quantize(const Decimal& operand, Int32 exponent);

template <class MantissaType>
ONIXS_CMEMDH_NODISCARD MantissaType quantizedMantissa(const Decimal& operand, Int32 exponent)
{
    const auto res = quantize(operand, exponent).mantissa();
 
    if ONIXS_CMEMDH_UNLIKELY(!details::isMantissaInRange<MantissaType>(res))
        throwCannotQuantizeOrConvert();
 
    return static_cast<MantissaType>(res);
}
 
template <class MantissaType, class ExponentType>
void convert(FixedPointDecimal<MantissaType, ExponentType>& res, const Decimal& number)
{
    res = FixedPointDecimal<MantissaType, ExponentType>(quantizedMantissa<MantissaType>(number, ExponentType()));
}
 
template <class MantissaType, class ExponentType>
void convert(FloatingPointDecimal<MantissaType, ExponentType>& res, const Decimal& number)
{
    if ONIXS_CMEMDH_UNLIKELY(!details::isMantissaInRange<MantissaType>(number.mantissa()) ||
        !details::isExponentInRange<ExponentType>(number.exponent()))
        throwCannotQuantizeOrConvert();
 
    res = FloatingPointDecimal<MantissaType, ExponentType>(
        static_cast<MantissaType>(number.mantissa()),
        static_cast<ExponentType>(number.exponent()));
}

template <class DecimalT>
ONIXS_CMEMDH_NODISCARD typename std::enable_if<details::IsDecimal<DecimalT>::value, DecimalT>::type
convert(const Decimal& number)
{
    DecimalT res;
    convert(res, number);
    return res;
}

ONIXS_CMEMDH_EXPORTED
ONIXS_CMEMDH_PURE
bool decimalEqual(const Decimal& left, const Decimal& right) noexcept;

inline bool operator==(const Decimal& left, const Decimal& right) noexcept
{
    return ((left.exponent() == right.exponent()) ? (left.mantissa() == right.mantissa()) : decimalEqual(left, right));
}

inline bool operator!=(const Decimal& left, const Decimal& right)
{
    return ((left.exponent() == right.exponent()) ? (left.mantissa() != right.mantissa()) : !decimalEqual(left, right));
}

ONIXS_CMEMDH_EXPORTED
ONIXS_CMEMDH_PURE
bool decimalLess(const Decimal& left, const Decimal& right) noexcept;

inline bool operator<(const Decimal& left, const Decimal& right) noexcept
{
    return ((left.exponent() == right.exponent()) ? (left.mantissa() < right.mantissa()) : decimalLess(left, right));
}

inline bool operator<=(const Decimal& left, const Decimal& right)
{
    return !(right < left);
}

inline bool operator>(const Decimal& left, const Decimal& right)
{
    return (right < left);
}

inline bool operator>=(const Decimal& left, const Decimal& right)
{
    return (right <= left);
}

ONIXS_CMEMDH_EXPORTED
void decimalToStr(std::string&, Int64, Int32);

ONIXS_CMEMDH_EXPORTED
size_t toStr(const Decimal&, Char* buf, size_t size);

ONIXS_CMEMDH_EXPORTED
bool fromStr(Decimal&, const Char*, size_t);

inline bool fromStr(Decimal& value, const std::string& str)
{
    return fromStr(value, str.c_str(), str.size());
}

inline void toStr(std::string& str, const Decimal& number)
{
    decimalToStr(str, number.mantissa(), number.exponent());
}

template <class Mantissa, class Exponent>
inline void toStr(std::string& str, const FloatingPointDecimal<Mantissa, Exponent>& number)
{
    if (isNull(number))
    {
        str += "[]";
        return;
    }
 
    toStr(str, Decimal(number));
}

template <class Mantissa, class Exponent>
inline void toStr(std::string& str, const FixedPointDecimal<Mantissa, Exponent>& number)
{
    if (isNull(number))
    {
        str += "[]";
        return;
    }
 
    toStr(str, Decimal(number));
}

template <class Mantissa, class Exponent>
inline ONIXS_CMEMDH_NODISCARD std::string toStr(const FloatingPointDecimal<Mantissa, Exponent>& number)
{
    std::string str;
 
    toStr(str, number);
 
    return str;
}

template <class Mantissa, class Exponent>
inline ONIXS_CMEMDH_NODISCARD std::string toStr(const FixedPointDecimal<Mantissa, Exponent>& number)
{
    std::string str;
 
    toStr(str, number);
 
    return str;
}

template <class Decimal1, class Decimal2>
void checkAgsValid(const Decimal1& arg1, const Decimal2& arg2)
{
    if (isNull(arg1) || isNull(arg2))
        throw std::invalid_argument("Provided argument is Null.");
}

template <class Mantissa, class Exponent>
ONIXS_CMEMDH_NODISCARD bool
operator==(const FixedPointDecimal<Mantissa, Exponent>& left, const FixedPointDecimal<Mantissa, Exponent>& right)
{
    if (isNull(left) && isNull(right))
        return true;
 
    return left.mantissa() == right.mantissa();
}

template <class Mantissa, class Exponent>
ONIXS_CMEMDH_NODISCARD bool
operator!=(const FixedPointDecimal<Mantissa, Exponent>& left, const FixedPointDecimal<Mantissa, Exponent>& right)
{
    return !(left == right);
}

template <class Mantissa, class Exponent>
ONIXS_CMEMDH_NODISCARD bool
operator<(const FixedPointDecimal<Mantissa, Exponent>& left, const FixedPointDecimal<Mantissa, Exponent>& right)
{
    checkAgsValid(left, right);
 
    return left.mantissa() < right.mantissa();
}

template <class Mantissa, class Exponent>
ONIXS_CMEMDH_NODISCARD bool
operator>(const FixedPointDecimal<Mantissa, Exponent>& left, const FixedPointDecimal<Mantissa, Exponent>& right)
{
    checkAgsValid(left, right);
 
    return left.mantissa() > right.mantissa();
}

template <class Mantissa, class Exponent>
ONIXS_CMEMDH_NODISCARD bool
operator<=(const FixedPointDecimal<Mantissa, Exponent>& left, const FixedPointDecimal<Mantissa, Exponent>& right)
{
    checkAgsValid(left, right);
 
    return left.mantissa() <= right.mantissa();
}

template <class Mantissa, class Exponent>
ONIXS_CMEMDH_NODISCARD bool
operator>=(const FixedPointDecimal<Mantissa, Exponent>& left, const FixedPointDecimal<Mantissa, Exponent>& right)
{
    checkAgsValid(left, right);
 
    return left.mantissa() >= right.mantissa();
}

template <class Decimal1, class Decimal2>
ONIXS_CMEMDH_NODISCARD
    typename std::enable_if<details::AreBothDecimals<Decimal1, Decimal2>::value, bool>::type
    operator==(const Decimal1& left, const Decimal2& right)
{
    if (isNull(left) && isNull(right))
        return true;
 
    return Decimal(left) == Decimal(right);
}

template <class Decimal1, class Decimal2>
ONIXS_CMEMDH_NODISCARD
    typename std::enable_if<details::AreBothDecimals<Decimal1, Decimal2>::value, bool>::type
    operator!=(const Decimal1& left, const Decimal2& right)
{
    return !(left == right);
}

template <class Decimal1, class Decimal2>
ONIXS_CMEMDH_NODISCARD
    typename std::enable_if<details::AreBothDecimals<Decimal1, Decimal2>::value, bool>::type
    operator>(const Decimal1& left, const Decimal2& right)
{
    checkAgsValid(left, right);
 
    return Decimal(left) > Decimal(right);
}

template <class Decimal1, class Decimal2>
ONIXS_CMEMDH_NODISCARD
    typename std::enable_if<details::AreBothDecimals<Decimal1, Decimal2>::value, bool>::type
    operator>=(const Decimal1& left, const Decimal2& right)
{
    checkAgsValid(left, right);
 
    return Decimal(left) >= Decimal(right);
}

template <class Decimal1, class Decimal2>
ONIXS_CMEMDH_NODISCARD
    typename std::enable_if<details::AreBothDecimals<Decimal1, Decimal2>::value, bool>::type
    operator<(const Decimal1& left, const Decimal2& right)
{
    checkAgsValid(left, right);
 
    return Decimal(left) < Decimal(right);
}

template <class Decimal1, class Decimal2>
ONIXS_CMEMDH_NODISCARD
    typename std::enable_if<details::AreBothDecimals<Decimal1, Decimal2>::value, bool>::type
    operator<=(const Decimal1& left, const Decimal2& right)
{
    checkAgsValid(left, right);
 
    return Decimal(left) <= Decimal(right);
}

template <class Mantissa, class Exponent>
std::ostream& operator<<(std::ostream& stream, const FixedPointDecimal<Mantissa, Exponent>& value)
{
    std::string str;
 
    toStr(str, value);
 
    return stream << str;
}

template <class Mantissa, class Exponent>
std::ostream& operator<<(std::ostream& stream, const FloatingPointDecimal<Mantissa, Exponent>& value)
{
    std::string str;
 
    toStr(str, value);
 
    return stream << str;
}
 
ONIXS_CMEMDH_MESSAGING_NAMESPACE_END