Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`83e2790`](https://github.com/stdlib-js/stdlib/commit/83e2790a1e95b65d969b50cbe9da03a7623d98cf) - add float16 dtype support to `ndarray/nans` [(#15251)](https://github.com/stdlib-js/stdlib/pull/15251)
 -   [`a2aaa2b`](https://github.com/stdlib-js/stdlib/commit/a2aaa2b22422a3b5db27fb5ce0b50ba5c0023fe1) - add float16 dtype support to `ndarray/map` [(#15250)](https://github.com/stdlib-js/stdlib/pull/15250)
 -   [`24f7b25`](https://github.com/stdlib-js/stdlib/commit/24f7b25084a90d7d02896ae1086b90b6869a9b15) - add float16 dtype support to `ndarray/filter` [(#15232)](https://github.com/stdlib-js/stdlib/pull/15232)
 -   [`b116ddc`](https://github.com/stdlib-js/stdlib/commit/b116ddc030b397cc478e69e37cec904d41db4fdf) - add float16 dtype support to `ndarray/empty` [(#15181)](https://github.com/stdlib-js/stdlib/pull/15181)
@@ -105,6 +106,7 @@ A total of 4 issues were closed in this release:
 
 <details>
 
+-   [`83e2790`](https://github.com/stdlib-js/stdlib/commit/83e2790a1e95b65d969b50cbe9da03a7623d98cf) - **feat:** add float16 dtype support to `ndarray/nans` [(#15251)](https://github.com/stdlib-js/stdlib/pull/15251) _(by Samarth Kolarkar)_
 -   [`a2aaa2b`](https://github.com/stdlib-js/stdlib/commit/a2aaa2b22422a3b5db27fb5ce0b50ba5c0023fe1) - **feat:** add float16 dtype support to `ndarray/map` [(#15250)](https://github.com/stdlib-js/stdlib/pull/15250) _(by Samarth Kolarkar)_
 -   [`24f7b25`](https://github.com/stdlib-js/stdlib/commit/24f7b25084a90d7d02896ae1086b90b6869a9b15) - **feat:** add float16 dtype support to `ndarray/filter` [(#15232)](https://github.com/stdlib-js/stdlib/pull/15232) _(by Samarth Kolarkar)_
 -   [`b116ddc`](https://github.com/stdlib-js/stdlib/commit/b116ddc030b397cc478e69e37cec904d41db4fdf) - **feat:** add float16 dtype support to `ndarray/empty` [(#15181)](https://github.com/stdlib-js/stdlib/pull/15181) _(by Samarth Kolarkar)_

nans/README.md

@@ -128,6 +128,7 @@ var nans = require( '@stdlib/ndarray/nans' );
 var dt = [
     'float64',
     'float32',
+    'float16',
     'complex128',
     'complex64',
     'generic'

nans/benchmark/benchmark.js

@@ -87,6 +87,26 @@ bench( format( '%s:dtype=float32', pkg ), function benchmark( b ) {
 	b.end();
 });
 
+bench( format( '%s:dtype=float16', pkg ), function benchmark( b ) {
+	var arr;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr = nans( [ 0 ], {
+			'dtype': 'float16'
+		});
+		if ( arr.length !== 0 ) {
+			b.fail( 'should have length 0' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( arr ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
 bench( format( '%s:dtype=complex128', pkg ), function benchmark( b ) {
 	var arr;
 	var i;

nans/benchmark/benchmark.size.float16.js

@@ -0,0 +1,99 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 pow = require( '@stdlib/math/base/special/pow' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var nans = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var opts;
+		var arr;
+		var i;
+
+		opts = {
+			'dtype': 'float16'
+		};
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			arr = nans( [ len ], opts );
+			if ( arr.length !== len ) {
+				b.fail( 'unexpected length' );
+			}
+		}
+		b.toc();
+		if ( !isndarrayLike( arr ) ) {
+			b.fail( 'should return an ndarray' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:dtype=float16,size=%d', pkg, len ), f );
+	}
+}
+
+main();

nans/docs/types/index.d.ts

@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Shape, Order, Mode, typedndarray, float64ndarray, float32ndarray, genericndarray, complex128ndarray, complex64ndarray, FloatingPointAndGenericDataType, Float64DataType, Float32DataType, Complex128DataType, Complex64DataType, GenericDataType } from '@stdlib/types/ndarray';
+import { Shape, Order, Mode, typedndarray, float64ndarray, float32ndarray, float16ndarray, genericndarray, complex128ndarray, complex64ndarray, FloatingPointAndGenericDataType, Float64DataType, Float32DataType, Float16DataType, Complex128DataType, Complex64DataType, GenericDataType } from '@stdlib/types/ndarray';
 
 /**
 * Interface describing function options.
@@ -79,6 +79,20 @@ interface Float32Options extends Options {
 	dtype: Float32DataType;
 }
 
+/**
+* Interface describing function options.
+*/
+interface Float16Options extends Options {
+	/**
+	* Underlying data type.
+	*
+	* ## Notes
+	*
+	* -   This option overrides the input array's inferred data type.
+	*/
+	dtype: Float16DataType;
+}
+
 /**
 * Interface describing function options.
 */
@@ -193,6 +207,35 @@ declare function nans( shape: Shape | number, options: Float64Options ): float64
 */
 declare function nans( shape: Shape | number, options: Float32Options ): float32ndarray;
 
+/**
+* Creates a NaN-filled ndarray having a specified shape and data type.
+*
+* @param shape - array shape
+* @param options - options
+* @param options.dtype - underlying data type
+* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major')
+* @param options.mode - specifies how to handle a linear index which exceeds array dimensions
+* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
+* @param options.readonly - boolean indicating whether an array should be read-only
+* @returns NaN-filled ndarray
+*
+* @example
+* var getShape = require( '@stdlib/ndarray/shape' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
+*
+* var arr = nans( [ 2, 2 ], {
+*     'dtype': 'float16'
+* });
+* // returns <ndarray>[ [ NaN, NaN ], [ NaN, NaN ] ]
+*
+* var sh = getShape( arr );
+* // returns [ 2, 2 ]
+*
+* var dt = String( getDType( arr ) );
+* // returns 'float16'
+*/
+declare function nans( shape: Shape | number, options: Float16Options ): float16ndarray;
+
 /**
 * Creates a NaN-filled ndarray having a specified shape and data type.
 *

nans/docs/types/test.ts

@@ -27,6 +27,7 @@ import nans = require( './index' );
 
 	nans( [ 2, 2 ], { 'dtype': 'float64' } ); // $ExpectType float64ndarray
 	nans( [ 2, 2 ], { 'dtype': 'float32' } ); // $ExpectType float32ndarray
+	nans( [ 2, 2 ], { 'dtype': 'float16' } ); // $ExpectType float16ndarray
 	nans( [ 2, 2 ], { 'dtype': 'complex128' } ); // $ExpectType complex128ndarray
 	nans( [ 2, 2 ], { 'dtype': 'complex64' } ); // $ExpectType complex64ndarray
 	nans( [ 2, 2 ], { 'dtype': 'generic' } ); // $ExpectType genericndarray<number>

nans/examples/index.js

@@ -25,6 +25,7 @@ var nans = require( './../lib' );
 var dt = [
 	'float64',
 	'float32',
+	'float16',
 	'complex128',
 	'complex64',
 	'generic'

nans/test/test.js

@@ -24,10 +24,12 @@ var tape = require( 'tape' );
 var isSameArray = require( '@stdlib/assert/is-same-array' );
 var isSameFloat64Array = require( '@stdlib/assert/is-same-float64array' );
 var isSameFloat32Array = require( '@stdlib/assert/is-same-float32array' );
+var isSameFloat16Array = require( '@stdlib/assert/is-same-float16array' );
 var isSameComplex128Array = require( '@stdlib/assert/is-same-complex128array' );
 var isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' );
 var Float64Array = require( '@stdlib/array/float64' );
 var Float32Array = require( '@stdlib/array/float32' );
+var Float16Array = require( '@stdlib/array/float16' );
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex128Array = require( '@stdlib/array/complex128' );
 var instanceOf = require( '@stdlib/assert/instance-of' );
@@ -462,6 +464,48 @@ tape( 'the function returns a NaN-filled array (dtype=float32, order=column-majo
 	t.end();
 });
 
+tape( 'the function returns a NaN-filled array (dtype=float16, order=row-major)', function test( t ) {
+	var expected;
+	var opts;
+	var arr;
+
+	expected = new Float16Array( [ NaN, NaN, NaN, NaN ] );
+
+	opts = {
+		'dtype': 'float16',
+		'order': 'row-major'
+	};
+	arr = nans( [ 2, 2 ], opts );
+	t.strictEqual( instanceOf( arr, ndarray ), true, 'returns expected value' );
+	t.strictEqual( String( getDType( arr ) ), opts.dtype, 'returns expected value' );
+	t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' );
+	t.strictEqual( isSameFloat16Array( getData( arr ), expected ), true, 'returns expected value' );
+	t.strictEqual( getOrder( arr ), opts.order, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'the function returns a NaN-filled array (dtype=float16, order=column-major)', function test( t ) {
+	var expected;
+	var opts;
+	var arr;
+
+	expected = new Float16Array( [ NaN, NaN, NaN, NaN ] );
+
+	opts = {
+		'dtype': 'float16',
+		'order': 'column-major'
+	};
+	arr = nans( [ 2, 2 ], opts );
+	t.strictEqual( instanceOf( arr, ndarray ), true, 'returns expected value' );
+	t.strictEqual( String( getDType( arr ) ), opts.dtype, 'returns expected value' );
+	t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' );
+	t.strictEqual( isSameFloat16Array( getData( arr ), expected ), true, 'returns expected value' );
+	t.strictEqual( getOrder( arr ), opts.order, 'returns expected value' );
+
+	t.end();
+});
+
 tape( 'the function returns a NaN-filled array (dtype=complex128, order=row-major)', function test( t ) {
 	var expected;
 	var opts;