feat: add number/float32/base/to-float16

lib/node_modules/@stdlib/number/float32/base/to-float16/README.md

@@ -0,0 +1,195 @@
+<!--
+
+@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.
+
+-->
+
+# toFloat16
+
+> Convert a [single-precision floating-point number][ieee754] to the nearest [half-precision floating-point number][half-precision-floating-point-format].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var float32ToFloat16 = require( '@stdlib/number/float32/base/to-float16' );
+```
+
+#### float32ToFloat16( x )
+
+Converts a [single-precision floating-point number][ieee754] to the nearest [half-precision floating-point number][ieee754].
+
+```javascript
+var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
+
+var y = float32ToFloat16( float64ToFloat32( 1.337 ) );
+// returns 1.3369140625
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   This function may be used as a polyfill for the ES2025 built-in [`Math.f16round`][math-f16round].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
+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 float32ToFloat16 = require( '@stdlib/number/float32/base/to-float16' );
+
+// Generate an array of random numbers:
+var f64 = uniform( 100, 0.0, 100.0 );
+
+// Convert each value to a single-precision floating-point number:
+var f32 = map( f64, naryFunction( float64ToFloat32, 1 ) );
+
+// Convert each single-precision floating-point number to the nearest half-precision floating-point number:
+logEachMap( 'float64: %f => float32: %f => float16: %f', f64, f32, pickArguments( float32ToFloat16, [ 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/float32/base/to_float16.h"
+```
+
+#### stdlib_base_float32_to_float16( x )
+
+Converts a [single-precision floating-point number][ieee754] to the nearest [half-precision floating-point number][ieee754].
+
+```c
+#include "stdlib/number/float16/ctor.h"
+
+stdlib_float16_t x = stdlib_base_float32_to_float16( 3.14f );
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] float` input value.
+
+```c
+stdlib_float16_t stdlib_base_float32_to_float16( const float x );
+```
+
+</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/float32/base/to_float16.h"
+#include "stdlib/number/float16/ctor.h"
+#include <stdint.h>
+#include <stdio.h>
+
+int main( void ) {
+    float x[] = { 3.14f, -3.14f, 0.0f, 0.0f/0.0f };
+
+    stdlib_float16_t x;
+    int i;
+    for ( i = 0; i < 4; i++ ) {
+        x = stdlib_base_float32_to_float16( x[ i ] );
+        printf( "%f => uint16: %u\n", x[ i ], x.bits );
+    }
+}
+```
+
+</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="links">
+
+[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
+
+[half-precision-floating-point-format]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
+
+[math-f16round]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/f16round
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/number/float32/base/to-float16/benchmark/benchmark.js

@@ -0,0 +1,110 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pkg = require( './../package.json' ).name;
+var float32ToFloat16 = require( './../lib' );
+var polyfill = require( './../lib/polyfill.js' );
+
+
+// VARIABLES //
+
+var opts = {
+	'skip': ( typeof Math.f16round === 'undefined' ) // eslint-disable-line stdlib/no-builtin-math
+};
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -5.0e4, 5.0e4, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = float32ToFloat16( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::polyfill', function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -5.0e4, 5.0e4, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = polyfill( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::builtin', opts, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -5.0e4, 5.0e4, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = Math.f16round( x[ i%x.length ] ); // eslint-disable-line stdlib/no-builtin-math
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/number/float32/base/to-float16/benchmark/benchmark.native.js

@@ -0,0 +1,63 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var float32ToFloat16 = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( float32ToFloat16 instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -5.0e4, 5.0e4, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = float32ToFloat16( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});