Merge pull request #936 from cppalliance/misc_in_flight_improvements

mborland · web-flow · commit 24b94061e8f3 · 2025-07-26T09:09:09.000-04:00
Misc testing and doc improvements
diff --git a/doc/modules/ROOT/nav.adoc b/doc/modules/ROOT/nav.adoc
@@ -14,9 +14,12 @@
 * xref:literals.adoc[]
 * xref:numbers.adoc[]
 * xref:cmath.adoc[]
+** xref:cmath.adoc#non_standard_cmath[Non-Standard Functions]
 * xref:cstdlib.adoc[]
 * xref:charconv.adoc[]
 * xref:format.adoc[]
+** xref:format.adoc#std_format[`<format>`]
+** xref:format.adoc#fmt_format[`<fmt/format.h>`]
 * xref:cfenv.adoc[]
 * xref:cfloat.adoc[]
 * xref:cstdio.adoc[]
diff --git a/doc/modules/ROOT/pages/api_reference.adoc b/doc/modules/ROOT/pages/api_reference.adoc
@@ -17,7 +17,7 @@ enums, constants and macros that are provided in this library.
 
 - xref:decimal32_t.adoc[decimal32_t]
 - xref:decimal64_t.adoc[decimal64_t]
-- xref:decimal128_t.adoc[decima128]
+- xref:decimal128_t.adoc[decima128_t]
 
 === Non-IEEE 754 Compliant Types
 
diff --git a/doc/modules/ROOT/pages/cfenv.adoc b/doc/modules/ROOT/pages/cfenv.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cfenv]
-= cfenv support
+= `<cfenv>` support
 :idprefix: cfenv_
 
 == <cfenv>
diff --git a/doc/modules/ROOT/pages/cfloat.adoc b/doc/modules/ROOT/pages/cfloat.adoc
@@ -5,12 +5,10 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cfloat]
-= cfloat support
+= `<cfloat>` support
 :idprefix: cfloat_
 
-== <cfloat>
-
-The following macros analogous to those from <cfloat> for the decimal floating point types:
+The following macros analogous to those from `<cfloat>` for the decimal floating point types:
 
 [source, c++]
 ----
@@ -50,8 +48,11 @@ Additionally `BOOST_DECIMAL_DEC_EVAL_METHOD` is similar to `FLT_EVAL_METHOD`: ht
 
 The valid values are:
 
-- 0: all operations evaluated in the range and precision of the native type
-- 1: all `decimal32_t` operations are evaluated with the precision and range of `decimal64_t` internally, and returned as `decimal64_t`
-- 2: all `decimal32_t` and `decimal64_t` operations are evaluated with the precision and range of `decimal128_t` internally, and returned as the original type.
+|===
+| Value | Description
+| 0 | All operations evaluated in the range and precision of the native type
+| 1 | All `decimal32_t` (or `decimal_fast32_t`) operations are evaluated with the precision and range of `decimal64_t` internally, and returned as `decimal64_t`
+| 2 | All `decimal32_t` and `decimal64_t` (or fast equivalents) operations are evaluated with the precision and range of `decimal128_t` internally, and returned as the original type.
+|===
 
-To use the functionallity you must `#define BOOST_DECIMAL_DEC_EVAL_METHOD` to the value you want before you `#include <boost/decimal.hpp>`.
+To use the functionality you must `#define BOOST_DECIMAL_DEC_EVAL_METHOD` to the value you want before you `#include <boost/decimal.hpp>`.
diff --git a/doc/modules/ROOT/pages/charconv.adoc b/doc/modules/ROOT/pages/charconv.adoc
@@ -5,7 +5,7 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#charconv]
-= charconv support
+= `<charconv>` support
 :idprefix: charconv_
 
 == <charconv>
diff --git a/doc/modules/ROOT/pages/cmath.adoc b/doc/modules/ROOT/pages/cmath.adoc
@@ -5,16 +5,14 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cmath]
-= cmath support
+= `<cmath>` support
 :idprefix: cmath_
 
-== <cmath>
-
 Decimal contains overloads for all functions from `<cmath>`, and they have the same handling as built-in floating point types.
 They are also all constexpr with C\\++14 unlike the built-in floating point types which require either C++23 or 26.
 Additionally, all functions are marked `noexcept`.
 
