Fiscus/Pods/Realm/include/core/realm/decimal128.hpp

/*************************************************************************
 *
 * Copyright 2019 Realm Inc.
 *
 * 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.
 *
 **************************************************************************/

#ifndef REALM_DECIMAL_HPP
#define REALM_DECIMAL_HPP

#include <realm/string_data.hpp>

#include <string>
#include <cstring>

#include "null.hpp"

namespace realm {

class Decimal128 {
public:
    // Indicates if constructing a Decimal128 from a double should round the double to 15 digits
    // or 7 digits. This will make 'string -> (float/double) -> Decimal128 -> string' give the
    // expected result.
    enum class RoundTo { Digits7 = 0, Digits15 = 1 };

    struct Bid64 {
        Bid64(uint64_t x)
            : w(x)
        {
        }
        uint64_t w;
    };
    struct Bid128 {
        uint64_t w[2];
    };
    Decimal128() noexcept;
    explicit Decimal128(int64_t) noexcept;
    explicit Decimal128(uint64_t) noexcept;
    explicit Decimal128(int) noexcept;
    explicit Decimal128(double, RoundTo = RoundTo::Digits15) noexcept;
    explicit Decimal128(float val) noexcept
        : Decimal128(double(val), RoundTo::Digits7)
    {
    }
    Decimal128(Bid128 coefficient, int exponent, bool sign) noexcept;
    explicit Decimal128(Bid64) noexcept;
    explicit Decimal128(StringData) noexcept;
    explicit Decimal128(Bid128 val) noexcept
    {
        m_value = val;
    }
    Decimal128(null) noexcept;
    static Decimal128 nan(const char*) noexcept;
    static bool is_valid_str(StringData) noexcept;

    bool is_null() const noexcept;
    bool is_nan() const noexcept;

    bool to_int(int64_t& i) const noexcept;

    bool operator==(const Decimal128& rhs) const noexcept;
    bool operator!=(const Decimal128& rhs) const noexcept;
    bool operator<(const Decimal128& rhs) const noexcept;
    bool operator>(const Decimal128& rhs) const noexcept;
    bool operator<=(const Decimal128& rhs) const noexcept;
    bool operator>=(const Decimal128& rhs) const noexcept;

    int compare(const Decimal128& rhs) const noexcept;

    Decimal128 operator*(int64_t mul) const noexcept;
    Decimal128 operator*(size_t mul) const noexcept;
    Decimal128 operator*(int mul) const noexcept;
    Decimal128 operator*(Decimal128 mul) const noexcept;
    Decimal128& operator*=(Decimal128 mul) noexcept
    {
        return *this = *this * mul;
    }
    Decimal128 operator/(int64_t div) const noexcept;
    Decimal128 operator/(size_t div) const noexcept;
    Decimal128 operator/(int div) const noexcept;
    Decimal128 operator/(Decimal128 div) const noexcept;
    Decimal128& operator/=(Decimal128 div) noexcept
    {
        return *this = *this / div;
    }
    Decimal128& operator+=(Decimal128) noexcept;
    Decimal128 operator+(Decimal128 rhs) const noexcept
    {
        auto ret(*this);
        ret += rhs;
        return ret;
    }
    Decimal128& operator-=(Decimal128) noexcept;
    Decimal128 operator-(Decimal128 rhs) const noexcept
    {
        auto ret(*this);
        ret -= rhs;
        return ret;
    }

    std::string to_string() const noexcept;
    Bid64 to_bid64() const;
    const Bid128* raw() const noexcept
    {
        return &m_value;
    }
    Bid128* raw() noexcept
    {
        return &m_value;
    }
    void unpack(Bid128& coefficient, int& exponent, bool& sign) const noexcept;

private:
    // The high word of a Decimal128 consists of 49 bit coefficient, 14 bit exponent and a sign bit
    static constexpr int DECIMAL_EXPONENT_BIAS_128 = 6176;
    static constexpr int DECIMAL_COEFF_HIGH_BITS = 49;
    static constexpr int DECIMAL_EXP_BITS = 14;
    static constexpr uint64_t MASK_COEFF = (1ull << DECIMAL_COEFF_HIGH_BITS) - 1;
    static constexpr uint64_t MASK_EXP = ((1ull << DECIMAL_EXP_BITS) - 1) << DECIMAL_COEFF_HIGH_BITS;
    static constexpr uint64_t MASK_SIGN = 1ull << (DECIMAL_COEFF_HIGH_BITS + DECIMAL_EXP_BITS);

    Bid128 m_value;

    uint64_t get_coefficient_high() const noexcept
    {
        return m_value.w[1] & MASK_COEFF;
    }
    uint64_t get_coefficient_low() const noexcept
    {
        return m_value.w[0];
    }
};

inline std::ostream& operator<<(std::ostream& ostr, const Decimal128& id)
{
    ostr << id.to_string();
    return ostr;
}

} // namespace realm

namespace std {
template <>
struct numeric_limits<realm::Decimal128> {
    static constexpr bool is_integer = false;
    static realm::Decimal128 lowest() noexcept
    {
        return realm::Decimal128("-Inf");
    }
    static realm::Decimal128 max() noexcept
    {
        return realm::Decimal128("+Inf");
    }
};

} // namespace std

#endif /* REALM_DECIMAL_HPP */