feat: add constants/float16/significand-mask

lib/node_modules/@stdlib/constants/float16/significand-mask/README.md

@@ -0,0 +1,158 @@
+<!--
+
+@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.
+
+-->
+
+# FLOAT16_SIGNIFICAND_MASK
+
+> Mask for the significand of a [half-precision floating-point number][ieee754].
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var FLOAT16_SIGNIFICAND_MASK = require( '@stdlib/constants/float16/significand-mask' );
+```
+
+#### FLOAT16_SIGNIFICAND_MASK
+
+Mask for the significand of a [half-precision floating-point number][ieee754].
+
+<!-- eslint-disable id-length -->
+
+```javascript
+// 0x03ff = 1023 => 0 00000 1111111111
+var bool = ( FLOAT16_SIGNIFICAND_MASK === 0x03ff );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var toWord = require( '@stdlib/number/float16/base/to-word' );
+var FLOAT16_SIGNIFICAND_MASK = require( '@stdlib/constants/float16/significand-mask' );
+
+var x = 11.5;
+var w = toWord( x ); // 0 10010 0111000000
+// returns 18880
+
+// Mask off all bits except for the significand bits:
+var out = w & FLOAT16_SIGNIFICAND_MASK; // 0 00000 0111000000
+// returns 448
+
+// Mask on the significand bits and leave other bits unchanged:
+out = w | FLOAT16_SIGNIFICAND_MASK; // 0 10010 1111111111
+// returns 19455
+```
+
+</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/constants/float16/significand_mask.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT16_SIGNIFICAND_MASK
+
+Macro for the mask for the significand of a [half-precision floating-point number][ieee754].
+
+</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">
+
+</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/constants/float16/significand-mask/docs/repl.txt

@@ -0,0 +1,14 @@
+
+{{alias}}
+    Mask for the significand of a half-precision floating-point number.
+
+    Examples
+    --------
+    > {{alias}}
+    1023
+    > {{alias:@stdlib/number/uint16/base/to-binary-string}}( {{alias}} )
+    '0000001111111111'
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/constants/float16/significand-mask/docs/types/index.d.ts

@@ -0,0 +1,33 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Mask for the significand of a half-precision floating-point number.
+*
+* @example
+* var mask = FLOAT16_SIGNIFICAND_MASK;
+* // returns 1023
+*/
+declare const FLOAT16_SIGNIFICAND_MASK: number;
+
+
+// EXPORTS //
+
+export = FLOAT16_SIGNIFICAND_MASK;

lib/node_modules/@stdlib/constants/float16/significand-mask/docs/types/test.ts

@@ -0,0 +1,28 @@
+/*
+* @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.
+*/
+
+import FLOAT16_SIGNIFICAND_MASK = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT16_SIGNIFICAND_MASK; // $ExpectType number
+}

lib/node_modules/@stdlib/constants/float16/significand-mask/examples/index.js

@@ -0,0 +1,33 @@
+/**
+* @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';
+
+var toWord = require( '@stdlib/number/float16/base/to-word' );
+var toBinaryString = require( '@stdlib/number/uint16/base/to-binary-string' );
+var FLOAT16_SIGNIFICAND_MASK = require( './../lib' );
+
+var x = 11.5;
+var w = toWord( x );
+console.log( 'Word: %s', toBinaryString( w ) );
+
+var out = w & FLOAT16_SIGNIFICAND_MASK;
+console.log( 'Isolate significand bits: %s', toBinaryString( out ) );
+
+out = w | FLOAT16_SIGNIFICAND_MASK;
+console.log( 'Turn on significand bits: %s', toBinaryString( out ) );

lib/node_modules/@stdlib/constants/float16/significand-mask/include/stdlib/constants/float16/significand_mask.h

@@ -0,0 +1,27 @@
+/**
+* @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.
+*/
+
+#ifndef STDLIB_CONSTANTS_FLOAT16_SIGNIFICAND_MASK_H
+#define STDLIB_CONSTANTS_FLOAT16_SIGNIFICAND_MASK_H
+
+/**
+* Macro for the mask for the significand of a half-precision floating-point number.
+*/
+#define STDLIB_CONSTANT_FLOAT16_SIGNIFICAND_MASK 0x03ff
+
+#endif // !STDLIB_CONSTANTS_FLOAT16_SIGNIFICAND_MASK_H

lib/node_modules/@stdlib/constants/float16/significand-mask/lib/index.js

@@ -0,0 +1,56 @@
+/**
+* @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';
+
+/**
+* Mask for the significand of a half-precision floating-point number.
+*
+* @module @stdlib/constants/float16/significand-mask
+* @type {uinteger16}
+*
+* @example
+* var FLOAT16_SIGNIFICAND_MASK = require( '@stdlib/constants/float16/significand-mask' );
+* // returns 1023
+*/
+
+
+// MAIN //
+
+/**
+* Mask for the significand of a half-precision floating-point number.
+*
+* ## Notes
+*
+* The mask for the significand of a half-precision floating-point number is an unsigned 16-bit integer with the value \\( 1023 \\), which corresponds to the bit sequence
+*
+* ```binarystring
+* 0 00000 1111111111
+* ```
+*
+* @constant
+* @type {uinteger16}
+* @default 0x03ff
+* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
+*/
+var FLOAT16_SIGNIFICAND_MASK = 0x03ff;
+
+
+// EXPORTS //
+
+module.exports = FLOAT16_SIGNIFICAND_MASK;

lib/node_modules/@stdlib/constants/float16/significand-mask/manifest.json

@@ -0,0 +1,36 @@
+{
+  "options": {},
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "src": [],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": []
+    }
+  ]
+}