-=== Basic Operations
+== Basic Operations
 
 |===
 | Function | Description
@@ -73,7 +71,7 @@ constexpr decimal128_t nand128(const char* arg) noexcept;
 } // namespace boost
 ----
 
-=== Exponential Functions
+== Exponential Functions
 
 |===
 | Function | Description
@@ -150,7 +148,7 @@ constexpr DecimalType hypot(DecimalType x, DecimalType y, DecimalType z) noexcep
 } // namespace boost
 ----
 
-=== Trigonometric Functions
+== Trigonometric Functions
 
 |===
 | Function | Description
@@ -194,7 +192,7 @@ constexpr DecimalType atan2(DecimalType x, DecimalType y) noexcept;
 ----
 
 
-=== Hyperbolic Functions
+== Hyperbolic Functions
 
 |===
 | Function | Description
@@ -233,7 +231,7 @@ constexpr DecimalType atanh(DecimalType x) noexcept;
 } // namespace boost
 ----
 
-=== Error and Gamma Functions
+== Error and Gamma Functions
 
 |===
 | Function | Description
@@ -264,7 +262,7 @@ constexpr DecimalType lgamma(DecimalType x) noexcept;
 } // namespace boost
 ----
 
-=== Nearest integer floating point operations
+== Nearest integer floating point operations
 
 |===
 | Function | Description
@@ -318,7 +316,7 @@ constexpr long long llrint(DecimalType x) noexcept;
 } // namespace boost
 ----
 
-=== Floating point manipulation functions
+== Floating point manipulation functions
 
 |===
 | Function | Description
@@ -373,7 +371,7 @@ constexpr DecimalType copysign(DecimalType mag, DecimalType sgn) noexcept;
 } // namespace boost
 ----
 
-=== Classification and comparison
+== Classification and comparison
 
 |===
 | Function | Description
@@ -496,6 +494,7 @@ constexpr DecimalType riemann_zeta(IntegralType n) noexcept;
 } //namespace boost
 ----
 
+[#non_standard_cmath]
 == Non-standard Functions
 
 The following are convenience functions, or are prescribed in IEEE 754-2019 as required for decimal floating point types.
diff --git a/doc/modules/ROOT/pages/cstdio.adoc b/doc/modules/ROOT/pages/cstdio.adoc
@@ -5,12 +5,10 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cstdio]
-= cstdio support
+= `<cstdio>` support
 :idprefix: cstdio_
 
-== <cstdio>
-
-The following functions analogous to those from <cstdio> are provided:
+The following functions analogous to those from `<cstdio>` are provided:
 
 [source, c++]
 ----
diff --git a/doc/modules/ROOT/pages/cstdlib.adoc b/doc/modules/ROOT/pages/cstdlib.adoc
@@ -5,11 +5,9 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#cstdlib]
-= cstdlib support
+= `<cstdlib>` support
 :idprefix: cstdlib_
 
-== <cstdlib>
-
 The following functions analogous to those from `<cstdlib>` are provided:
 
 [source, c++]
diff --git a/doc/modules/ROOT/pages/decimal128_t.adoc b/doc/modules/ROOT/pages/decimal128_t.adoc
@@ -10,7 +10,7 @@ https://www.boost.org/LICENSE_1_0.txt
 
 == Description
 
-decimal128_t is the 128-bit version of the decimal interchange format, and has the following properties as defined in IEEE 754-2019 table 3.6
+`decimal128_t` is the 128-bit version of the decimal interchange format, and has the following properties as defined in IEEE 754-2019 table 3.6
 
 |===
 | Attribute | values
diff --git a/doc/modules/ROOT/pages/decimal32_t.adoc b/doc/modules/ROOT/pages/decimal32_t.adoc
@@ -10,7 +10,7 @@ https://www.boost.org/LICENSE_1_0.txt
 
 == Description
 
-decimal32_t is the 32-bit version of the decimal interchange format, and has the following properties as defined in IEEE 754-2019 table 3.6
+`decimal32_t` is the 32-bit version of the decimal interchange format, and has the following properties as defined in IEEE 754-2019 table 3.6
 
 |===
 | Attribute | values
