[thirdparty/gcc.git] / libstdc++-v3 / include / std / numbers

// <numbers> -*- C++ -*-

// Copyright (C) 2019-2023 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
// <http://www.gnu.org/licenses/>.

/** @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 <type_traits>

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<typename _Tp>
    using _Enable_if_floating = enable_if_t<is_floating_point_v<_Tp>, _Tp>;
  /// @endcond

  /// e
  template<typename _Tp>
    inline constexpr _Tp e_v
      = _Enable_if_floating<_Tp>(2.718281828459045235360287471352662498L);

  /// log_2 e
  template<typename _Tp>
    inline constexpr _Tp log2e_v
      = _Enable_if_floating<_Tp>(1.442695040888963407359924681001892137L);

  /// log_10 e
  template<typename _Tp>
    inline constexpr _Tp log10e_v
      = _Enable_if_floating<_Tp>(0.434294481903251827651128918916605082L);

  /// pi
  template<typename _Tp>
    inline constexpr _Tp pi_v
      = _Enable_if_floating<_Tp>(3.141592653589793238462643383279502884L);

  /// 1/pi
  template<typename _Tp>
    inline constexpr _Tp inv_pi_v
      = _Enable_if_floating<_Tp>(0.318309886183790671537767526745028724L);

  /// 1/sqrt(pi)
  template<typename _Tp>
    inline constexpr _Tp inv_sqrtpi_v
      = _Enable_if_floating<_Tp>(0.564189583547756286948079451560772586L);

  /// log_e 2
  template<typename _Tp>
    inline constexpr _Tp ln2_v
      = _Enable_if_floating<_Tp>(0.693147180559945309417232121458176568L);

  /// log_e 10
  template<typename _Tp>
    inline constexpr _Tp ln10_v
      = _Enable_if_floating<_Tp>(2.302585092994045684017991454684364208L);

  /// sqrt(2)
  template<typename _Tp>
    inline constexpr _Tp sqrt2_v
      = _Enable_if_floating<_Tp>(1.414213562373095048801688724209698079L);

  /// sqrt(3)
  template<typename _Tp>
    inline constexpr _Tp sqrt3_v
      = _Enable_if_floating<_Tp>(1.732050807568877293527446341505872367L);

  /// 1/sqrt(3)
  template<typename _Tp>
    inline constexpr _Tp inv_sqrt3_v
      = _Enable_if_floating<_Tp>(0.577350269189625764509148780501957456L);

  /// The Euler-Mascheroni constant
  template<typename _Tp>
    inline constexpr _Tp egamma_v
      = _Enable_if_floating<_Tp>(0.577215664901532860606512090082402431L);

  /// The golden ratio, (1+sqrt(5))/2
  template<typename _Tp>
    inline constexpr _Tp phi_v
      = _Enable_if_floating<_Tp>(1.618033988749894848204586834365638118L);

  inline constexpr double e = e_v<double>;
  inline constexpr double log2e = log2e_v<double>;
  inline constexpr double log10e = log10e_v<double>;
  inline constexpr double pi = pi_v<double>;
  inline constexpr double inv_pi = inv_pi_v<double>;
  inline constexpr double inv_sqrtpi = inv_sqrtpi_v<double>;
  inline constexpr double ln2 = ln2_v<double>;
  inline constexpr double ln10 = ln10_v<double>;
  inline constexpr double sqrt2 = sqrt2_v<double>;
  inline constexpr double sqrt3 = sqrt3_v<double>;
  inline constexpr double inv_sqrt3 = inv_sqrt3_v<double>;
  inline constexpr double egamma = egamma_v<double>;
  inline constexpr double phi = phi_v<double>;

#define __glibcxx_numbers(TYPE, SUFFIX) \
  /* e */						\
  template<>						\
    inline constexpr TYPE e_v<TYPE>			\
      = 2.718281828459045235360287471352662498##SUFFIX;	\
							\
  /* log_2 e */						\
  template<>						\
    inline constexpr TYPE log2e_v<TYPE>			\
      = 1.442695040888963407359924681001892137##SUFFIX;	\
							\
  /* log_10 e */					\
  template<>						\
    inline constexpr TYPE log10e_v<TYPE>		\
      = 0.434294481903251827651128918916605082##SUFFIX;	\
							\
  /* pi */						\
  template<>						\
    inline constexpr TYPE pi_v<TYPE>			\
      = 3.141592653589793238462643383279502884##SUFFIX;	\
							\
  /* 1/pi */						\
  template<>						\
    inline constexpr TYPE inv_pi_v<TYPE>		\
      = 0.318309886183790671537767526745028724##SUFFIX;	\
							\
  /* 1/sqrt(pi) */					\
  template<>						\
    inline constexpr TYPE inv_sqrtpi_v<TYPE>		\
      = 0.564189583547756286948079451560772586##SUFFIX;	\
							\
  /* log_e 2 */						\
  template<>						\
    inline constexpr TYPE ln2_v<TYPE>			\
      = 0.693147180559945309417232121458176568##SUFFIX;	\
							\
  /* log_e 10 */					\
  template<>						\
    inline constexpr TYPE ln10_v<TYPE>			\
      = 2.302585092994045684017991454684364208##SUFFIX;	\
							\
  /* sqrt(2) */						\
  template<>						\
    inline constexpr TYPE sqrt2_v<TYPE>			\
      = 1.414213562373095048801688724209698079##SUFFIX;	\
							\
  /* sqrt(3) */						\
  template<>						\
    inline constexpr TYPE sqrt3_v<TYPE>			\
      = 1.732050807568877293527446341505872367##SUFFIX;	\
							\
  /* 1/sqrt(3) */					\
  template<>						\
    inline constexpr TYPE inv_sqrt3_v<TYPE>		\
      = 0.577350269189625764509148780501957456##SUFFIX;	\
							\
  /* The Euler-Mascheroni constant */			\
  template<>						\
    inline constexpr TYPE egamma_v<TYPE>		\
      = 0.577215664901532860606512090082402431##SUFFIX;	\
							\
  /* The golden ratio, (1+sqrt(5))/2 */			\
  template<>						\
    inline constexpr TYPE phi_v<TYPE>			\
      = 1.618033988749894848204586834365638118##SUFFIX

