feat: add number/float16/base/significand

lib/node_modules/@stdlib/number/float16/base/significand/README.md

@@ -0,0 +1,210 @@
+<!--
+
+@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.
+
+-->
+
+# significand
+
+> Return an integer corresponding to the significand of a [half-precision floating-point number][ieee754].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var significand = require( '@stdlib/number/float16/base/significand' );
+```
+
+#### significand( x )
+
+Returns an integer corresponding to the significand of a [half-precision floating-point number][ieee754].
+
+```javascript
+var toFloat16 = require( '@stdlib/number/float64/base/to-float16' );
+
+var s = significand( toFloat16( 3.14 ) ); // => 1001001000
+// returns 584
+
+s = significand( toFloat16( 3.14e-6 ) ); // => 0000110101
+// returns 53
+
+s = significand( toFloat16( -3.14 ) ); // => 1001001000
+// returns 584
+
+s = significand( 0.0 ); // => 0000000000
+// returns 0
+
+s = significand( NaN ); // => 1000000000
+// returns 512
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable @cspell/spellchecker -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var toFloat16 = require( '@stdlib/number/float64/base/to-float16' );
+var significand = require( '@stdlib/number/float16/base/significand' );
+
+var frac;
+var exp;
+var x;
+var s;
+var i;
+
+// Generate random numbers and extract their significands...
+for ( i = 0; i < 100; i++ ) {
+    frac = randu() * 10.0;
+    exp = round( randu()*13.0 ) - 7;
+    x = frac * pow( 10.0, exp );
+    x = toFloat16( x );
+    s = significand( x );
+    console.log( 'x: %d. significand: %d.', x, s );
+}
+```
+
+</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/significand.h"
+```
+
+#### stdlib_base_float16_significand( x )
+
+Returns an integer corresponding to the significand of a [half-precision floating-point number][ieee754].
+
+```c
+#include "stdlib/number/float16/ctor.h"
+#include <stdint.h>
+
+stdlib_float16_t x = stdlib_float16_from_bits( 51648 ); // => -11.5
+int16_t y = stdlib_base_float16_significand( x );
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] stdlib_float16_t` input value.
+
+```c
+int16_t stdlib_base_float16_significand( const stdlib_float16_t 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/float16/base/significand.h"
+#include "stdlib/number/float16/ctor.h"
+#include "stdlib/number/float32/base/to_float16.h"
+#include <stdint.h>
+#include <stdio.h>
+#include <inttypes.h>
+
+int main( void ) {
+    const float x[] = { 4.0f, 0.0f, -0.0f, 1.0f, -1.0f, 3.14f, -3.14f, 1.0e38f, -1.0e38f, 1.0f/0.0f, -1.0f/0.0f, 0.0f/0.0f };
+
+    stdlib_float16_t v;
+    int16_t out;
+    int i;
+    for ( i = 0; i < 12; i++ ) {
+        v = stdlib_base_float32_to_float16( x[ i ] );
+        out = stdlib_base_float16_significand( v );
+        printf( "%f => %" PRId16 "\n", x[ i ], out );
+    }
+}
+```
+
+</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
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.js

@@ -0,0 +1,55 @@
+/**
+* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var toFloat16 = require( '@stdlib/number/float64/base/to-float16' );
+var map = require( '@stdlib/array/base/map' );
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var pkg = require( './../package.json' ).name;
+var significand = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = map( uniform( 100, -5.0e4, 5.0e4 ), naryFunction( toFloat16, 1 ) );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = significand( x[ i%x.length ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/number/float16/base/significand/benchmark/benchmark.native.js

@@ -0,0 +1,64 @@
+/**
+* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var toFloat16 = require( '@stdlib/number/float64/base/to-float16' );
+var map = require( '@stdlib/array/base/map' );
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var significand = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( significand instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = map( uniform( 100, -5.0e4, 5.0e4 ), naryFunction( toFloat16, 1 ) );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = significand( x[ i%x.length ] );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});