xref: /freebsd/contrib/llvm-project/libcxx/include/numbers (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1// -*- C++ -*-
2//===----------------------------------------------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_NUMBERS
11#define _LIBCPP_NUMBERS
12
13/*
14    numbers synopsis
15
16namespace std::numbers {
17  template<class T> inline constexpr T e_v          = unspecified;
18  template<class T> inline constexpr T log2e_v      = unspecified;
19  template<class T> inline constexpr T log10e_v     = unspecified;
20  template<class T> inline constexpr T pi_v         = unspecified;
21  template<class T> inline constexpr T inv_pi_v     = unspecified;
22  template<class T> inline constexpr T inv_sqrtpi_v = unspecified;
23  template<class T> inline constexpr T ln2_v        = unspecified;
24  template<class T> inline constexpr T ln10_v       = unspecified;
25  template<class T> inline constexpr T sqrt2_v      = unspecified;
26  template<class T> inline constexpr T sqrt3_v      = unspecified;
27  template<class T> inline constexpr T inv_sqrt3_v  = unspecified;
28  template<class T> inline constexpr T egamma_v     = unspecified;
29  template<class T> inline constexpr T phi_v        = unspecified;
30
31  template<floating_point T> inline constexpr T e_v<T>          = see below;
32  template<floating_point T> inline constexpr T log2e_v<T>      = see below;
33  template<floating_point T> inline constexpr T log10e_v<T>     = see below;
34  template<floating_point T> inline constexpr T pi_v<T>         = see below;
35  template<floating_point T> inline constexpr T inv_pi_v<T>     = see below;
36  template<floating_point T> inline constexpr T inv_sqrtpi_v<T> = see below;
37  template<floating_point T> inline constexpr T ln2_v<T>        = see below;
38  template<floating_point T> inline constexpr T ln10_v<T>       = see below;
39  template<floating_point T> inline constexpr T sqrt2_v<T>      = see below;
40  template<floating_point T> inline constexpr T sqrt3_v<T>      = see below;
41  template<floating_point T> inline constexpr T inv_sqrt3_v<T>  = see below;
42  template<floating_point T> inline constexpr T egamma_v<T>     = see below;
43  template<floating_point T> inline constexpr T phi_v<T>        = see below;
44
45  inline constexpr double e          = e_v<double>;
46  inline constexpr double log2e      = log2e_v<double>;
47  inline constexpr double log10e     = log10e_v<double>;
48  inline constexpr double pi         = pi_v<double>;
49  inline constexpr double inv_pi     = inv_pi_v<double>;
50  inline constexpr double inv_sqrtpi = inv_sqrtpi_v<double>;
51  inline constexpr double ln2        = ln2_v<double>;
52  inline constexpr double ln10       = ln10_v<double>;
53  inline constexpr double sqrt2      = sqrt2_v<double>;
54  inline constexpr double sqrt3      = sqrt3_v<double>;
55  inline constexpr double inv_sqrt3  = inv_sqrt3_v<double>;
56  inline constexpr double egamma     = egamma_v<double>;
57  inline constexpr double phi        = phi_v<double>;
58}
59*/
60
61#include <__assert> // all public C++ headers provide the assertion handler
62#include <__concepts/arithmetic.h>
63#include <__config>
64#include <version>
65
66#if _LIBCPP_STD_VER > 17
67
68#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
69#  pragma GCC system_header
70#endif
71
72_LIBCPP_BEGIN_NAMESPACE_STD
73
74namespace numbers {
75
76template <class _Tp>
77inline constexpr bool __false = false;
78
79template <class _Tp>
80struct __illformed
81{
82  static_assert(__false<_Tp>, "A program that instantiates a primary template of a mathematical constant variable template is ill-formed.");
83};
84
85template <class _Tp> inline constexpr _Tp e_v =          __illformed<_Tp>{};
86template <class _Tp> inline constexpr _Tp log2e_v =      __illformed<_Tp>{};
87template <class _Tp> inline constexpr _Tp log10e_v =     __illformed<_Tp>{};
88template <class _Tp> inline constexpr _Tp pi_v =         __illformed<_Tp>{};
89template <class _Tp> inline constexpr _Tp inv_pi_v =     __illformed<_Tp>{};
90template <class _Tp> inline constexpr _Tp inv_sqrtpi_v = __illformed<_Tp>{};
91template <class _Tp> inline constexpr _Tp ln2_v =        __illformed<_Tp>{};
92template <class _Tp> inline constexpr _Tp ln10_v =       __illformed<_Tp>{};
93template <class _Tp> inline constexpr _Tp sqrt2_v =      __illformed<_Tp>{};
94template <class _Tp> inline constexpr _Tp sqrt3_v =      __illformed<_Tp>{};
95template <class _Tp> inline constexpr _Tp inv_sqrt3_v =  __illformed<_Tp>{};
96template <class _Tp> inline constexpr _Tp egamma_v =     __illformed<_Tp>{};
97template <class _Tp> inline constexpr _Tp phi_v =        __illformed<_Tp>{};
98
99template <floating_point _Tp> inline constexpr _Tp e_v<_Tp>          = 2.718281828459045235360287471352662;
100template <floating_point _Tp> inline constexpr _Tp log2e_v<_Tp>      = 1.442695040888963407359924681001892;
101template <floating_point _Tp> inline constexpr _Tp log10e_v<_Tp>     = 0.434294481903251827651128918916605;
102template <floating_point _Tp> inline constexpr _Tp pi_v<_Tp>         = 3.141592653589793238462643383279502;
103template <floating_point _Tp> inline constexpr _Tp inv_pi_v<_Tp>     = 0.318309886183790671537767526745028;
104template <floating_point _Tp> inline constexpr _Tp inv_sqrtpi_v<_Tp> = 0.564189583547756286948079451560772;
105template <floating_point _Tp> inline constexpr _Tp ln2_v<_Tp>        = 0.693147180559945309417232121458176;
106template <floating_point _Tp> inline constexpr _Tp ln10_v<_Tp>       = 2.302585092994045684017991454684364;
107template <floating_point _Tp> inline constexpr _Tp sqrt2_v<_Tp>      = 1.414213562373095048801688724209698;
108template <floating_point _Tp> inline constexpr _Tp sqrt3_v<_Tp>      = 1.732050807568877293527446341505872;
109template <floating_point _Tp> inline constexpr _Tp inv_sqrt3_v<_Tp>  = 0.577350269189625764509148780501957;
110template <floating_point _Tp> inline constexpr _Tp egamma_v<_Tp>     = 0.577215664901532860606512090082402;
111template <floating_point _Tp> inline constexpr _Tp phi_v<_Tp>        = 1.618033988749894848204586834365638;
112
113inline constexpr double e          = e_v<double>;
114inline constexpr double log2e      = log2e_v<double>;
115inline constexpr double log10e     = log10e_v<double>;
116inline constexpr double pi         = pi_v<double>;
117inline constexpr double inv_pi     = inv_pi_v<double>;
118inline constexpr double inv_sqrtpi = inv_sqrtpi_v<double>;
119inline constexpr double ln2        = ln2_v<double>;
120inline constexpr double ln10       = ln10_v<double>;
121inline constexpr double sqrt2      = sqrt2_v<double>;
122inline constexpr double sqrt3      = sqrt3_v<double>;
123inline constexpr double inv_sqrt3  = inv_sqrt3_v<double>;
124inline constexpr double egamma     = egamma_v<double>;
125inline constexpr double phi        = phi_v<double>;
126
127} // namespace numbers
128
129_LIBCPP_END_NAMESPACE_STD
130
131#endif // _LIBCPP_STD_VER > 17
132
133#if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
134#  include <concepts>
135#  include <type_traits>
136#endif
137
138#endif // _LIBCPP_NUMBERS
139