https://github.com/stdlib-js/number-float32-base-to-word
Return an unsigned 32-bit integer corresponding to the IEEE 754 binary representation of a single-precision floating-point number.
https://github.com/stdlib-js/number-float32-base-to-word
base bits convert float float32 floating-point javascript node node-js nodejs single stdlib to type types uint32 util utilities utility utils
Last synced: 4 months ago
JSON representation
Return an unsigned 32-bit integer corresponding to the IEEE 754 binary representation of a single-precision floating-point number.
- Host: GitHub
- URL: https://github.com/stdlib-js/number-float32-base-to-word
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T18:06:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T02:49:00.000Z (5 months ago)
- Last Synced: 2024-12-30T03:22:56.964Z (5 months ago)
- Topics: base, bits, convert, float, float32, floating-point, javascript, node, node-js, nodejs, single, stdlib, to, type, types, uint32, util, utilities, utility, utils
- Language: Python
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 599 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!
# toWord
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return an unsigned 32-bit integer corresponding to the [IEEE 754][ieee754] binary representation of a [single-precision floating-point number][ieee754].
## Installation
```bash
npm install @stdlib/number-float32-base-to-word
```
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 toWordf = require( '@stdlib/number-float32-base-to-word' );
```
#### toWordf( x )
Returns an unsigned 32-bit `integer` corresponding to the [IEEE 754][ieee754] binary representation of a [single-precision floating-point number][ieee754].
```javascript
var float64ToFloat32 = require( '@stdlib/number-float64-base-to-float32' );
var f32 = float64ToFloat32( 1.337 );
// returns 1.3370000123977661
var w = toWordf( f32 ); // => 0 01111111 01010110010001011010001
// returns 1068180177
```
## Notes
- The equivalent of this function in C/C++,
```c
unsigned int toWordf(float x) {
return *(unsigned int*)&x;
}
```
## Examples
```javascript
var float64ToFloat32 = require( '@stdlib/number-float64-base-to-float32' );
var randu = require( '@stdlib/random-base-randu' );
var toWordf = require( '@stdlib/number-float32-base-to-word' );
var word;
var f64;
var f32;
var i;
// Convert single-precision floating-point numbers to integers representing the binary literal...
for ( i = 0; i < 1000; i++ ) {
f64 = (randu()*100.0) - 50.0;
f32 = float64ToFloat32( f64 );
word = toWordf( f32 );
console.log( 'float64: %d => float32: %d => word: %d', f64, f32, word );
}
```
* * *
## C APIs
### Usage
```c
#include "stdlib/number/float32/base/to_word.h"
```
#### stdlib_base_float32_to_word( x, \*word )
Converts a [single-precision floating-point number][ieee754] to an unsigned 32-bit integer corresponding to the number's [IEEE 754][ieee754] binary representation.
```c
#include
uint32_t word;
stdlib_base_float32_to_word( 3.14f, &word );
```
The function accepts the following arguments:
- **x**: `[in] float` input value.
- **word**: `[out] uint32_t*` destination.
```c
void stdlib_base_float32_to_word( const float x, uint32_t *word );
```
#### stdlib_base_float32_word_t
An opaque type definition for a union for converting between a [single-precision floating-point number][ieee754] and an unsigned 32-bit integer.
```c
#include
stdlib_base_float32_word_t w;
// Assign a single-precision floating-point number:
w.value = 3.14f;
// Retrieve the word:
uint32_t word = w.word;
```
The union has the following members:
- **value**: `float` [single-precision floating-point number][ieee754].
- **word**: `uint32_t` word.
### Examples
```c
#include "stdlib/number/float32/base/to_word.h"
#include
#include
int main( void ) {
float x[] = { 3.14f, -3.14f, 0.0f, 0.0f/0.0f };
uint32_t word;
int i;
for ( i = 0; i < 4; i++ ) {
stdlib_base_float32_to_word( x[ i ], &word );
printf( "%f => word: %u\n", x[ i ], word );
}
}
```
* * *
## See Also
- [`@stdlib/number-float32/base/from-word`][@stdlib/number/float32/base/from-word]: create a single-precision floating-point number from an unsigned integer corresponding to an IEEE 754 binary representation.
- [`@stdlib/number-float64/base/to-words`][@stdlib/number/float64/base/to-words]: split a double-precision floating-point number into a higher order word and a lower order word.
* * *
## 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/number-float32-base-to-word.svg
[npm-url]: https://npmjs.org/package/@stdlib/number-float32-base-to-word
[test-image]: https://github.com/stdlib-js/number-float32-base-to-word/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/number-float32-base-to-word/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/number-float32-base-to-word/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/number-float32-base-to-word?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/number-float32-base-to-word/tree/deno
[deno-readme]: https://github.com/stdlib-js/number-float32-base-to-word/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/number-float32-base-to-word/tree/umd
[umd-readme]: https://github.com/stdlib-js/number-float32-base-to-word/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/number-float32-base-to-word/tree/esm
[esm-readme]: https://github.com/stdlib-js/number-float32-base-to-word/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/number-float32-base-to-word/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/number-float32-base-to-word/main/LICENSE
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
[@stdlib/number/float32/base/from-word]: https://github.com/stdlib-js/number-float32-base-from-word
[@stdlib/number/float64/base/to-words]: https://github.com/stdlib-js/number-float64-base-to-words