#ifdef __STDCPP_FLOAT16_T__
__glibcxx_numbers (_Float16, F16);
#endif

#ifdef __STDCPP_FLOAT32_T__
__glibcxx_numbers (_Float32, F32);
#endif

#ifdef __STDCPP_FLOAT64_T__
__glibcxx_numbers (_Float64, F64);
#endif

#ifdef __STDCPP_FLOAT128_T__
__glibcxx_numbers (_Float128, F128);
#endif

#ifdef __STDCPP_BFLOAT128_T__
__glibcxx_numbers (__gnu_cxx::__bfloat16_t, BF16);
#endif

#if !defined(__STRICT_ANSI__) && defined(_GLIBCXX_USE_FLOAT128)
__glibcxx_numbers (__float128, Q);
#endif // USE_FLOAT128

#undef __glibcxx_numbers

} // namespace numbers
/// @}
_GLIBCXX_END_NAMESPACE_VERSION
} // namespace std

#endif // C++20
#endif // _GLIBCXX_NUMBERS
Commit	Line	Data
960b9ae0 JW	1	// <numbers> -- C++ --
960b9ae0 JW	2
83ffe9cd	3	// Copyright (C) 2019-2023 Free Software Foundation, Inc.
960b9ae0 JW	4	//
	5	// This file is part of the GNU ISO C++ Library. This library is free
	6	// software; you can redistribute it and/or modify it under the
	7	// terms of the GNU General Public License as published by the
	8	// Free Software Foundation; either version 3, or (at your option)
	9	// any later version.
	10
	11	// This library is distributed in the hope that it will be useful,
	12	// but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	// GNU General Public License for more details.
	15
	16	// Under Section 7 of GPL version 3, you are granted additional
	17	// permissions described in the GCC Runtime Library Exception, version
	18	// 3.1, as published by the Free Software Foundation.
	19
	20	// You should have received a copy of the GNU General Public License and
	21	// a copy of the GCC Runtime Library Exception along with this program;
	22	// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
	23	// <http://www.gnu.org/licenses/>.
	24
	25	/** @file include/numbers
	26	* This is a Standard C++ Library header.
	27	*/
	28
	29	#ifndef _GLIBCXX_NUMBERS
	30	#define _GLIBCXX_NUMBERS 1
	31
	32	#pragma GCC system_header
	33
	34	#if __cplusplus > 201703L
	35
	36	#include <type_traits>
	37
	38	namespace std _GLIBCXX_VISIBILITY(default)
	39	{
	40	_GLIBCXX_BEGIN_NAMESPACE_VERSION
	41
	42	/** @defgroup math_constants Mathematical constants
	43	* @ingroup numerics
	44	* @{
	45	*/
	46
	47	/// Namespace for mathematical constants
	48	namespace numbers
	49	{
	50	#define __cpp_lib_math_constants 201907L
	51
	52	/// @cond undoc
	53	template<typename _Tp>
	54	using _Enable_if_floating = enable_if_t<is_floating_point_v<_Tp>, _Tp>;
	55	/// @endcond
	56
	57	/// e
	58	template<typename _Tp>
	59	inline constexpr _Tp e_v
	60	= _Enable_if_floating<_Tp>(2.718281828459045235360287471352662498L);
	61
	62	/// log_2 e
	63	template<typename _Tp>
	64	inline constexpr _Tp log2e_v
	65	= _Enable_if_floating<_Tp>(1.442695040888963407359924681001892137L);
	66
	67	/// log_10 e
68	template<typename _Tp>
69	inline constexpr _Tp log10e_v
70	= _Enable_if_floating<_Tp>(0.434294481903251827651128918916605082L);
71
72	/// pi
73	template<typename _Tp>
74	inline constexpr _Tp pi_v
75	= _Enable_if_floating<_Tp>(3.141592653589793238462643383279502884L);
76
77	/// 1/pi
78	template<typename _Tp>
79	inline constexpr _Tp inv_pi_v
80	= _Enable_if_floating<_Tp>(0.318309886183790671537767526745028724L);
81
82	/// 1/sqrt(pi)
83	template<typename _Tp>
84	inline constexpr _Tp inv_sqrtpi_v
85	= _Enable_if_floating<_Tp>(0.564189583547756286948079451560772586L);
86
87	/// log_e 2
88	template<typename _Tp>
89	inline constexpr _Tp ln2_v
90	= _Enable_if_floating<_Tp>(0.693147180559945309417232121458176568L);
91
92	/// log_e 10
93	template<typename _Tp>
94	inline constexpr _Tp ln10_v
95	= _Enable_if_floating<_Tp>(2.302585092994045684017991454684364208L);
96
97	/// sqrt(2)
98	template<typename _Tp>
99	inline constexpr _Tp sqrt2_v
100	= _Enable_if_floating<_Tp>(1.414213562373095048801688724209698079L);
101
102	/// sqrt(3)
103	template<typename _Tp>
104	inline constexpr _Tp sqrt3_v
105	= _Enable_if_floating<_Tp>(1.732050807568877293527446341505872367L);
106
107	/// 1/sqrt(3)
108	template<typename _Tp>
109	inline constexpr _Tp inv_sqrt3_v
110	= _Enable_if_floating<_Tp>(0.577350269189625764509148780501957456L);
111
112	/// The Euler-Mascheroni constant
113	template<typename _Tp>
114	inline constexpr _Tp egamma_v
115	= _Enable_if_floating<_Tp>(0.577215664901532860606512090082402431L);
116
117	/// The golden ratio, (1+sqrt(5))/2
118	template<typename _Tp>
119	inline constexpr _Tp phi_v
120	= _Enable_if_floating<_Tp>(1.618033988749894848204586834365638118L);
121
122	inline constexpr double e = e_v<double>;
123	inline constexpr double log2e = log2e_v<double>;
124	inline constexpr double log10e = log10e_v<double>;
125	inline constexpr double pi = pi_v<double>;
126	inline constexpr double inv_pi = inv_pi_v<double>;
127	inline constexpr double inv_sqrtpi = inv_sqrtpi_v<double>;
128	inline constexpr double ln2 = ln2_v<double>;
129	inline constexpr double ln10 = ln10_v<double>;
130	inline constexpr double sqrt2 = sqrt2_v<double>;
131	inline constexpr double sqrt3 = sqrt3_v<double>;
132	inline constexpr double inv_sqrt3 = inv_sqrt3_v<double>;
133	inline constexpr double egamma = egamma_v<double>;
134	inline constexpr double phi = phi_v<double>;
135
a23225fb JJ	136	#define __glibcxx_numbers(TYPE, SUFFIX) \
	137	/* e */ \
	138	template<> \
	139	inline constexpr TYPE e_v<TYPE> \
	140	= 2.718281828459045235360287471352662498##SUFFIX; \
	141	\
	142	/* log_2 e */ \
	143	template<> \
	144	inline constexpr TYPE log2e_v<TYPE> \
	145	= 1.442695040888963407359924681001892137##SUFFIX; \
	146	\
	147	/* log_10 e */ \
	148	template<> \
	149	inline constexpr TYPE log10e_v<TYPE> \
	150	= 0.434294481903251827651128918916605082##SUFFIX; \
	151	\
	152	/* pi */ \
	153	template<> \
	154	inline constexpr TYPE pi_v<TYPE> \
	155	= 3.141592653589793238462643383279502884##SUFFIX; \
	156	\
	157	/* 1/pi */ \
	158	template<> \
	159	inline constexpr TYPE inv_pi_v<TYPE> \
	160	= 0.318309886183790671537767526745028724##SUFFIX; \
	161	\
	162	/* 1/sqrt(pi) */ \
	163	template<> \
	164	inline constexpr TYPE inv_sqrtpi_v<TYPE> \
	165	= 0.564189583547756286948079451560772586##SUFFIX; \
	166	\
	167	/* log_e 2 */ \
	168	template<> \
	169	inline constexpr TYPE ln2_v<TYPE> \
	170	= 0.693147180559945309417232121458176568##SUFFIX; \
	171	\
	172	/* log_e 10 */ \
	173	template<> \
	174	inline constexpr TYPE ln10_v<TYPE> \
	175	= 2.302585092994045684017991454684364208##SUFFIX; \
	176	\
	177	/* sqrt(2) */ \
	178	template<> \
	179	inline constexpr TYPE sqrt2_v<TYPE> \
	180	= 1.414213562373095048801688724209698079##SUFFIX; \
	181	\
	182	/* sqrt(3) */ \
	183	template<> \
	184	inline constexpr TYPE sqrt3_v<TYPE> \
	185	= 1.732050807568877293527446341505872367##SUFFIX; \
	186	\
	187	/* 1/sqrt(3) */ \
	188	template<> \
	189	inline constexpr TYPE inv_sqrt3_v<TYPE> \
	190	= 0.577350269189625764509148780501957456##SUFFIX; \
	191	\
	192	/* The Euler-Mascheroni constant */ \
	193	template<> \
	194	inline constexpr TYPE egamma_v<TYPE> \
	195	= 0.577215664901532860606512090082402431##SUFFIX; \
	196	\
	197	/* The golden ratio, (1+sqrt(5))/2 */ \
	198	template<> \
	199	inline constexpr TYPE phi_v<TYPE> \
200	= 1.618033988749894848204586834365638118##SUFFIX
201
202	#ifdef __STDCPP_FLOAT16_T__
203	__glibcxx_numbers (_Float16, F16);
204	#endif
205
206	#ifdef __STDCPP_FLOAT32_T__
207	__glibcxx_numbers (_Float32, F32);
208	#endif
209
210	#ifdef __STDCPP_FLOAT64_T__
211	__glibcxx_numbers (_Float64, F64);
212	#endif
213
214	#ifdef __STDCPP_FLOAT128_T__
215	__glibcxx_numbers (_Float128, F128);
216	#endif
217
218	#ifdef __STDCPP_BFLOAT128_T__
219	__glibcxx_numbers (__gnu_cxx::__bfloat16_t, BF16);
220	#endif
a38b51bc	221
a23225fb JJ	222	#if !defined(__STRICT_ANSI__) && defined(_GLIBCXX_USE_FLOAT128)
a23225fb JJ	223	__glibcxx_numbers (__float128, Q);
a38b51bc JW	224	#endif // USE_FLOAT128
a38b51bc JW	225
a23225fb JJ	226	#undef __glibcxx_numbers
a23225fb JJ	227
960b9ae0 JW	228	} // namespace numbers
	229	/// @}
	230	_GLIBCXX_END_NAMESPACE_VERSION
	231	} // namespace std
	232
	233	#endif // C++20
	234	#endif // _GLIBCXX_NUMBERS