diff --git a/doc/modules/ROOT/pages/decimal64_t.adoc b/doc/modules/ROOT/pages/decimal64_t.adoc
@@ -10,7 +10,7 @@ https://www.boost.org/LICENSE_1_0.txt
 
 == Description
 
-decimal64_t is the 64-bit version of the decimal interchange format, and has the following properties as defined in IEEE 754-2019 table 3.6
+`decimal64_t` is the 64-bit version of the decimal interchange format, and has the following properties as defined in IEEE 754-2019 table 3.6
 
 |===
 | Attribute | values
diff --git a/doc/modules/ROOT/pages/format.adoc b/doc/modules/ROOT/pages/format.adoc
@@ -8,7 +8,8 @@ https://www.boost.org/LICENSE_1_0.txt
 = formating support
 :idprefix: format_
 
-== <format>
+[#std_format]
+== `<format>`
 
 Format is supported when using C++20 and a compiler with appropriate support: GCC >= 13, Clang >= 18, MSVC >= 19.40
 
@@ -65,7 +66,8 @@ int main()
 }
 ----
 
-== <fmt/format.h>
+[#fmt_format]
+== `<fmt/format.h>`
 
 Support for fmtlib is available as long as `<fmt/format.h>` is present.
 All of the above information on modifiers is the same for fmtlib
diff --git a/doc/modules/ROOT/pages/functional.adoc b/doc/modules/ROOT/pages/functional.adoc
@@ -5,12 +5,10 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#functional]
-= functional support
+= `<functional>` support
 :idprefix: functional_
 
-== <functional>
-
-The following functions from <functional> are overloaded:
+The following functions from `<functional>` are overloaded:
 
 [source, c++]
 ----
@@ -19,7 +17,7 @@ namespace std {
 template <>
 struct hash<boost::decimal::decimal32_t>;
 
-templte <>
+template <>
 struct hash<boost::decimal::decimal_fast32_t>;
 
 template <>
diff --git a/doc/modules/ROOT/pages/limits.adoc b/doc/modules/ROOT/pages/limits.adoc
@@ -5,12 +5,10 @@ https://www.boost.org/LICENSE_1_0.txt
 ////
 
 [#limits]
-= limits support
+= `<limits>` support
 :idprefix: limits_
 
-== <limits>
-
-The following from <limits> are overloaded for each type with associated values for reference:
+The following from `<limits>` are overloaded for each type with associated values for reference:
 
 [source, c++]
 ----
diff --git a/include/boost/decimal/charconv.hpp b/include/boost/decimal/charconv.hpp
@@ -265,10 +265,10 @@ BOOST_DECIMAL_CONSTEXPR auto to_chars_nonfinite(char* first, char* last, const T
             }
 
             return {last, std::errc::value_too_large};
+        // LCOV_EXCL_START
         default:
-            // LCOV_EXCL_START
             BOOST_DECIMAL_UNREACHABLE;
-            // LCOV_EXCL_STOP
+        // LCOV_EXCL_STOP
     }
 }
 
diff --git a/test/test_to_chars.cpp b/test/test_to_chars.cpp
@@ -969,6 +969,21 @@ int main()
     test_general_format_std<decimal64_t>();
     #endif
 
+    #if !defined(BOOST_DECIMAL_REDUCE_TEST_DEPTH)
+    test_non_finite_values<decimal_fast128_t>();
+    test_small_values<decimal_fast128_t>();
+    test_large_values<decimal_fast128_t>();
+    test_fixed_format<decimal_fast128_t>();
+    test_precision<decimal_fast128_t>();
+    test_buffer_overflow<decimal_fast128_t>();
+    zero_test<decimal_fast128_t>();
+    test_434_fixed<decimal_fast128_t>();
+    test_434_scientific<decimal_fast128_t>();
+    test_hex_format<decimal_fast128_t>();
+    test_434_hex<decimal_fast128_t>();
+    #endif
+
+
     test_777<decimal32_t>();
     test_777<decimal64_t>();
     test_777<decimal128_t>();
