npm package: @stdlib/number-float16-base-to-word
Description: Return an unsigned 16-bit integer corresponding to the IEEE 754 binary representation of a half-precision floating-point number.
Author: The Stdlib Authors
Latest version: 0.1.1

<!--

@license Apache-2.0

Copyright (c) 2025 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.

-->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>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.</p>
  <p>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.</p>
  <p>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.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# toWord

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

> Return an unsigned 16-bit integer corresponding to the [IEEE 754][ieee754] binary representation of a [half-precision floating-point number][ieee754].

<section class="installation">

## Installation

```bash
npm install @stdlib/number-float16-base-to-word
```

</section>

<section class="usage">

## Usage

```javascript
var toWord = require( '@stdlib/number-float16-base-to-word' );
```

#### toWord( x )

Returns an unsigned 16-bit integer corresponding to the [IEEE 754][ieee754] binary representation of a [half-precision floating-point number][ieee754].

```javascript
var float64ToFloat16 = require( '@stdlib/number-float64-base-to-float16' );

var f16 = float64ToFloat16( 1.05 );
// returns 1.0498046875

var w = toWord( f16 ); // => 0 01111 0000110011
// returns 15411
```

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var float64ToFloat16 = require( '@stdlib/number-float64-base-to-float16' );
var uniform = require( '@stdlib/random-array-uniform' );
var map = require( '@stdlib/array-base-map' );
var naryFunction = require( '@stdlib/utils-nary-function' );
var pickArguments = require( '@stdlib/utils-pick-arguments' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var toWord = require( '@stdlib/number-float16-base-to-word' );

// Generate an array of random double-precision floating-point numbers:
var f64 = uniform( 1000, -50.0, 50.0 );

// Convert each value to a half-precision floating-point number:
var f16 = map( f64, naryFunction( float64ToFloat16, 1 ) );

// Convert half-precision floating-point numbers to integers representing the binary literal:
logEachMap( 'float64: %f => float16: %f => word: %d', f64, f16, pickArguments( toWord, [ 1 ] ) );
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/number/float16/base/to_word.h"
```

#### stdlib_base_float16_to_word( x, \*word )

Converts a [half-precision floating-point number][ieee754] to an unsigned 16-bit integer corresponding to the number's [IEEE 754][ieee754] binary representation.

```c
#include "stdlib/number/float16/ctor.h"
#include <stdint.h>

uint16_t word;

stdlib_float16_t x = stdlib_float16_from_bits( 51648 ); // => -11.5
stdlib_base_float16_to_word( x, &word );
```

The function accepts the following arguments:

-   **x**: `[in] stdlib_float16_t` input value.
-   **word**: `[out] uint16_t*` destination.

```c
void stdlib_base_float16_to_word( const stdlib_float16_t x, uint16_t *word );
```

#### stdlib_base_float16_word_t

An opaque type definition for a union for converting between a [half-precision floating-point number][ieee754] and an unsigned 16-bit integer.

```c
#include "stdlib/number/float16/ctor.h"
#include <stdint.h>

stdlib_base_float16_word_t w;

// Assign a half-precision floating-point number:
w.value = stdlib_float16_from_bits( 51648 ); // => -11.5

// Retrieve the word:
uint16_t word = w.word;
```

The union has the following members:

-   **value**: `stdlib_float16_t` [half-precision floating-point number][ieee754].
-   **word**: `uint16_t` word.

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/number/float64/base/to_float16.h"
#include "stdlib/number/float16/base/to_word.h"
#include <stdint.h>
#include <stdio.h>

int main( void ) {
    const double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 };

    stdlib_float16_t v;
    uint16_t word;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = stdlib_base_float64_to_float16( x[ i ] );
        stdlib_base_float16_to_word( v, &word );
        printf( "%lf => word: %u\n", x[ i ], word );
    }
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->


<section class="main-repo" >

* * *

## 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 &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[npm-image]: http://img.shields.io/npm/v/@stdlib/number-float16-base-to-word.svg
[npm-url]: https://npmjs.org/package/@stdlib/number-float16-base-to-word

[test-image]: https://github.com/stdlib-js/number-float16-base-to-word/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/number-float16-base-to-word/actions/workflows/test.yml?query=branch:v0.1.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/number-float16-base-to-word/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/number-float16-base-to-word?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/number-float16-base-to-word.svg
[dependencies-url]: https://david-dm.org/stdlib-js/number-float16-base-to-word/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[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-float16-base-to-word/tree/deno
[deno-readme]: https://github.com/stdlib-js/number-float16-base-to-word/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/number-float16-base-to-word/tree/umd
[umd-readme]: https://github.com/stdlib-js/number-float16-base-to-word/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/number-float16-base-to-word/tree/esm
[esm-readme]: https://github.com/stdlib-js/number-float16-base-to-word/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/number-float16-base-to-word/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/number-float16-base-to-word/main/LICENSE

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

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->