IOUAmount.h

#pragma once
 
#include <xrpl/basics/Number.h>
#include <xrpl/beast/utility/Zero.h>
 
#include <boost/operators.hpp>
 
#include <cstdint>
#include <ostream>
#include <string>
 
namespace xrpl {

class IOUAmount : private boost::totally_ordered<IOUAmount>, private boost::additive<IOUAmount>
{
private:
    using mantissa_type = std::int64_t;
    using exponent_type = int;
    mantissa_type mantissa_{};
    exponent_type exponent_{};

    void
    normalize();
 
    static IOUAmount
    fromNumber(Number const& number);
 
public:
    IOUAmount() = default;
    explicit IOUAmount(Number const& other);
    IOUAmount(beast::Zero);
    IOUAmount(mantissa_type mantissa, exponent_type exponent);
 
    IOUAmount& operator=(beast::Zero);
 
    operator Number() const;
 
    IOUAmount&
    operator+=(IOUAmount const& other);
 
    IOUAmount&
    operator-=(IOUAmount const& other);
 
    IOUAmount
    operator-() const;
 
    bool
    operator==(IOUAmount const& other) const;
 
    bool
    operator<(IOUAmount const& other) const;

    explicit
    operator bool() const noexcept;

    [[nodiscard]] int
    signum() const noexcept;
 
    [[nodiscard]] exponent_type
    exponent() const noexcept;
 
    [[nodiscard]] mantissa_type
    mantissa() const noexcept;
 
    static IOUAmount
    minPositiveAmount();
 
    friend std::ostream&
    operator<<(std::ostream& os, IOUAmount const& x)
    {
        return os << to_string(x);
    }
};
 
inline IOUAmount::IOUAmount(beast::Zero)
{
    *this = beast::kZero;
}
 
inline IOUAmount::IOUAmount(mantissa_type mantissa, exponent_type exponent)
    : mantissa_(mantissa), exponent_(exponent)
{
    normalize();
}
 
inline IOUAmount&
IOUAmount::operator=(beast::Zero)
{
    // The -100 is used to allow 0 to sort less than small positive values
    // which will have a large negative exponent.
    mantissa_ = 0;
    exponent_ = -100;
    return *this;
}
 
inline IOUAmount::
operator Number() const
{
    return Number{mantissa_, exponent_};
}
 
inline IOUAmount&
IOUAmount::operator-=(IOUAmount const& other)
{
    *this += -other;
    return *this;
}
 
inline IOUAmount
IOUAmount::operator-() const
{
    return {-mantissa_, exponent_};
}
 
inline bool
IOUAmount::operator==(IOUAmount const& other) const
{
    return exponent_ == other.exponent_ && mantissa_ == other.mantissa_;
}
 
inline bool
IOUAmount::operator<(IOUAmount const& other) const
{
    return Number{*this} < Number{other};
}
 
inline IOUAmount::
operator bool() const noexcept
{
    return mantissa_ != 0;
}
 
inline int
IOUAmount::signum() const noexcept
{
    if (mantissa_ < 0)
        return -1;
    return (mantissa_ != 0) ? 1 : 0;
}
 
inline IOUAmount::exponent_type
IOUAmount::exponent() const noexcept
{
    return exponent_;
}
 
inline IOUAmount::mantissa_type
IOUAmount::mantissa() const noexcept
{
    return mantissa_;
}
 
std::string
to_string(IOUAmount const& amount);
 
/* Return num*amt/den
   This function keeps more precision than computing
   num*amt, storing the result in an IOUAmount, then
   dividing by den.
*/
IOUAmount
mulRatio(IOUAmount const& amt, std::uint32_t num, std::uint32_t den, bool roundUp);
 
}  // namespace xrpl