time-to-botec/squiggle/node_modules/@stdlib/constants/float64/high-word-exponent-mask/README.md

101 lines
2.3 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.
-->
# Exponent Mask
> High word mask for the exponent of a [double-precision floating-point number][ieee754].
<section class="usage">
## Usage
<!-- eslint-disable id-length -->
```javascript
var FLOAT64_HIGH_WORD_EXPONENT_MASK = require( '@stdlib/constants/float64/high-word-exponent-mask' );
```
#### FLOAT64_HIGH_WORD_EXPONENT_MASK
High word mask for the exponent of a [double-precision floating-point number][ieee754].
<!-- eslint-disable id-length -->
```javascript
// 0x7ff00000 = 2146435072 => 0 11111111111 00000000000000000000
var bool = ( FLOAT64_HIGH_WORD_EXPONENT_MASK === 0x7ff00000 );
// returns true
```
</section>
<!-- /.usage -->
<section class="notes">
## Notes
- The higher order word of a [double-precision floating-point number][ieee754] is a 32-bit integer containing the more significant bits which include the exponent and sign.
</section>
<!-- /.notes -->
<section class="examples">
## Examples
<!-- eslint-disable id-length -->
<!-- eslint no-undef: "error" -->
```javascript
var getHighWord = require( '@stdlib/number/float64/base/get-high-word' );
var FLOAT64_HIGH_WORD_EXPONENT_MASK = require( '@stdlib/constants/float64/high-word-exponent-mask' );
var out;
var hi;
var x;
x = 11.5;
hi = getHighWord( x ); // => 0 10000000010 01110000000000000000
// returns 1076297728
// Mask off all bits except for the exponent bits:
out = hi & FLOAT64_HIGH_WORD_EXPONENT_MASK; // => 0 10000000010 00000000000000000000
// returns 1075838976
// Mask on the exponent bits and leave other bits unchanged:
out = hi | FLOAT64_HIGH_WORD_EXPONENT_MASK; // => 0 11111111111 01110000000000000000
// returns 2146893824
```
</section>
<!-- /.examples -->
<section class="links">
[ieee754]: http://en.wikipedia.org/wiki/IEEE_754-1985
</section>
<!-- /.links -->