README.md (5796B)
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 > Single-precision floating-point mathematical constants. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var constants = require( '@stdlib/constants/float32' ); 31 ``` 32 33 #### constants 34 35 Single-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">[`CBRT_EPS`][@stdlib/constants/float32/cbrt-eps]</span><span class="delimiter">: </span><span class="description">cube root of single-precision floating-point epsilon.</span> 47 - <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> 48 - <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> 49 - <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> 50 - <span class="signature">[`MAX`][@stdlib/constants/float32/max]</span><span class="delimiter">: </span><span class="description">maximum single-precision floating-point number.</span> 51 - <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> 52 - <span class="signature">[`NINF`][@stdlib/constants/float32/ninf]</span><span class="delimiter">: </span><span class="description">single-precision floating-point negative infinity.</span> 53 - <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> 54 - <span class="signature">[`PINF`][@stdlib/constants/float32/pinf]</span><span class="delimiter">: </span><span class="description">single-precision floating-point positive infinity.</span> 55 - <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> 56 - <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> 57 - <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> 58 - <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> 59 60 </div> 61 62 <!-- </toc> --> 63 64 </section> 65 66 <!-- /.usage --> 67 68 <section class="examples"> 69 70 ## Examples 71 72 <!-- TODO: better examples --> 73 74 <!-- eslint no-undef: "error" --> 75 76 ```javascript 77 var objectKeys = require( '@stdlib/utils/keys' ); 78 var constants = require( '@stdlib/constants/float32' ); 79 80 console.log( objectKeys( constants ) ); 81 ``` 82 83 </section> 84 85 <!-- /.examples --> 86 87 <section class="links"> 88 89 <!-- <toc-links> --> 90 91 [@stdlib/constants/float32/cbrt-eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/cbrt-eps 92 93 [@stdlib/constants/float32/eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/eps 94 95 [@stdlib/constants/float32/exponent-bias]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/exponent-bias 96 97 [@stdlib/constants/float32/max-safe-integer]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/max-safe-integer 98 99 [@stdlib/constants/float32/max]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/max 100 101 [@stdlib/constants/float32/min-safe-integer]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/min-safe-integer 102 103 [@stdlib/constants/float32/ninf]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/ninf 104 105 [@stdlib/constants/float32/num-bytes]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/num-bytes 106 107 [@stdlib/constants/float32/pinf]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/pinf 108 109 [@stdlib/constants/float32/precision]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/precision 110 111 [@stdlib/constants/float32/smallest-normal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/smallest-normal 112 113 [@stdlib/constants/float32/smallest-subnormal]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/smallest-subnormal 114 115 [@stdlib/constants/float32/sqrt-eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float32/sqrt-eps 116 117 <!-- </toc-links> --> 118 119 </section> 120 121 <!-- /.links -->