time-to-botec/squiggle/node_modules/@stdlib/constants/float64/max-base2-exponent/README.md

78 lines
1.6 KiB
Markdown
Raw Normal View History

<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# Maximum Base 2 Exponent
> The maximum biased base 2 exponent for a [double-precision floating-point number][ieee754].
<section class="usage">
## Usage
<!-- eslint-disable id-length -->
```javascript
var FLOAT64_MAX_BASE2_EXPONENT = require( '@stdlib/constants/float64/max-base2-exponent' );
```
#### FLOAT64_MAX_BASE2_EXPONENT
The maximum biased base 2 exponent for a [double-precision floating-point number][ieee754].
<!-- eslint-disable id-length -->
```javascript
var bool = ( FLOAT64_MAX_BASE2_EXPONENT === 1023 );
// returns true
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- TODO: better example -->
<!-- eslint no-undef: "error" -->
<!-- eslint-disable id-length -->
```javascript
var FLOAT64_MAX_BASE2_EXPONENT = require( '@stdlib/constants/float64/max-base2-exponent' );
console.log( FLOAT64_MAX_BASE2_EXPONENT );
// => 1023
```
</section>
<!-- /.examples -->
<section class="links">
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
</section>
<!-- /.links -->