Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/constants-float64-high-word-exponent-mask

High word mask for the exponent of a double-precision floating-point number.
https://github.com/stdlib-js/constants-float64-high-word-exponent-mask

64bit bits const constant exponent float float64 floating-point high ieee754 javascript mask math mathematics node node-js nodejs stdlib word

Last synced: about 1 month ago
JSON representation

High word mask for the exponent of a double-precision floating-point number.

Awesome Lists containing this project

README

        


About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

# FLOAT64_HIGH_WORD_EXPONENT_MASK

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> High word mask for the exponent of a [double-precision floating-point number][ieee754].

## Installation

```bash
npm install @stdlib/constants-float64-high-word-exponent-mask
```

Alternatively,

- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

```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].

```javascript
// 0x7ff00000 = 2146435072 => 0 11111111111 00000000000000000000
var bool = ( FLOAT64_HIGH_WORD_EXPONENT_MASK === 0x7ff00000 );
// returns true
```

## 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.

## Examples

```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 x = 11.5;
var hi = getHighWord( x ); // 0 10000000010 01110000000000000000
// returns 1076297728

// Mask off all bits except for the exponent bits:
var 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
```

* * *

## C APIs

### Usage

```c
#include "stdlib/constants/float64/high_word_exponent_mask.h"
```

#### STDLIB_CONSTANT_FLOAT64_HIGH_WORD_EXPONENT_MASK

Macro for the high word mask for the exponent of a [double-precision floating-point number][ieee754].

* * *

## See Also

- [`@stdlib/constants-float64/high-word-significand-mask`][@stdlib/constants/float64/high-word-significand-mask]: high word mask for the significand of a double-precision floating-point number.

* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/constants-float64-high-word-exponent-mask.svg
[npm-url]: https://npmjs.org/package/@stdlib/constants-float64-high-word-exponent-mask

[test-image]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/constants-float64-high-word-exponent-mask/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/constants-float64-high-word-exponent-mask?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/tree/deno
[deno-readme]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/tree/umd
[umd-readme]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/tree/esm
[esm-readme]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/constants-float64-high-word-exponent-mask/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/constants-float64-high-word-exponent-mask/main/LICENSE

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

[@stdlib/constants/float64/high-word-significand-mask]: https://github.com/stdlib-js/constants-float64-high-word-significand-mask