From: Jonathan Wakely Date: Wed, 31 Jul 2019 16:40:39 +0000 (+0100) Subject: Implement "P0631R4 Math Constants" for C++20 X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=960b9ae05ac46f51370c30d30575e7a7fe6a3a99;p=gcc.git Implement "P0631R4 Math Constants" for C++20 The values of the constants are taken from Glibc where the equivalent constant exists, or by rounding the actual constant to the same number of digits as the Glibc constants have. P0631R4 Math Constants * include/Makefile.am: Add new header. * include/Makefile.in: Regenerate. * include/precompiled/stdc++.h: Include new header. * include/std/numbers: New header. * include/std/version (__cpp_lib_math_constants): Define. * testsuite/26_numerics/numbers/1.cc: New test. * testsuite/26_numerics/numbers/2.cc: New test. * testsuite/26_numerics/numbers/3.cc: New test. * testsuite/26_numerics/numbers/nonfloat_neg.cc: New test. From-SVN: r273940 --- diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index fa23ec8072a..edc551bbee0 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,5 +1,16 @@ 2019-07-31 Jonathan Wakely + P0631R4 Math Constants + * include/Makefile.am: Add new header. + * include/Makefile.in: Regenerate. + * include/precompiled/stdc++.h: Include new header. + * include/std/numbers: New header. + * include/std/version (__cpp_lib_math_constants): Define. + * testsuite/26_numerics/numbers/1.cc: New test. + * testsuite/26_numerics/numbers/2.cc: New test. + * testsuite/26_numerics/numbers/3.cc: New test. + * testsuite/26_numerics/numbers/nonfloat_neg.cc: New test. + * include/std/bit: Add Doxygen comments. PR libstdc++/91308 diff --git a/libstdc++-v3/include/Makefile.am b/libstdc++-v3/include/Makefile.am index 742f2c38ad5..3fe80f32cc4 100644 --- a/libstdc++-v3/include/Makefile.am +++ b/libstdc++-v3/include/Makefile.am @@ -57,6 +57,7 @@ std_headers = \ ${std_srcdir}/memory \ ${std_srcdir}/memory_resource \ ${std_srcdir}/mutex \ + ${std_srcdir}/numbers \ ${std_srcdir}/numeric \ ${std_srcdir}/optional \ ${std_srcdir}/ostream \ diff --git a/libstdc++-v3/include/Makefile.in b/libstdc++-v3/include/Makefile.in index fd4dbf7ffb7..b675d356cd4 100644 --- a/libstdc++-v3/include/Makefile.in +++ b/libstdc++-v3/include/Makefile.in @@ -401,6 +401,7 @@ std_headers = \ ${std_srcdir}/memory \ ${std_srcdir}/memory_resource \ ${std_srcdir}/mutex \ + ${std_srcdir}/numbers \ ${std_srcdir}/numeric \ ${std_srcdir}/optional \ ${std_srcdir}/ostream \ diff --git a/libstdc++-v3/include/precompiled/stdc++.h b/libstdc++-v3/include/precompiled/stdc++.h index 477c5c88b36..d62f64b9f6e 100644 --- a/libstdc++-v3/include/precompiled/stdc++.h +++ b/libstdc++-v3/include/precompiled/stdc++.h @@ -136,6 +136,9 @@ #if __cplusplus > 201703L #include // #include +// #include +#include +// #include // #include // #include #include diff --git a/libstdc++-v3/include/std/numbers b/libstdc++-v3/include/std/numbers new file mode 100644 index 00000000000..b8e38dd8080 --- /dev/null +++ b/libstdc++-v3/include/std/numbers @@ -0,0 +1,142 @@ +// -*- C++ -*- + +// Copyright (C) 2019 Free Software Foundation, Inc. +// +// This file is part of the GNU ISO C++ Library. This library is free +// software; you can redistribute it and/or modify it under the +// terms of the GNU General Public License as published by the +// Free Software Foundation; either version 3, or (at your option) +// any later version. + +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// Under Section 7 of GPL version 3, you are granted additional +// permissions described in the GCC Runtime Library Exception, version +// 3.1, as published by the Free Software Foundation. + +// You should have received a copy of the GNU General Public License and +// a copy of the GCC Runtime Library Exception along with this program; +// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see +// . + +/** @file include/numbers + * This is a Standard C++ Library header. + */ + +#ifndef _GLIBCXX_NUMBERS +#define _GLIBCXX_NUMBERS 1 + +#pragma GCC system_header + +#if __cplusplus > 201703L + +#include + +namespace std _GLIBCXX_VISIBILITY(default) +{ +_GLIBCXX_BEGIN_NAMESPACE_VERSION + +/** @defgroup math_constants Mathematical constants + * @ingroup numerics + * @{ + */ + +/// Namespace for mathematical constants +namespace numbers +{ +#define __cpp_lib_math_constants 201907L + + /// @cond undoc + template + using _Enable_if_floating = enable_if_t, _Tp>; + /// @endcond + + /// e + template + inline constexpr _Tp e_v + = _Enable_if_floating<_Tp>(2.718281828459045235360287471352662498L); + + /// log_2 e + template + inline constexpr _Tp log2e_v + = _Enable_if_floating<_Tp>(1.442695040888963407359924681001892137L); + + /// log_10 e + template + inline constexpr _Tp log10e_v + = _Enable_if_floating<_Tp>(0.434294481903251827651128918916605082L); + + /// pi + template + inline constexpr _Tp pi_v + = _Enable_if_floating<_Tp>(3.141592653589793238462643383279502884L); + + /// 1/pi + template + inline constexpr _Tp inv_pi_v + = _Enable_if_floating<_Tp>(0.318309886183790671537767526745028724L); + + /// 1/sqrt(pi) + template + inline constexpr _Tp inv_sqrtpi_v + = _Enable_if_floating<_Tp>(0.564189583547756286948079451560772586L); + + /// log_e 2 + template + inline constexpr _Tp ln2_v + = _Enable_if_floating<_Tp>(0.693147180559945309417232121458176568L); + + /// log_e 10 + template + inline constexpr _Tp ln10_v + = _Enable_if_floating<_Tp>(2.302585092994045684017991454684364208L); + + /// sqrt(2) + template + inline constexpr _Tp sqrt2_v + = _Enable_if_floating<_Tp>(1.414213562373095048801688724209698079L); + + /// sqrt(3) + template + inline constexpr _Tp sqrt3_v + = _Enable_if_floating<_Tp>(1.732050807568877293527446341505872367L); + + /// 1/sqrt(3) + template + inline constexpr _Tp inv_sqrt3_v + = _Enable_if_floating<_Tp>(0.577350269189625764509148780501957456L); + + /// The Euler-Mascheroni constant + template + inline constexpr _Tp egamma_v + = _Enable_if_floating<_Tp>(0.577215664901532860606512090082402431L); + + /// The golden ratio, (1+sqrt(5))/2 + template + inline constexpr _Tp phi_v + = _Enable_if_floating<_Tp>(1.618033988749894848204586834365638118L); + + inline constexpr double e = e_v; + inline constexpr double log2e = log2e_v; + inline constexpr double log10e = log10e_v; + inline constexpr double pi = pi_v; + inline constexpr double inv_pi = inv_pi_v; + inline constexpr double inv_sqrtpi = inv_sqrtpi_v; + inline constexpr double ln2 = ln2_v; + inline constexpr double ln10 = ln10_v; + inline constexpr double sqrt2 = sqrt2_v; + inline constexpr double sqrt3 = sqrt3_v; + inline constexpr double inv_sqrt3 = inv_sqrt3_v; + inline constexpr double egamma = egamma_v; + inline constexpr double phi = phi_v; + +} // namespace numbers +/// @} +_GLIBCXX_END_NAMESPACE_VERSION +} // namespace std + +#endif // C++20 +#endif // _GLIBCXX_NUMBERS diff --git a/libstdc++-v3/include/std/version b/libstdc++-v3/include/std/version index 6940b4499e6..8ebd6ba1682 100644 --- a/libstdc++-v3/include/std/version +++ b/libstdc++-v3/include/std/version @@ -163,6 +163,7 @@ # define __cpp_lib_is_constant_evaluated 201811L #endif #define __cpp_lib_list_remove_return_type 201806L +#define __cpp_lib_math_constants 201907L #endif // C++2a #endif // C++17 #endif // C++14 diff --git a/libstdc++-v3/testsuite/26_numerics/numbers/1.cc b/libstdc++-v3/testsuite/26_numerics/numbers/1.cc new file mode 100644 index 00000000000..78d0a5fb269 --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/numbers/1.cc @@ -0,0 +1,99 @@ +// Copyright (C) 2019 Free Software Foundation, Inc. +// +// This file is part of the GNU ISO C++ Library. This library is free +// software; you can redistribute it and/or modify it under the +// terms of the GNU General Public License as published by the +// Free Software Foundation; either version 3, or (at your option) +// any later version. + +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License along +// with this library; see the file COPYING3. If not see +// . + +// { dg-options "-std=gnu++2a" } +// { dg-do compile { target c++2a } } + +#include + +#ifndef __cpp_lib_math_constants +# error "Feature-test macro for math constants missing in " +#elif __cpp_lib_math_constants != 201907L +# error "Feature-test macro for math constants has wrong value in " +#endif + +void +test01() +{ + const double* d1 = &std::numbers::e_v; + const double* d2 = &std::numbers::log2e_v; + const double* d3 = &std::numbers::log10e_v; + const double* d4 = &std::numbers::pi_v; + const double* d5 = &std::numbers::inv_pi_v; + const double* d6 = &std::numbers::inv_sqrtpi_v; + const double* d7 = &std::numbers::ln2_v; + const double* d8 = &std::numbers::ln10_v; + const double* d9 = &std::numbers::sqrt2_v; + const double* d10 = &std::numbers::sqrt3_v; + const double* d11 = &std::numbers::inv_sqrt3_v; + const double* d12 = &std::numbers::egamma_v; + const double* d13 = &std::numbers::phi_v; +} + +void +test02() +{ + const float* d1 = &std::numbers::e_v; + const float* d2 = &std::numbers::log2e_v; + const float* d3 = &std::numbers::log10e_v; + const float* d4 = &std::numbers::pi_v; + const float* d5 = &std::numbers::inv_pi_v; + const float* d6 = &std::numbers::inv_sqrtpi_v; + const float* d7 = &std::numbers::ln2_v; + const float* d8 = &std::numbers::ln10_v; + const float* d9 = &std::numbers::sqrt2_v; + const float* d10 = &std::numbers::sqrt3_v; + const float* d11 = &std::numbers::inv_sqrt3_v; + const float* d12 = &std::numbers::egamma_v; + const float* d13 = &std::numbers::phi_v; +} + +void +test03() +{ + const long double* d1 = &std::numbers::e_v; + const long double* d2 = &std::numbers::log2e_v; + const long double* d3 = &std::numbers::log10e_v; + const long double* d4 = &std::numbers::pi_v; + const long double* d5 = &std::numbers::inv_pi_v; + const long double* d6 = &std::numbers::inv_sqrtpi_v; + const long double* d7 = &std::numbers::ln2_v; + const long double* d8 = &std::numbers::ln10_v; + const long double* d9 = &std::numbers::sqrt2_v; + const long double* d10 = &std::numbers::sqrt3_v; + const long double* d11 = &std::numbers::inv_sqrt3_v; + const long double* d12 = &std::numbers::egamma_v; + const long double* d13 = &std::numbers::phi_v; +} + +void +test04() +{ + static_assert(std::numbers::e == std::numbers::e_v); + static_assert(std::numbers::log2e == std::numbers::log2e_v); + static_assert(std::numbers::log10e == std::numbers::log10e_v); + static_assert(std::numbers::pi == std::numbers::pi_v); + static_assert(std::numbers::inv_pi == std::numbers::inv_pi_v); + static_assert(std::numbers::inv_sqrtpi == std::numbers::inv_sqrtpi_v); + static_assert(std::numbers::ln2 == std::numbers::ln2_v); + static_assert(std::numbers::ln10 == std::numbers::ln10_v); + static_assert(std::numbers::sqrt2 == std::numbers::sqrt2_v); + static_assert(std::numbers::sqrt3 == std::numbers::sqrt3_v); + static_assert(std::numbers::inv_sqrt3 == std::numbers::inv_sqrt3_v); + static_assert(std::numbers::egamma == std::numbers::egamma_v); + static_assert(std::numbers::phi == std::numbers::phi_v); +} diff --git a/libstdc++-v3/testsuite/26_numerics/numbers/2.cc b/libstdc++-v3/testsuite/26_numerics/numbers/2.cc new file mode 100644 index 00000000000..a363bce9dab --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/numbers/2.cc @@ -0,0 +1,27 @@ +// Copyright (C) 2019 Free Software Foundation, Inc. +// +// This file is part of the GNU ISO C++ Library. This library is free +// software; you can redistribute it and/or modify it under the +// terms of the GNU General Public License as published by the +// Free Software Foundation; either version 3, or (at your option) +// any later version. + +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License along +// with this library; see the file COPYING3. If not see +// . + +// { dg-options "-std=gnu++2a" } +// { dg-do compile { target c++2a } } + +#include + +#ifndef __cpp_lib_math_constants +# error "Feature-test macro for math constants missing in " +#elif __cpp_lib_math_constants != 201907L +# error "Feature-test macro for math constants has wrong value in " +#endif diff --git a/libstdc++-v3/testsuite/26_numerics/numbers/3.cc b/libstdc++-v3/testsuite/26_numerics/numbers/3.cc new file mode 100644 index 00000000000..56f4c953a85 --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/numbers/3.cc @@ -0,0 +1,25 @@ +// Copyright (C) 2019 Free Software Foundation, Inc. +// +// This file is part of the GNU ISO C++ Library. This library is free +// software; you can redistribute it and/or modify it under the +// terms of the GNU General Public License as published by the +// Free Software Foundation; either version 3, or (at your option) +// any later version. + +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License along +// with this library; see the file COPYING3. If not see +// . + +// { dg-options "-std=gnu++2a" } +// { dg-do compile { target c++2a } } + +#include + +struct D { double val; }; +template<> inline constexpr D std::numbers::pi_v = D{std::numbers::pi}; +static_assert( std::numbers::pi_v.val == std::numbers::pi ); diff --git a/libstdc++-v3/testsuite/26_numerics/numbers/nonfloat_neg.cc b/libstdc++-v3/testsuite/26_numerics/numbers/nonfloat_neg.cc new file mode 100644 index 00000000000..a83f55efc89 --- /dev/null +++ b/libstdc++-v3/testsuite/26_numerics/numbers/nonfloat_neg.cc @@ -0,0 +1,36 @@ +// Copyright (C) 2019 Free Software Foundation, Inc. +// +// This file is part of the GNU ISO C++ Library. This library is free +// software; you can redistribute it and/or modify it under the +// terms of the GNU General Public License as published by the +// Free Software Foundation; either version 3, or (at your option) +// any later version. + +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License along +// with this library; see the file COPYING3. If not see +// . + +// { dg-options "-std=gnu++2a" } +// { dg-do compile { target c++2a } } + +#include + +int +test01() +{ + return std::numbers::pi_v; // { dg-error "here" } +} + +void +test02() +{ + struct S { }; + auto s = std::numbers::egamma_v; // { dg-error "here" } +} + +// { dg-prune-output "no type named 'type' in" }