Merge pull request #930 from cppalliance/587

Rename types and add deprecation warnings to the old ones

Author: mborland

README.md

@@ -67,9 +67,9 @@ Decimal provides 3 IEEE-754 compliant types:
 namespace boost {
 namespace decimal {
 
-class decimal32;
-class decimal64;
-class decimal128;
+class decimal32_t;
+class decimal64_t;
+class decimal128_t;
 
 } //namespace decimal
 } //namespace boost
@@ -81,9 +81,9 @@ and also 3 similar but non-compliant types with improved runtime performance:
 namespace boost {
 namespace decimal {
 
-class decimal32_fast;
-class decimal64_fast;
-class decimal128_fast;
+class decimal_fast32_t;
+class decimal_fast64_t;
+class decimal_fast128_t;
 
 } //namespace decimal
 } //namespace boost
@@ -103,10 +103,10 @@ Using the decimal types is simple.
 
 int main()
 {
-    using boost::decimal::decimal32;
+    using boost::decimal::decimal32_t;
 
-    constexpr decimal32 a {2, -1}; // Constructs the number 0.2
-    constexpr decimal32 b {1, -1}; // Constructs the number 0.1
+    constexpr decimal32_t a {2, -1}; // Constructs the number 0.2
+    constexpr decimal32_t b {1, -1}; // Constructs the number 0.1
     auto sum {a + b};
 
     std::cout << sum << std::endl; // prints 0.3
@@ -133,15 +133,15 @@ int main()
 {
     using namespace boost::decimal;
 
-    decimal64 val {-0.25}; // Construction from a double
+    decimal64_t val {-0.25}; // Construction from a double
     val = abs(val); // DO NOT call std::abs
 
     char buffer[256];
     auto r_to = to_chars(buffer, buffer + sizeof(buffer) - 1, val);
     assert(r_to); // checks std::errc()
     *r_to.ptr = '\0';
 
-    decimal64 return_value;
+    decimal64_t return_value;
     auto r_from = from_chars(buffer, buffer + std::strlen(buffer), return_value);
 
     assert(val == return_value);

doc/modules/ROOT/nav.adoc

@@ -3,13 +3,13 @@
 * xref:examples.adoc[]
 * xref:api_reference.adoc[]
 * xref:generic_decimal.adoc[]
-** xref:decimal32.adoc[]
-** xref:decimal64.adoc[]
-** xref:decimal128.adoc[]
+** xref:decimal32_t.adoc[]
+** xref:decimal64_t.adoc[]
+** xref:decimal128_t.adoc[]
 * xref:fast_types.adoc[]
-** xref:decimal32_fast.adoc[]
-** xref:decimal64_fast.adoc[]
-** xref:decimal128_fast.adoc[]
+** xref:decimal_fast32_t.adoc[]
+** xref:decimal_fast64_t.adoc[]
+** xref:decimal_fast128_t.adoc[]
 * xref:conversions.adoc[]
 * xref:literals.adoc[]
 * xref:numbers.adoc[]

doc/modules/ROOT/pages/api_reference.adoc

@@ -15,15 +15,15 @@ enums, constants and macros that are provided in this library.
 
 === IEEE 754 Compliant Types
 
-- xref:decimal32.adoc[decimal32]
-- xref:decimal64.adoc[decimal64]
-- xref:decimal128.adoc[decima128]
+- xref:decimal32_t.adoc[decimal32_t]
+- xref:decimal64_t.adoc[decimal64_t]
+- xref:decimal128_t.adoc[decima128]
 
 === Non-IEEE 754 Compliant Types
 
-- xref:decimal32_fast.adoc[decimal32_fast]
-- xref:decimal64_fast.adoc[decimal64_fast]
-- xref:decimal128_fast.adoc[decimal128_fast]
+- xref:decimal_fast32_t.adoc[decimal_fast32_t]
+- xref:decimal_fast64_t.adoc[decimal_fast64_t]
+- xref:decimal_fast128_t.adoc[decimal_fast128_t]
 
 == Structures
 

doc/modules/ROOT/pages/basics.adoc

@@ -17,22 +17,22 @@ Every decimal type can be constructed in a few ways:
 [source, c++]
 ----
 template <typename UnsignedInteger, typename Integer>
-constexpr decimal32(UnsignedInteger coefficient, Integer exponent, bool sign = false) noexcept;
+constexpr decimal32_t(UnsignedInteger coefficient, Integer exponent, bool sign = false) noexcept;
 
 template <typename SignedInteger, typename Integer>
-constexpr decimal32(SignedInteger coefficient, Integer exponent) noexcept;
+constexpr decimal32_t(SignedInteger coefficient, Integer exponent) noexcept;
 ----
 
 As you can see you are either allowed to pass a signed integer, or specify the signedness of the resulting number, but not both.
 This is designed to reduce confusion (e.g. what would be the resulting sign of `{-3, 0, true}`?)
 
 [souce, c++]
 ----
-boost::decimal::decimal32 a {1, 1};          // constructs 1e1 = 10
-boost::decimal::decimal32 b {-2, -1};        // constructs -2e-2 or -0.2
-boost::decimal::decimal32 c {2, -1, true};   // also constructs -2e-1 or -0.2
-boost::decimal::decimal32 e {5, 5};          // constructs 5x10^5
-boost::decimal::decimal32 f {1234, -3}       // constructs 1.234 or 1234x10^-3
+boost::decimal::decimal32_t a {1, 1};          // constructs 1e1 = 10
+boost::decimal::decimal32_t b {-2, -1};        // constructs -2e-2 or -0.2
+boost::decimal::decimal32_t c {2, -1, true};   // also constructs -2e-1 or -0.2
+boost::decimal::decimal32_t e {5, 5};          // constructs 5x10^5
+boost::decimal::decimal32_t f {1234, -3}       // constructs 1.234 or 1234x10^-3
 ----
 
 === Construction from Integer
@@ -42,8 +42,8 @@ For example:
 
 [source, c++]
 ----
-boost::decimal::decimal64 g = 1;
-boost::decimal::decimal32 h {-4};
+boost::decimal::decimal64_t g = 1;
+boost::decimal::decimal32_t h {-4};
 ----
 
 === Construction from Binary Floating Point
@@ -53,7 +53,7 @@ For example:
 
 [source, c++]
 ----
-boost::decimal::decimal128 pi {3.14};
+boost::decimal::decimal128_t pi {3.14};
 ----
 
 NOTE: Due to the differences in decimal and binary floating point numbers there may be a difference in the resulting representation in decimal format, and thus it is not recommended to construct from binary floating point numbers
@@ -77,8 +77,8 @@ int main()
     std::cout << std::setprecision(17) << 0.1 + 0.2 << std::endl;
 
     // Construct the two decimal values
-    constexpr decimal64 a {1, -1}; // 1e-1 or 0.1
-    constexpr decimal64 b {2, -1}; // 2e-1 or 0.2
+    constexpr decimal64_t a {1, -1}; // 1e-1 or 0.1
+    constexpr decimal64_t b {2, -1}; // 2e-1 or 0.2
 
     // Outputs 0.30000000000000000
     std::cout << a + b << std::endl;