diff options
author | Jonathan Wakely <jwakely@redhat.com> | 2023-11-17 13:01:17 +0000 |
---|---|---|
committer | Jonathan Wakely <jwakely@redhat.com> | 2023-11-17 15:28:30 +0000 |
commit | 568eb2d25c8f797707309b4f3acbb76c73e1a446 (patch) | |
tree | d71ba4f607f19bb4e4b359712531d1805eeb6788 /libstdc++-v3/testsuite/26_numerics | |
parent | 52eedfa00960f2d255ec542626e3531a65aa8bb8 (diff) | |
download | gcc-568eb2d25c8f797707309b4f3acbb76c73e1a446.zip gcc-568eb2d25c8f797707309b4f3acbb76c73e1a446.tar.gz gcc-568eb2d25c8f797707309b4f3acbb76c73e1a446.tar.bz2 |
libstdc++: Define C++26 saturation arithmetic functions (P0543R3)
This was approved for C++26 last week at the WG21 meeting in Kona.
libstdc++-v3/ChangeLog:
* include/Makefile.am: Add new header.
* include/Makefile.in: Regenerate.
* include/bits/version.def (saturation_arithmetic): Define.
* include/bits/version.h: Regenerate.
* include/std/numeric: Include new header.
* include/bits/sat_arith.h: New file.
* testsuite/26_numerics/saturation/add.cc: New test.
* testsuite/26_numerics/saturation/cast.cc: New test.
* testsuite/26_numerics/saturation/div.cc: New test.
* testsuite/26_numerics/saturation/mul.cc: New test.
* testsuite/26_numerics/saturation/sub.cc: New test.
* testsuite/26_numerics/saturation/version.cc: New test.
Diffstat (limited to 'libstdc++-v3/testsuite/26_numerics')
6 files changed, 281 insertions, 0 deletions
diff --git a/libstdc++-v3/testsuite/26_numerics/saturation/add.cc b/libstdc++-v3/testsuite/26_numerics/saturation/add.cc new file mode 100644 index 0000000..3eee6ab --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/saturation/add.cc @@ -0,0 +1,73 @@ +// { dg-do compile { target c++26 } } + +// C++26 Saturation arithmetic [numerics.sat] + +#include <numeric> +#include <limits> + +template<typename T, typename U> +concept can_add_sat + = requires(T t, U u) { { std::add_sat(t, u) } -> std::same_as<T>; }; + +static_assert( can_add_sat<int, int> ); +static_assert( not can_add_sat<int, short> ); +static_assert( not can_add_sat<unsigned, int> ); +static_assert( noexcept(std::add_sat(0, 0)) ); + +using std::add_sat; + +// Signed type +static_assert(add_sat(0, 0) == 0); +static_assert(add_sat(1, 1) == 2); +static_assert(add_sat(-1, -1) == -2); +static_assert(add_sat(-1, 1) == 0); +constexpr auto max = std::numeric_limits<int>::max(); +constexpr auto min = std::numeric_limits<int>::min(); +static_assert(add_sat(max, 1) == max); +static_assert(add_sat(1, max) == max); +static_assert(add_sat(max, max) == max); +static_assert(add_sat(min, -1) == min); +static_assert(add_sat(-1, min) == min); +static_assert(add_sat(min, min) == min); +static_assert(add_sat(max, min) == -1); +static_assert(add_sat(min, max) == -1); + +// Wider signed type than the args +static_assert(add_sat<long long>(max, max) == (long long)max * 2); +static_assert(add_sat<long long>(min, min) == (long long)min * 2); + +// Signed type that undergoes integer promotion +constexpr auto shrt_max = std::numeric_limits<short>::max(); +constexpr auto shrt_min = std::numeric_limits<short>::min(); +static_assert(add_sat<short>(0, 0) == 0); +static_assert(add_sat<short>(1, 1) == 2); +static_assert(add_sat<short>(shrt_max, shrt_max) == shrt_max); +static_assert(add_sat<short>(shrt_max, 1) == shrt_max); +static_assert(add_sat<short>(1, shrt_max) == shrt_max); +static_assert(add_sat<short>(shrt_min, (short)-1) == shrt_min); +static_assert(add_sat<short>((short)-1, shrt_min) == shrt_min); +static_assert(add_sat<short>(shrt_min, (short)1) == -shrt_max); +static_assert(add_sat<short>((short)1, shrt_min) == -shrt_max); + +// Unsigned type +static_assert(add_sat(0u, 0u) == 0u); +static_assert(add_sat(1u, 1u) == 2u); +constexpr auto umax = std::numeric_limits<unsigned>::max(); +static_assert(add_sat(umax, 1u) == umax); +static_assert(add_sat(1u, umax) == umax); +static_assert(add_sat(umax, umax) == umax); +static_assert(add_sat(0u, umax) == umax); +static_assert(add_sat(umax, 0u) == umax); +static_assert(add_sat(0u, 1u) == 1u); +static_assert(add_sat(1u, 0u) == 1u); + +// Wider unsigned type than the args +static_assert(add_sat<unsigned long long>(umax, umax) == (long long)umax * 2); + +// Unsigned type that undergoes integer promotion +constexpr auto ushrt_max = std::numeric_limits<unsigned short>::max(); +static_assert(add_sat<unsigned short>(0, 0) == 0); +static_assert(add_sat<unsigned short>(1, 1) == 2); +static_assert(add_sat<unsigned short>(ushrt_max, ushrt_max) == ushrt_max); +static_assert(add_sat<unsigned short>(ushrt_max, 1) == ushrt_max); +static_assert(add_sat<unsigned short>(1, ushrt_max) == ushrt_max); diff --git a/libstdc++-v3/testsuite/26_numerics/saturation/cast.cc b/libstdc++-v3/testsuite/26_numerics/saturation/cast.cc new file mode 100644 index 0000000..672e9c4 --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/saturation/cast.cc @@ -0,0 +1,24 @@ +// { dg-do compile { target c++26 } } + +// C++26 Saturation arithmetic [numerics.sat] + +#include <numeric> +#include <climits> + +#if CHAR_BIT == 8 +static_assert(std::saturate_cast<unsigned char>(999) == 255); +static_assert(std::saturate_cast<signed char>(999) == 127); +#endif +static_assert(std::saturate_cast<unsigned short>(999) == 999); +static_assert(std::saturate_cast<signed short>(999) == 999); +static_assert(std::saturate_cast<short>(INT_MAX) == SHRT_MAX); +static_assert(std::saturate_cast<short>(UINT_MAX) == SHRT_MAX); +static_assert(std::saturate_cast<short>(UINT_MAX) == SHRT_MAX); +static_assert(std::saturate_cast<unsigned short>(UINT_MAX) == USHRT_MAX); +static_assert(std::saturate_cast<int>(UINT_MAX) == INT_MAX); +static_assert(std::saturate_cast<int>(INT_MAX) == INT_MAX); +static_assert(std::saturate_cast<unsigned>(-1) == 0); +static_assert(std::saturate_cast<unsigned>(INT_MIN) == 0); +static_assert(std::saturate_cast<unsigned>(UINT_MAX) == UINT_MAX); +static_assert(std::saturate_cast<unsigned>(LLONG_MAX) == UINT_MAX); +static_assert(std::saturate_cast<unsigned>(ULLONG_MAX) == UINT_MAX); diff --git a/libstdc++-v3/testsuite/26_numerics/saturation/div.cc b/libstdc++-v3/testsuite/26_numerics/saturation/div.cc new file mode 100644 index 0000000..a3f43573 --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/saturation/div.cc @@ -0,0 +1,45 @@ +// { dg-do compile { target c++26 } } + +// C++26 Saturation arithmetic [numerics.sat] + +#include <numeric> +#include <climits> + +template<typename T, typename U> +concept can_div_sat + = requires(T t, U u) { { std::div_sat(t, u) } -> std::same_as<T>; }; + +static_assert( can_div_sat<int, int> ); +static_assert( not can_div_sat<int, short> ); +static_assert( not can_div_sat<unsigned, int> ); +static_assert( noexcept(std::div_sat(0, 1)) ); + +using std::div_sat; + +static_assert(std::div_sat(0, 1) == 0); +static_assert(std::div_sat(0, -1) == 0); +static_assert(std::div_sat(1, -1) == -1); +static_assert(std::div_sat(10, -2) == -5); +static_assert(std::div_sat(-10, -2) == 5); +static_assert(std::div_sat(INT_MAX, 1) == INT_MAX); +static_assert(std::div_sat(INT_MIN, 1) == INT_MIN); +static_assert(std::div_sat(INT_MIN + 1, -1) == INT_MAX); +static_assert(std::div_sat(0u, 1u) == 0u); +static_assert(std::div_sat(UINT_MAX, 1u) == UINT_MAX); +static_assert(std::div_sat(INT_MIN, -1) == INT_MAX); +static_assert(std::div_sat((short)SHRT_MIN, (short)-1) == SHRT_MAX); +static_assert(std::div_sat(LONG_MIN, -1L) == LONG_MAX); +static_assert(std::div_sat(LLONG_MIN, -1LL) == LLONG_MAX); + +template<auto N> +std::integral_constant<decltype(N), std::div_sat(N, N-N)> +div_sat_by_zero(); + +template<auto N> +concept can_div_sat_by_zero = requires { div_sat_by_zero<N>(); }; + +static_assert( not can_div_sat_by_zero<0> ); +static_assert( not can_div_sat_by_zero<1> ); +static_assert( not can_div_sat_by_zero<1u> ); +static_assert( not can_div_sat_by_zero<-1L> ); +static_assert( not can_div_sat_by_zero<short(99)> ); diff --git a/libstdc++-v3/testsuite/26_numerics/saturation/mul.cc b/libstdc++-v3/testsuite/26_numerics/saturation/mul.cc new file mode 100644 index 0000000..1b5538c --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/saturation/mul.cc @@ -0,0 +1,34 @@ +// { dg-do compile { target c++26 } } + +// C++26 Saturation arithmetic [numerics.sat] + +#include <numeric> +#include <climits> + +template<typename T, typename U> +concept can_mul_sat + = requires(T t, U u) { { std::mul_sat(t, u) } -> std::same_as<T>; }; + +static_assert( can_mul_sat<int, int> ); +static_assert( not can_mul_sat<int, short> ); +static_assert( not can_mul_sat<unsigned, int> ); +static_assert( noexcept(std::mul_sat(0, 0)) ); + +using std::mul_sat; + +static_assert(mul_sat(1, 1) == 1); +static_assert(mul_sat(10, 11) == 110); +static_assert(mul_sat(INT_MAX / 2, 3) == INT_MAX); +static_assert(mul_sat(INT_MAX / 2, -3) == INT_MIN); +static_assert(mul_sat(INT_MAX / -2, 3) == INT_MIN); +static_assert(mul_sat(INT_MIN / 2, -3) == INT_MAX); +static_assert(mul_sat(INT_MIN, -1) == INT_MAX); +static_assert(mul_sat(INT_MAX, -1) == INT_MIN + 1); +static_assert(mul_sat(INT_MAX, INT_MAX) == INT_MAX); +static_assert(mul_sat(INT_MAX, -INT_MAX) == INT_MIN); +static_assert(mul_sat(UINT_MAX, UINT_MAX) == UINT_MAX); +static_assert(mul_sat(UINT_MAX, 0u) == 0); +static_assert(mul_sat(0u, UINT_MAX) == 0); +static_assert(mul_sat((short)SHRT_MAX, (short)2) == SHRT_MAX); +static_assert(mul_sat((short)SHRT_MAX, (short)SHRT_MIN) == SHRT_MIN); +static_assert(mul_sat<long long>(SHRT_MAX, 2) == 2L * SHRT_MAX); diff --git a/libstdc++-v3/testsuite/26_numerics/saturation/sub.cc b/libstdc++-v3/testsuite/26_numerics/saturation/sub.cc new file mode 100644 index 0000000..c56154a --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/saturation/sub.cc @@ -0,0 +1,86 @@ +// { dg-do compile { target c++26 } } + +// C++26 Saturation arithmetic [numerics.sat] + +#include <numeric> +#include <limits> + +template<typename T, typename U> +concept can_sub_sat + = requires(T t, U u) { { std::sub_sat(t, u) } -> std::same_as<T>; }; + +static_assert( can_sub_sat<int, int> ); +static_assert( not can_sub_sat<int, short> ); +static_assert( not can_sub_sat<unsigned, int> ); +static_assert( noexcept(std::sub_sat(0, 0)) ); + +using std::sub_sat; + +// Signed type +static_assert(sub_sat(0, 0) == 0); +static_assert(sub_sat(1, 1) == 0); +static_assert(sub_sat(-1, -1) == 0); +static_assert(sub_sat(-1, 1) == -2); +constexpr auto max = std::numeric_limits<int>::max(); +constexpr auto min = std::numeric_limits<int>::min(); +static_assert(sub_sat(max, 1) == max - 1); +static_assert(sub_sat(1, max) == 1 - max); +static_assert(sub_sat(max, max) == 0); +static_assert(sub_sat(min, 1) == min); +static_assert(sub_sat(min, 123) == min); +static_assert(sub_sat(0, max) == min + 1); +static_assert(sub_sat(-1, max) == min); +static_assert(sub_sat(-2, max) == min); +static_assert(sub_sat(-2, min) == max - 1); +static_assert(sub_sat(-1, min) == max); +static_assert(sub_sat(0, min) == max); +static_assert(sub_sat(1, min) == max); +static_assert(sub_sat(min, -1) == min + 1); +static_assert(sub_sat(min, min) == 0); +static_assert(sub_sat(max, min) == max); +static_assert(sub_sat(min, max) == min); + +// Wider signed type than the args +static_assert(sub_sat<long long>(max, min) == (long long)max * 2 + 1); +static_assert(sub_sat<long long>(min, max) == (long long)min * 2 + 1); + +// Signed type that undergoes integer promotion +constexpr auto shrt_max = std::numeric_limits<short>::max(); +constexpr auto shrt_min = std::numeric_limits<short>::min(); +static_assert(sub_sat<short>(0, 0) == 0); +static_assert(sub_sat<short>(1, 1) == 0); +static_assert(sub_sat<short>(3, 1) == 2); +static_assert(sub_sat<short>(shrt_max, shrt_max) == 0); +static_assert(sub_sat<short>(shrt_max, 1) == shrt_max - 1); +static_assert(sub_sat<short>(1, shrt_max) == shrt_min + 2); +static_assert(sub_sat<short>(shrt_max, shrt_min) == shrt_max); +static_assert(sub_sat<short>(0, shrt_min) == shrt_max); +static_assert(sub_sat<short>(shrt_min, (short)1) == shrt_min); +static_assert(sub_sat<short>(shrt_min, (short)-1) == shrt_min + 1); +static_assert(sub_sat<short>((short)-1, shrt_min) == shrt_max); +static_assert(sub_sat<short>((short)1, shrt_min) == shrt_max); + +// Unsigned type +static_assert(sub_sat(0u, 0u) == 0u); +static_assert(sub_sat(1u, 1u) == 0u); +static_assert(sub_sat(-1u, -1u) == 0u); +static_assert(sub_sat(-1u, 1u) == -2u); +constexpr auto umax = std::numeric_limits<unsigned>::max(); +static_assert(sub_sat(0u, 1u) == 0u); +static_assert(sub_sat(umax, umax) == 0u); +static_assert(sub_sat(umax, 0u) == umax); +static_assert(sub_sat(0u, umax) == 0u); +static_assert(sub_sat(umax, 1u) == umax - 1u); +static_assert(sub_sat(0u, 0u) == 0u); + +// Wider unsigned type than the args +static_assert(sub_sat<unsigned long long>(0u, umax) == 0u); + +// Unsigned type that undergoes integer promotion +constexpr auto ushrt_max = std::numeric_limits<unsigned short>::max(); +static_assert(sub_sat<unsigned short>(0, 0) == 0); +static_assert(sub_sat<unsigned short>(1, 1) == 0); +static_assert(sub_sat<unsigned short>(3, 1) == 2); +static_assert(sub_sat<unsigned short>(ushrt_max, ushrt_max) == 0); +static_assert(sub_sat<unsigned short>(0, 1) == 0); +static_assert(sub_sat<unsigned short>(1, ushrt_max) == 0); diff --git a/libstdc++-v3/testsuite/26_numerics/saturation/version.cc b/libstdc++-v3/testsuite/26_numerics/saturation/version.cc new file mode 100644 index 0000000..ca94ef1 --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/saturation/version.cc @@ -0,0 +1,19 @@ +// { dg-do preprocess { target c++26 } } +// { dg-add-options no_pch } + +#include <numeric> + +#ifndef __cpp_lib_saturation_arithmetic +# error "Feature test macro for saturation arithmetic is missing in <numeric>" +#elif __cpp_lib_saturation_arithmetic < 202311L +# error "Feature test macro for saturation arithmetic has wrong value in <numeric>" +#endif + +#undef __cpp_lib_saturation_arithmetic +#include <version> + +#ifndef __cpp_lib_saturation_arithmetic +# error "Feature test macro for saturation arithmetic is missing in <version>" +#elif __cpp_lib_saturation_arithmetic < 202311L +# error "Feature test macro for saturation arithmetic has wrong value in <version>" +#endif |