1use crate::docs::entry::{FnEntry, StdEntry};
2pub static MATH_CONSTS: StdEntry = StdEntry {
3 name: "math::consts",
4 description: "functions for math",
5 functions: FUNCTIONS,
6 since: None,
7 unstable: false,
8};
9
10static FUNCTIONS: &[&FnEntry] = &[
11 &E,
12 &EULER_GAMMA,
13 &FRAC_1_PI,
14 &FRAC_1_SQRT_2,
15 &FRAC_2_PI,
16 &FRAC_2_SQRT_PI,
17 &FRAC_PI_2,
18 &FRAC_PI_3,
19 &FRAC_PI_4,
20 &FRAC_PI_6,
21 &FRAC_PI_8,
22 &INF,
23 &IS_INF,
24 &IS_NAN,
25 &LN_10,
26 &LN_2,
27 &LOG10_2,
28 &LOG10_E,
29 &LOG2_E,
30 &LOG2_10,
31 &NAN,
32 &PHI,
33 &PI,
34 &SQRT_2,
35 &TAU,
36];
37
38static E: FnEntry = FnEntry {
39 signature: "E()",
40 description: "euler's number (~2.718)",
41 example: "get std::math::consts::E\nE()",
42 expected_output: None,
43 returns: "",
44 errors: None,
45 see_also: &[],
46 since: None,
47};
48
49static EULER_GAMMA: FnEntry = FnEntry {
50 signature: "EULER_GAMMA()",
51 description: "euler-mascheroni constant (~0.577)",
52 example: "get std::math::consts::EULER_GAMMA\nEULER_GAMMA()",
53 expected_output: None,
54 returns: "",
55 errors: None,
56 see_also: &[],
57 since: None,
58};
59
60static FRAC_1_PI: FnEntry = FnEntry {
61 signature: "FRAC_1_PI()",
62 description: "1/π",
63 example: "get std::math::consts::FRAC_1_PI\nFRAC_1_PI()",
64 expected_output: None,
65 returns: "",
66 errors: None,
67 see_also: &[],
68 since: None,
69};
70
71static FRAC_1_SQRT_2: FnEntry = FnEntry {
72 signature: "FRAC_1_SQRT_2()",
73 description: "1/√2",
74 example: "get std::math::consts::FRAC_1_SQRT_2\nFRAC_1_SQRT_2()",
75 expected_output: None,
76 returns: "",
77 errors: None,
78 see_also: &[],
79 since: None,
80};
81
82static FRAC_2_PI: FnEntry = FnEntry {
83 signature: "FRAC_2_PI()",
84 description: "2/π",
85 example: "get std::math::consts::FRAC_2_PI\nFRAC_2_PI()",
86 expected_output: None,
87 returns: "",
88 errors: None,
89 see_also: &[],
90 since: None,
91};
92
93static FRAC_2_SQRT_PI: FnEntry = FnEntry {
94 signature: "FRAC_2_SQRT_PI()",
95 description: "2/√π",
96 example: "get std::math::consts::FRAC_2_SQRT_PI\nFRAC_2_SQRT_PI()",
97 expected_output: None,
98 returns: "",
99 errors: None,
100 see_also: &[],
101 since: None,
102};
103
104static FRAC_PI_2: FnEntry = FnEntry {
105 signature: "FRAC_PI_2()",
106 description: "π/2",
107 example: "get std::math::consts::FRAC_PI_2\nFRAC_PI_2()",
108 expected_output: None,
109 returns: "",
110 errors: None,
111 see_also: &[],
112 since: None,
113};
114
115static FRAC_PI_3: FnEntry = FnEntry {
116 signature: "FRAC_PI_3()",
117 description: "π/3",
118 example: "get std::math::consts::FRAC_PI_3\nFRAC_PI_3()",
119 expected_output: None,
120 returns: "",
121 errors: None,
122 see_also: &[],
123 since: None,
124};
125
126static FRAC_PI_4: FnEntry = FnEntry {
127 signature: "FRAC_PI_4()",
128 description: "π/4",
129 example: "get std::math::consts::FRAC_PI_4\nFRAC_PI_4()",
130 expected_output: None,
131 returns: "",
132 errors: None,
133 see_also: &[],
134 since: None,
135};
136
137static FRAC_PI_6: FnEntry = FnEntry {
138 signature: "FRAC_PI_6()",
139 description: "π/6",
140 example: "get std::math::consts::FRAC_PI_6\nFRAC_PI_6()",
141 expected_output: None,
142 returns: "",
143 errors: None,
144 see_also: &[],
145 since: None,
146};
147
148static FRAC_PI_8: FnEntry = FnEntry {
149 signature: "FRAC_PI_8()",
150 description: "π/8",
151 example: "get std::math::consts::FRAC_PI_8\nFRAC_PI_8()",
152 expected_output: None,
153 returns: "",
154 errors: None,
155 see_also: &[],
156 since: None,
157};
158
159static INF: FnEntry = FnEntry {
160 signature: "INF()",
161 description: "positive infinity",
162 example: "get std::math::consts::INF\nINF()",
163 expected_output: None,
164 returns: "",
165 errors: None,
166 see_also: &[],
167 since: None,
168};
169
170static IS_INF: FnEntry = FnEntry {
171 signature: "is_inf(x)",
172 description: "true if x is infinite",
173 example: "get std::math::consts::is_inf\nis_inf(1.0)",
174 expected_output: None,
175 returns: "",
176 errors: None,
177 see_also: &[],
178 since: None,
179};
180
181static IS_NAN: FnEntry = FnEntry {
182 signature: "is_nan(x)",
183 description: "true if x is not a number",
184 example: "get std::math::consts::is_nan\nis_nan(NAN())",
185 expected_output: None,
186 returns: "",
187 errors: None,
188 see_also: &[],
189 since: None,
190};
191
192static LN_2: FnEntry = FnEntry {
193 signature: "LN_2()",
194 description: "natural log of 2",
195 example: "get std::math::consts::LN_2\nLN_2()",
196 expected_output: None,
197 returns: "",
198 errors: None,
199 see_also: &[],
200 since: None,
201};
202
203static LN_10: FnEntry = FnEntry {
204 signature: "LN_10()",
205 description: "natural log of 10",
206 example: "get std::math::consts::LN_10\nLN_10()",
207 expected_output: None,
208 returns: "",
209 errors: None,
210 see_also: &[],
211 since: None,
212};
213
214static LOG2_10: FnEntry = FnEntry {
215 signature: "LOG2_10()",
216 description: "base-2 log of 10",
217 example: "get std::math::consts::LOG2_10\nLOG2_10()",
218 expected_output: None,
219 returns: "",
220 errors: None,
221 see_also: &[],
222 since: None,
223};
224
225static LOG2_E: FnEntry = FnEntry {
226 signature: "LOG2_E()",
227 description: "base-2 log of e",
228 example: "get std::math::consts::LOG2_E\nLOG2_E()",
229 expected_output: None,
230 returns: "",
231 errors: None,
232 see_also: &[],
233 since: None,
234};
235
236static LOG10_2: FnEntry = FnEntry {
237 signature: "LOG10_2()",
238 description: "base-10 log of 2",
239 example: "get std::math::consts::LOG10_2\nLOG10_2()",
240 expected_output: None,
241 returns: "",
242 errors: None,
243 see_also: &[],
244 since: None,
245};
246
247static LOG10_E: FnEntry = FnEntry {
248 signature: "LOG10_E()",
249 description: "base-10 log of e",
250 example: "get std::math::consts::LOG10_E\nLOG10_E()",
251 expected_output: None,
252 returns: "",
253 errors: None,
254 see_also: &[],
255 since: None,
256};
257
258static NAN: FnEntry = FnEntry {
259 signature: "NAN()",
260 description: "not-a-number value",
261 example: "get std::math::consts::NAN\nNAN()",
262 expected_output: None,
263 returns: "",
264 errors: None,
265 see_also: &[],
266 since: None,
267};
268
269static PHI: FnEntry = FnEntry {
270 signature: "PHI()",
271 description: "golden ratio (~1.618)",
272 expected_output: None,
273 returns: "",
274 errors: None,
275 see_also: &[],
276 since: None,
277 example: "get std::math::consts::PHI\nPHI()",
278};
279
280static PI: FnEntry = FnEntry {
281 signature: "PI()",
282 description: "π (~3.14159)",
283 example: "get std::math::consts::PI\nPI()",
284 expected_output: None,
285 returns: "",
286 errors: None,
287 see_also: &[],
288 since: None,
289};
290
291static SQRT_2: FnEntry = FnEntry {
292 signature: "SQRT_2()",
293 description: "square root of 2 (~1.414)",
294 example: "get std::math::consts::SQRT_2\nSQRT_2()",
295 expected_output: None,
296 returns: "",
297 errors: None,
298 see_also: &[],
299 since: None,
300};
301
302static TAU: FnEntry = FnEntry {
303 signature: "TAU()",
304 description: "τ = 2π (~6.283)",
305 example: "get std::math::consts::TAU\nTAU()",
306 expected_output: None,
307 returns: "",
308 errors: None,
309 see_also: &[],
310 since: None,
311};