README.md (1628B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 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 # Maximum Base 2 Exponent 22 23 > The maximum biased base 2 exponent for a [double-precision floating-point number][ieee754]. 24 25 <section class="usage"> 26 27 ## Usage 28 29 <!-- eslint-disable id-length --> 30 31 ```javascript 32 var FLOAT64_MAX_BASE2_EXPONENT = require( '@stdlib/constants/float64/max-base2-exponent' ); 33 ``` 34 35 #### FLOAT64_MAX_BASE2_EXPONENT 36 37 The maximum biased base 2 exponent for a [double-precision floating-point number][ieee754]. 38 39 <!-- eslint-disable id-length --> 40 41 ```javascript 42 var bool = ( FLOAT64_MAX_BASE2_EXPONENT === 1023 ); 43 // returns true 44 ``` 45 46 </section> 47 48 <!-- /.usage --> 49 50 <section class="examples"> 51 52 ## Examples 53 54 <!-- TODO: better example --> 55 56 <!-- eslint no-undef: "error" --> 57 58 <!-- eslint-disable id-length --> 59 60 ```javascript 61 var FLOAT64_MAX_BASE2_EXPONENT = require( '@stdlib/constants/float64/max-base2-exponent' ); 62 63 console.log( FLOAT64_MAX_BASE2_EXPONENT ); 64 // => 1023 65 ``` 66 67 </section> 68 69 <!-- /.examples --> 70 71 <section class="links"> 72 73 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 74 75 </section> 76 77 <!-- /.links -->