Skip to content

Commit cdf5e79

Browse files
stdlib-botstdlib-bot
authored
docs: update namespace table of contents
PR-URL: #4365 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 109c303 commit cdf5e79

File tree

3 files changed

+101
-2
lines changed

3 files changed

+101
-2
lines changed

‎lib/node_modules/@stdlib/constants/float32/README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,52 @@ var c = constants;
4545

4646
- <span class="signature">[`ABS_MASK`][@stdlib/constants/float32/abs-mask]</span><span class="delimiter">: </span><span class="description">mask for excluding the sign bit of a single-precision floating-point number.</span>
4747
- <span class="signature">[`CBRT_EPS`][@stdlib/constants/float32/cbrt-eps]</span><span class="delimiter">: </span><span class="description">cube root of single-precision floating-point epsilon.</span>
48+
- <span class="signature">[`E`][@stdlib/constants/float32/e]</span><span class="delimiter">: </span><span class="description">the mathematical constant _e_.</span>
4849
- <span class="signature">[`EPS`][@stdlib/constants/float32/eps]</span><span class="delimiter">: </span><span class="description">difference between one and the smallest value greater than one that can be represented as a single-precision floating-point number.</span>
4950
- <span class="signature">[`EXPONENT_BIAS`][@stdlib/constants/float32/exponent-bias]</span><span class="delimiter">: </span><span class="description">the bias of a single-precision floating-point number's exponent.</span>
5051
- <span class="signature">[`EXPONENT_MASK`][@stdlib/constants/float32/exponent-mask]</span><span class="delimiter">: </span><span class="description">mask for the exponent of a single-precision floating-point number.</span>
52+
- <span class="signature">[`FOURTH_PI`][@stdlib/constants/float32/fourth-pi]</span><span class="delimiter">: </span><span class="description">one fourth times the mathematical constant π.</span>
53+
- <span class="signature">[`HALF_LN_TWO`][@stdlib/constants/float32/half-ln-two]</span><span class="delimiter">: </span><span class="description">one half times the natural logarithm of `2` as a single-precision floating-point number.</span>
54+
- <span class="signature">[`HALF_PI`][@stdlib/constants/float32/half-pi]</span><span class="delimiter">: </span><span class="description">one half times the mathematical constant π.</span>
55+
- <span class="signature">[`LN_HALF`][@stdlib/constants/float32/ln-half]</span><span class="delimiter">: </span><span class="description">natural logarithm of `1/2` as a single-precision floating-point number.</span>
56+
- <span class="signature">[`LN_PI`][@stdlib/constants/float32/ln-pi]</span><span class="delimiter">: </span><span class="description">natural logarithm of the mathematical constant π as a single-precision floating-point number.</span>
57+
- <span class="signature">[`LN_TEN`][@stdlib/constants/float32/ln-ten]</span><span class="delimiter">: </span><span class="description">natural logarithm of `10` as a single-precision floating-point number.</span>
58+
- <span class="signature">[`LN_TWO`][@stdlib/constants/float32/ln-two]</span><span class="delimiter">: </span><span class="description">natural logarithm of `2` as a single-precision floating-point number.</span>
59+
- <span class="signature">[`MAX_BASE10_EXPONENT_SUBNORMAL`][@stdlib/constants/float32/max-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the maximum base 10 exponent for a subnormal single-precision floating-point number.</span>
60+
- <span class="signature">[`MAX_BASE10_EXPONENT`][@stdlib/constants/float32/max-base10-exponent]</span><span class="delimiter">: </span><span class="description">the maximum base 10 exponent for a single-precision floating-point number.</span>
61+
- <span class="signature">[`MAX_BASE2_EXPONENT_SUBNORMAL`][@stdlib/constants/float32/max-base2-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the maximum biased base 2 exponent for a subnormal single-precision floating-point number.</span>
62+
- <span class="signature">[`MAX_BASE2_EXPONENT`][@stdlib/constants/float32/max-base2-exponent]</span><span class="delimiter">: </span><span class="description">the maximum biased base 2 exponent for a single-precision floating-point number.</span>
63+
- <span class="signature">[`MAX_SAFE_FIBONACCI`][@stdlib/constants/float32/max-safe-fibonacci]</span><span class="delimiter">: </span><span class="description">maximum safe Fibonacci number when stored in single-precision floating-point format.</span>
5164
- <span class="signature">[`MAX_SAFE_INTEGER`][@stdlib/constants/float32/max-safe-integer]</span><span class="delimiter">: </span><span class="description">maximum safe single-precision floating-point integer.</span>
65+
- <span class="signature">[`MAX_SAFE_NTH_FACTORIAL`][@stdlib/constants/float32/max-safe-nth-factorial]</span><span class="delimiter">: </span><span class="description">maximum safe nth factorial when stored in single-precision floating-point format.</span>
66+
- <span class="signature">[`MAX_SAFE_NTH_FIBONACCI`][@stdlib/constants/float32/max-safe-nth-fibonacci]</span><span class="delimiter">: </span><span class="description">maximum safe nth Fibonacci number when stored in single-precision floating-point format.</span>
67+
- <span class="signature">[`MAX_SAFE_NTH_LUCAS`][@stdlib/constants/float32/max-safe-nth-lucas]</span><span class="delimiter">: </span><span class="description">maximum safe nth Lucas number when stored in single-precision floating-point format.</span>
5268
- <span class="signature">[`MAX`][@stdlib/constants/float32/max]</span><span class="delimiter">: </span><span class="description">maximum single-precision floating-point number.</span>
69+
- <span class="signature">[`MIN_BASE10_EXPONENT_SUBNORMAL`][@stdlib/constants/float32/min-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a subnormal single-precision floating-point number.</span>
70+
- <span class="signature">[`MIN_BASE10_EXPONENT`][@stdlib/constants/float32/min-base10-exponent]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a normal single-precision floating-point number.</span>
71+
- <span class="signature">[`MIN_BASE2_EXPONENT_SUBNORMAL`][@stdlib/constants/float32/min-base2-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a subnormal single-precision floating-point number.</span>
72+
- <span class="signature">[`MIN_BASE2_EXPONENT`][@stdlib/constants/float32/min-base2-exponent]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a normal single-precision floating-point number.</span>
5373
- <span class="signature">[`MIN_SAFE_INTEGER`][@stdlib/constants/float32/min-safe-integer]</span><span class="delimiter">: </span><span class="description">minimum safe single-precision floating-point integer.</span>
5474
- <span class="signature">[`NAN`][@stdlib/constants/float32/nan]</span><span class="delimiter">: </span><span class="description">single-precision floating-point `NaN`.</span>
5575
- <span class="signature">[`NINF`][@stdlib/constants/float32/ninf]</span><span class="delimiter">: </span><span class="description">single-precision floating-point negative infinity.</span>
5676
- <span class="signature">[`NUM_BYTES`][@stdlib/constants/float32/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a single-precision floating-point number.</span>
77+
- <span class="signature">[`PHI`][@stdlib/constants/float32/phi]</span><span class="delimiter">: </span><span class="description">golden ratio.</span>
78+
- <span class="signature">[`PI`][@stdlib/constants/float32/pi]</span><span class="delimiter">: </span><span class="description">the mathematical constant π.</span>
5779
- <span class="signature">[`PINF`][@stdlib/constants/float32/pinf]</span><span class="delimiter">: </span><span class="description">single-precision floating-point positive infinity.</span>
5880
- <span class="signature">[`PRECISION`][@stdlib/constants/float32/precision]</span><span class="delimiter">: </span><span class="description">effective number of bits in the significand of a single-precision floating-point number.</span>
5981
- <span class="signature">[`SIGN_MASK`][@stdlib/constants/float32/sign-mask]</span><span class="delimiter">: </span><span class="description">mask for the sign bit of a single-precision floating-point number.</span>
6082
- <span class="signature">[`SIGNIFICAND_MASK`][@stdlib/constants/float32/significand-mask]</span><span class="delimiter">: </span><span class="description">mask for the significand of a single-precision floating-point number.</span>
6183
- <span class="signature">[`SMALLEST_NORMAL`][@stdlib/constants/float32/smallest-normal]</span><span class="delimiter">: </span><span class="description">smallest positive **normalized** single-precision floating-point number.</span>
6284
- <span class="signature">[`SMALLEST_SUBNORMAL`][@stdlib/constants/float32/smallest-subnormal]</span><span class="delimiter">: </span><span class="description">smallest positive **denormalized** single-precision floating-point number.</span>
6385
- <span class="signature">[`SQRT_EPS`][@stdlib/constants/float32/sqrt-eps]</span><span class="delimiter">: </span><span class="description">square root of single-precision floating-point epsilon.</span>
86+
- <span class="signature">[`SQRT_HALF_PI`][@stdlib/constants/float32/sqrt-half-pi]</span><span class="delimiter">: </span><span class="description">square root of the mathematical constant π divided by 2 as a single-precision floating-point number.</span>
87+
- <span class="signature">[`SQRT_HALF`][@stdlib/constants/float32/sqrt-half]</span><span class="delimiter">: </span><span class="description">square root of `1/2` as a single-precision floating-point number.</span>
88+
- <span class="signature">[`SQRT_PHI`][@stdlib/constants/float32/sqrt-phi]</span><span class="delimiter">: </span><span class="description">square root of the Golden ratio (φ) as a single-precision floating-point number.</span>
89+
- <span class="signature">[`SQRT_PI`][@stdlib/constants/float32/sqrt-pi]</span><span class="delimiter">: </span><span class="description">square root of the mathematical constant π as a single-precision floating-point number.</span>
90+
- <span class="signature">[`SQRT_THREE`][@stdlib/constants/float32/sqrt-three]</span><span class="delimiter">: </span><span class="description">square root of `3` as a single-precision floating-point number.</span>
91+
- <span class="signature">[`SQRT_TWO_PI`][@stdlib/constants/float32/sqrt-two-pi]</span><span class="delimiter">: </span><span class="description">square root of the mathematical constant π times 2 as a single-precision floating-point number.</span>
92+
- <span class="signature">[`SQRT_TWO`][@stdlib/constants/float32/sqrt-two]</span><span class="delimiter">: </span><span class="description">square root of `2` as a single-precision floating-point number.</span>
93+
- <span class="signature">[`TWO_PI`][@stdlib/constants/float32/two-pi]</span><span class="delimiter">: </span><span class="description">the mathematical constant π times 2.</span>
6494

6595
</div>
6696

@@ -107,16 +137,56 @@ console.log( objectKeys( constants ) );
107137

108138
[@stdlib/constants/float32/cbrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/cbrt-eps
109139

140+
[@stdlib/constants/float32/e]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/e
141+
110142
[@stdlib/constants/float32/eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/eps
111143

112144
[@stdlib/constants/float32/exponent-bias]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-bias
113145

114146
[@stdlib/constants/float32/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-mask
115147

148+
[@stdlib/constants/float32/fourth-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/fourth-pi
149+
150+
[@stdlib/constants/float32/half-ln-two]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/half-ln-two
151+
152+
[@stdlib/constants/float32/half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/half-pi
153+
154+
[@stdlib/constants/float32/ln-half]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-half
155+
156+
[@stdlib/constants/float32/ln-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-pi
157+
158+
[@stdlib/constants/float32/ln-ten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-ten
159+
160+
[@stdlib/constants/float32/ln-two]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-two
161+
162+
[@stdlib/constants/float32/max-base10-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base10-exponent-subnormal
163+
164+
[@stdlib/constants/float32/max-base10-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base10-exponent
165+
166+
[@stdlib/constants/float32/max-base2-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base2-exponent-subnormal
167+
168+
[@stdlib/constants/float32/max-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base2-exponent
169+
170+
[@stdlib/constants/float32/max-safe-fibonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-fibonacci
171+
116172
[@stdlib/constants/float32/max-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-integer
117173

174+
[@stdlib/constants/float32/max-safe-nth-factorial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-nth-factorial
175+
176+
[@stdlib/constants/float32/max-safe-nth-fibonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-nth-fibonacci
177+
178+
[@stdlib/constants/float32/max-safe-nth-lucas]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-nth-lucas
179+
118180
[@stdlib/constants/float32/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max
119181

182+
[@stdlib/constants/float32/min-base10-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent-subnormal
183+
184+
[@stdlib/constants/float32/min-base10-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent
185+
186+
[@stdlib/constants/float32/min-base2-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base2-exponent-subnormal
187+
188+
[@stdlib/constants/float32/min-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base2-exponent
189+
120190
[@stdlib/constants/float32/min-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-safe-integer
121191

122192
[@stdlib/constants/float32/nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/nan
@@ -125,6 +195,10 @@ console.log( objectKeys( constants ) );
125195

126196
[@stdlib/constants/float32/num-bytes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/num-bytes
127197

198+
[@stdlib/constants/float32/phi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/phi
199+
200+
[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi
201+
128202
[@stdlib/constants/float32/pinf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pinf
129203

130204
[@stdlib/constants/float32/precision]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/precision
@@ -139,6 +213,22 @@ console.log( objectKeys( constants ) );
139213

140214
[@stdlib/constants/float32/sqrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-eps
141215

216+
[@stdlib/constants/float32/sqrt-half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-half-pi
217+
218+
[@stdlib/constants/float32/sqrt-half]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-half
219+
220+
[@stdlib/constants/float32/sqrt-phi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-phi
221+
222+
[@stdlib/constants/float32/sqrt-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-pi
223+
224+
[@stdlib/constants/float32/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-three
225+
226+
[@stdlib/constants/float32/sqrt-two-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-two-pi
227+
228+
[@stdlib/constants/float32/sqrt-two]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-two
229+
230+
[@stdlib/constants/float32/two-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/two-pi
231+
142232
<!-- </toc-links> -->
143233

144234
</section>

0 commit comments

Comments
 (0)