Floating point representation of amounts with high dynamic range. More...
#include <IOUAmount.h>
Public Member Functions | |
| IOUAmount ()=default | |
| IOUAmount (Number const &other) | |
| IOUAmount (beast::Zero) | |
| IOUAmount (std::int64_t mantissa, int 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 |
| operator bool () const noexcept | |
| Returns true if the amount is not zero. | |
| int | signum () const noexcept |
| Return the sign of the amount. | |
| int | exponent () const noexcept |
| std::int64_t | mantissa () const noexcept |
Static Public Member Functions | |
| static IOUAmount | minPositiveAmount () |
Private Member Functions | |
| void | normalize () |
| Adjusts the mantissa and exponent to the proper range. | |
Private Attributes | |
| std::int64_t | mantissa_ |
| int | exponent_ |
Friends | |
| std::ostream & | operator<< (std::ostream &os, IOUAmount const &x) |
Detailed Description
Floating point representation of amounts with high dynamic range.
Amounts are stored as a normalized signed mantissa and an exponent. The range of the normalized exponent is [-96,80] and the range of the absolute value of the normalized mantissa is [1000000000000000, 9999999999999999].
Arithmetic operations can throw std::overflow_error during normalization if the amount exceeds the largest representable amount, but underflows will silently trunctate to zero.
Definition at line 25 of file IOUAmount.h.
Constructor & Destructor Documentation
◆ IOUAmount() [1/4]
|
default |
◆ IOUAmount() [2/4]
|
explicit |
Definition at line 109 of file IOUAmount.cpp.
◆ IOUAmount() [3/4]
| ripple::IOUAmount::IOUAmount | ( | beast::Zero | ) |
Definition at line 90 of file IOUAmount.h.
◆ IOUAmount() [4/4]
| ripple::IOUAmount::IOUAmount | ( | std::int64_t | mantissa, |
| int | exponent | ||
| ) |
Definition at line 95 of file IOUAmount.h.
Member Function Documentation
◆ normalize()
|
private |
Adjusts the mantissa and exponent to the proper range.
This can throw if the amount cannot be normalized, or is larger than the largest value that can be represented as an IOU amount. Amounts that are too small to be represented normalize to 0.
Definition at line 56 of file IOUAmount.cpp.
◆ operator=()
| IOUAmount & ripple::IOUAmount::operator= | ( | beast::Zero | ) |
Definition at line 102 of file IOUAmount.h.
◆ operator Number()
| ripple::IOUAmount::operator Number | ( | ) | const |
Definition at line 111 of file IOUAmount.h.
◆ operator+=()
Definition at line 119 of file IOUAmount.cpp.
◆ operator-=()
Definition at line 117 of file IOUAmount.h.
◆ operator-()
| IOUAmount ripple::IOUAmount::operator- | ( | ) | const |
Definition at line 124 of file IOUAmount.h.
◆ operator==()
| bool ripple::IOUAmount::operator== | ( | IOUAmount const & | other | ) | const |
Definition at line 130 of file IOUAmount.h.
◆ operator<()
| bool ripple::IOUAmount::operator< | ( | IOUAmount const & | other | ) | const |
Definition at line 135 of file IOUAmount.h.
◆ operator bool()
|
explicitnoexcept |
Returns true if the amount is not zero.
Definition at line 141 of file IOUAmount.h.
◆ signum()
|
noexcept |
Return the sign of the amount.
Definition at line 147 of file IOUAmount.h.
◆ exponent()
|
noexcept |
Definition at line 153 of file IOUAmount.h.
◆ mantissa()
|
noexcept |
Definition at line 159 of file IOUAmount.h.
◆ minPositiveAmount()
|
static |
Definition at line 50 of file IOUAmount.cpp.
Friends And Related Symbol Documentation
◆ operator<<
|
friend |
Definition at line 83 of file IOUAmount.h.
Member Data Documentation
◆ mantissa_
|
private |
Definition at line 29 of file IOUAmount.h.
◆ exponent_
|
private |
Definition at line 30 of file IOUAmount.h.
