README.md (20807B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2021 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Constants 22 23 > Double-precision floating-point mathematical constants. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var constants = require( '@stdlib/constants/float64' ); 31 ``` 32 33 #### constants 34 35 Double-precision floating-point mathematical constants. 36 37 ```javascript 38 var c = constants; 39 // returns {...} 40 ``` 41 42 <!-- <toc pattern="*" > --> 43 44 <div class="namespace-toc"> 45 46 - <span class="signature">[`APERY`][@stdlib/constants/float64/apery]</span><span class="delimiter">: </span><span class="description">Apéry's constant.</span> 47 - <span class="signature">[`CATALAN`][@stdlib/constants/float64/catalan]</span><span class="delimiter">: </span><span class="description">Catalan's constant.</span> 48 - <span class="signature">[`CBRT_EPS`][@stdlib/constants/float64/cbrt-eps]</span><span class="delimiter">: </span><span class="description">cube root of double-precision floating-point epsilon.</span> 49 - <span class="signature">[`E`][@stdlib/constants/float64/e]</span><span class="delimiter">: </span><span class="description">the mathematical constant _e_.</span> 50 - <span class="signature">[`EPS`][@stdlib/constants/float64/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 double-precision floating-point number.</span> 51 - <span class="signature">[`EULERGAMMA`][@stdlib/constants/float64/eulergamma]</span><span class="delimiter">: </span><span class="description">the Euler-Mascheroni constant.</span> 52 - <span class="signature">[`EXPONENT_BIAS`][@stdlib/constants/float64/exponent-bias]</span><span class="delimiter">: </span><span class="description">the bias of a double-precision floating-point number's exponent.</span> 53 - <span class="signature">[`FOURTH_PI`][@stdlib/constants/float64/fourth-pi]</span><span class="delimiter">: </span><span class="description">one fourth times the mathematical constant π.</span> 54 - <span class="signature">[`FOURTH_ROOT_EPS`][@stdlib/constants/float64/fourth-root-eps]</span><span class="delimiter">: </span><span class="description">fourth root of double-precision floating-point epsilon.</span> 55 - <span class="signature">[`GAMMA_LANCZOS_G`][@stdlib/constants/float64/gamma-lanczos-g]</span><span class="delimiter">: </span><span class="description">arbitrary constant `g` to be used in Lanczos approximation functions.</span> 56 - <span class="signature">[`GLAISHER`][@stdlib/constants/float64/glaisher-kinkelin]</span><span class="delimiter">: </span><span class="description">Glaisher-Kinkelin constant.</span> 57 - <span class="signature">[`HALF_LN2`][@stdlib/constants/float64/half-ln-two]</span><span class="delimiter">: </span><span class="description">one half times the natural logarithm of 2.</span> 58 - <span class="signature">[`HALF_PI`][@stdlib/constants/float64/half-pi]</span><span class="delimiter">: </span><span class="description">one half times the mathematical constant π.</span> 59 - <span class="signature">[`HIGH_WORD_EXPONENT_MASK`][@stdlib/constants/float64/high-word-exponent-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the exponent of a double-precision floating-point number.</span> 60 - <span class="signature">[`HIGH_WORD_SIGNIFICAND_MASK`][@stdlib/constants/float64/high-word-significand-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the significand of a double-precision floating-point number.</span> 61 - <span class="signature">[`LN_HALF`][@stdlib/constants/float64/ln-half]</span><span class="delimiter">: </span><span class="description">natural logarithm of `1/2`.</span> 62 - <span class="signature">[`LN_PI`][@stdlib/constants/float64/ln-pi]</span><span class="delimiter">: </span><span class="description">natural logarithm of the mathematical constant π.</span> 63 - <span class="signature">[`LN_SQRT_TWO_PI`][@stdlib/constants/float64/ln-sqrt-two-pi]</span><span class="delimiter">: </span><span class="description">natural logarithm of the square root of 2π.</span> 64 - <span class="signature">[`LN10`][@stdlib/constants/float64/ln-ten]</span><span class="delimiter">: </span><span class="description">natural logarithm of `10`.</span> 65 - <span class="signature">[`LN_TWO_PI`][@stdlib/constants/float64/ln-two-pi]</span><span class="delimiter">: </span><span class="description">natural logarithm of `2π`.</span> 66 - <span class="signature">[`LN2`][@stdlib/constants/float64/ln-two]</span><span class="delimiter">: </span><span class="description">natural logarithm of `2`.</span> 67 - <span class="signature">[`LOG10E`][@stdlib/constants/float64/log10-e]</span><span class="delimiter">: </span><span class="description">base 10 logarithm of the mathematical constant _e_.</span> 68 - <span class="signature">[`LOG2E`][@stdlib/constants/float64/log2-e]</span><span class="delimiter">: </span><span class="description">base 2 logarithm of the mathematical constant _e_.</span> 69 - <span class="signature">[`MAX_BASE10_EXPONENT_SUBNORMAL`][@stdlib/constants/float64/max-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the maximum base 10 exponent for a subnormal double-precision floating-point number.</span> 70 - <span class="signature">[`MAX_BASE10_EXPONENT`][@stdlib/constants/float64/max-base10-exponent]</span><span class="delimiter">: </span><span class="description">the maximum base 10 exponent for a double-precision floating-point number.</span> 71 - <span class="signature">[`MAX_BASE2_EXPONENT_SUBNORMAL`][@stdlib/constants/float64/max-base2-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the maximum biased base 2 exponent for a subnormal double-precision floating-point number.</span> 72 - <span class="signature">[`MAX_BASE2_EXPONENT`][@stdlib/constants/float64/max-base2-exponent]</span><span class="delimiter">: </span><span class="description">the maximum biased base 2 exponent for a double-precision floating-point number.</span> 73 - <span class="signature">[`MAX_LN`][@stdlib/constants/float64/max-ln]</span><span class="delimiter">: </span><span class="description">natural logarithm of the maximum double-precision floating-point number.</span> 74 - <span class="signature">[`MAX_SAFE_FIBONACCI`][@stdlib/constants/float64/max-safe-fibonacci]</span><span class="delimiter">: </span><span class="description">maximum safe Fibonacci number when stored in double-precision floating-point format.</span> 75 - <span class="signature">[`MAX_SAFE_INTEGER`][@stdlib/constants/float64/max-safe-integer]</span><span class="delimiter">: </span><span class="description">maximum safe double-precision floating-point integer.</span> 76 - <span class="signature">[`MAX_SAFE_LUCAS`][@stdlib/constants/float64/max-safe-lucas]</span><span class="delimiter">: </span><span class="description">maximum safe Lucas number when stored in double-precision floating-point format.</span> 77 - <span class="signature">[`MAX_SAFE_NTH_FIBONACCI`][@stdlib/constants/float64/max-safe-nth-fibonacci]</span><span class="delimiter">: </span><span class="description">maximum safe nth Fibonacci number when stored in double-precision floating-point format.</span> 78 - <span class="signature">[`MAX_SAFE_NTH_LUCAS`][@stdlib/constants/float64/max-safe-nth-lucas]</span><span class="delimiter">: </span><span class="description">maximum safe nth Lucas number when stored in double-precision floating-point format.</span> 79 - <span class="signature">[`MAX`][@stdlib/constants/float64/max]</span><span class="delimiter">: </span><span class="description">maximum double-precision floating-point number.</span> 80 - <span class="signature">[`MIN_BASE10_EXPONENT_SUBNORMAL`][@stdlib/constants/float64/min-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a subnormal double-precision floating-point number.</span> 81 - <span class="signature">[`MIN_BASE10_EXPONENT`][@stdlib/constants/float64/min-base10-exponent]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a normal double-precision floating-point number.</span> 82 - <span class="signature">[`MIN_BASE2_EXPONENT_SUBNORMAL`][@stdlib/constants/float64/min-base2-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a subnormal double-precision floating-point number.</span> 83 - <span class="signature">[`MIN_BASE2_EXPONENT`][@stdlib/constants/float64/min-base2-exponent]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a normal double-precision floating-point number.</span> 84 - <span class="signature">[`MIN_LN`][@stdlib/constants/float64/min-ln]</span><span class="delimiter">: </span><span class="description">natural logarithm of the smallest **normalized** double-precision floating-point number.</span> 85 - <span class="signature">[`MIN_SAFE_INTEGER`][@stdlib/constants/float64/min-safe-integer]</span><span class="delimiter">: </span><span class="description">minimum safe double-precision floating-point integer.</span> 86 - <span class="signature">[`NINF`][@stdlib/constants/float64/ninf]</span><span class="delimiter">: </span><span class="description">double-precision floating-point negative infinity.</span> 87 - <span class="signature">[`NUM_BYTES`][@stdlib/constants/float64/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a double-precision floating-point number.</span> 88 - <span class="signature">[`PHI`][@stdlib/constants/float64/phi]</span><span class="delimiter">: </span><span class="description">golden ratio.</span> 89 - <span class="signature">[`PI_SQUARED`][@stdlib/constants/float64/pi-squared]</span><span class="delimiter">: </span><span class="description">π².</span> 90 - <span class="signature">[`PI`][@stdlib/constants/float64/pi]</span><span class="delimiter">: </span><span class="description">the mathematical constant π.</span> 91 - <span class="signature">[`PINF`][@stdlib/constants/float64/pinf]</span><span class="delimiter">: </span><span class="description">double-precision floating-point positive infinity.</span> 92 - <span class="signature">[`PRECISION`][@stdlib/constants/float64/precision]</span><span class="delimiter">: </span><span class="description">effective number of bits in the significand of a double-precision floating-point number.</span> 93 - <span class="signature">[`SMALLEST_NORMAL`][@stdlib/constants/float64/smallest-normal]</span><span class="delimiter">: </span><span class="description">smallest positive **normalized** double-precision floating-point number.</span> 94 - <span class="signature">[`SMALLEST_SUBNORMAL`][@stdlib/constants/float64/smallest-subnormal]</span><span class="delimiter">: </span><span class="description">smallest positive **denormalized** double-precision floating-point number.</span> 95 - <span class="signature">[`SQRT_EPS`][@stdlib/constants/float64/sqrt-eps]</span><span class="delimiter">: </span><span class="description">square root of double-precision floating-point epsilon.</span> 96 - <span class="signature">[`SQRT_HALF_PI`][@stdlib/constants/float64/sqrt-half-pi]</span><span class="delimiter">: </span><span class="description">square root of the mathematical constant π divided by 2.</span> 97 - <span class="signature">[`SQRT_HALF`][@stdlib/constants/float64/sqrt-half]</span><span class="delimiter">: </span><span class="description">square root of `1/2`.</span> 98 - <span class="signature">[`SQRT_PHI`][@stdlib/constants/float64/sqrt-phi]</span><span class="delimiter">: </span><span class="description">square root of the Golden ratio (φ).</span> 99 - <span class="signature">[`SQRT_PI`][@stdlib/constants/float64/sqrt-pi]</span><span class="delimiter">: </span><span class="description">square root of the mathematical constant π.</span> 100 - <span class="signature">[`SQRT_THREE`][@stdlib/constants/float64/sqrt-three]</span><span class="delimiter">: </span><span class="description">square root of `3`.</span> 101 - <span class="signature">[`SQRT_TWO_PI`][@stdlib/constants/float64/sqrt-two-pi]</span><span class="delimiter">: </span><span class="description">square root of the mathematical constant π times 2.</span> 102 - <span class="signature">[`SQRT_TWO`][@stdlib/constants/float64/sqrt-two]</span><span class="delimiter">: </span><span class="description">square root of `2`.</span> 103 - <span class="signature">[`TWO_PI`][@stdlib/constants/float64/two-pi]</span><span class="delimiter">: </span><span class="description">the mathematical constant π times 2.</span> 104 105 </div> 106 107 <!-- </toc> --> 108 109 </section> 110 111 <!-- /.usage --> 112 113 <section class="examples"> 114 115 ## Examples 116 117 <!-- TODO: better examples --> 118 119 <!-- eslint no-undef: "error" --> 120 121 ```javascript 122 var objectKeys = require( '@stdlib/utils/keys' ); 123 var constants = require( '@stdlib/constants/float64' ); 124 125 console.log( objectKeys( constants ) ); 126 ``` 127 128 </section> 129 130 <!-- /.examples --> 131 132 <section class="links"> 133 134 <!-- <toc-links> --> 135 136 [@stdlib/constants/float64/apery]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/apery 137 138 [@stdlib/constants/float64/catalan]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/catalan 139 140 [@stdlib/constants/float64/cbrt-eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/cbrt-eps 141 142 [@stdlib/constants/float64/e]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/e 143 144 [@stdlib/constants/float64/eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/eps 145 146 [@stdlib/constants/float64/eulergamma]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/eulergamma 147 148 [@stdlib/constants/float64/exponent-bias]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/exponent-bias 149 150 [@stdlib/constants/float64/fourth-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/fourth-pi 151 152 [@stdlib/constants/float64/fourth-root-eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/fourth-root-eps 153 154 [@stdlib/constants/float64/gamma-lanczos-g]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/gamma-lanczos-g 155 156 [@stdlib/constants/float64/glaisher-kinkelin]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/glaisher-kinkelin 157 158 [@stdlib/constants/float64/half-ln-two]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/half-ln-two 159 160 [@stdlib/constants/float64/half-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/half-pi 161 162 [@stdlib/constants/float64/high-word-exponent-mask]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/high-word-exponent-mask 163 164 [@stdlib/constants/float64/high-word-significand-mask]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/high-word-significand-mask 165 166 [@stdlib/constants/float64/ln-half]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ln-half 167 168 [@stdlib/constants/float64/ln-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ln-pi 169 170 [@stdlib/constants/float64/ln-sqrt-two-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ln-sqrt-two-pi 171 172 [@stdlib/constants/float64/ln-ten]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ln-ten 173 174 [@stdlib/constants/float64/ln-two-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ln-two-pi 175 176 [@stdlib/constants/float64/ln-two]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ln-two 177 178 [@stdlib/constants/float64/log10-e]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/log10-e 179 180 [@stdlib/constants/float64/log2-e]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/log2-e 181 182 [@stdlib/constants/float64/max-base10-exponent-subnormal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-base10-exponent-subnormal 183 184 [@stdlib/constants/float64/max-base10-exponent]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-base10-exponent 185 186 [@stdlib/constants/float64/max-base2-exponent-subnormal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-base2-exponent-subnormal 187 188 [@stdlib/constants/float64/max-base2-exponent]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-base2-exponent 189 190 [@stdlib/constants/float64/max-ln]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-ln 191 192 [@stdlib/constants/float64/max-safe-fibonacci]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-safe-fibonacci 193 194 [@stdlib/constants/float64/max-safe-integer]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-safe-integer 195 196 [@stdlib/constants/float64/max-safe-lucas]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-safe-lucas 197 198 [@stdlib/constants/float64/max-safe-nth-fibonacci]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-safe-nth-fibonacci 199 200 [@stdlib/constants/float64/max-safe-nth-lucas]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max-safe-nth-lucas 201 202 [@stdlib/constants/float64/max]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/max 203 204 [@stdlib/constants/float64/min-base10-exponent-subnormal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/min-base10-exponent-subnormal 205 206 [@stdlib/constants/float64/min-base10-exponent]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/min-base10-exponent 207 208 [@stdlib/constants/float64/min-base2-exponent-subnormal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/min-base2-exponent-subnormal 209 210 [@stdlib/constants/float64/min-base2-exponent]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/min-base2-exponent 211 212 [@stdlib/constants/float64/min-ln]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/min-ln 213 214 [@stdlib/constants/float64/min-safe-integer]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/min-safe-integer 215 216 [@stdlib/constants/float64/ninf]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/ninf 217 218 [@stdlib/constants/float64/num-bytes]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/num-bytes 219 220 [@stdlib/constants/float64/phi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/phi 221 222 [@stdlib/constants/float64/pi-squared]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/pi-squared 223 224 [@stdlib/constants/float64/pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/pi 225 226 [@stdlib/constants/float64/pinf]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/pinf 227 228 [@stdlib/constants/float64/precision]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/precision 229 230 [@stdlib/constants/float64/smallest-normal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/smallest-normal 231 232 [@stdlib/constants/float64/smallest-subnormal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/smallest-subnormal 233 234 [@stdlib/constants/float64/sqrt-eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-eps 235 236 [@stdlib/constants/float64/sqrt-half-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-half-pi 237 238 [@stdlib/constants/float64/sqrt-half]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-half 239 240 [@stdlib/constants/float64/sqrt-phi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-phi 241 242 [@stdlib/constants/float64/sqrt-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-pi 243 244 [@stdlib/constants/float64/sqrt-three]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-three 245 246 [@stdlib/constants/float64/sqrt-two-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-two-pi 247 248 [@stdlib/constants/float64/sqrt-two]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/sqrt-two 249 250 [@stdlib/constants/float64/two-pi]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float64/two-pi 251 252 <!-- </toc-links> --> 253 254 </section> 255 256 <!-- /.links -->