feat: add constants/float16/abs-mask

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

@@ -0,0 +1,123 @@
+<!--
+
+@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_ABS_MASK
+
+> Mask for excluding the sign bit of a [half-precision floating-point number][ieee754].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var FLOAT16_ABS_MASK = require( '@stdlib/constants/float16/abs-mask' );
+```
+
+#### FLOAT16_ABS_MASK
+
+Mask for excluding the sign bit of a [half-precision floating-point number][ieee754].
+
+```javascript
+// 0x7fff = 32767 => 0 11111 1111111111
+var bool = ( FLOAT16_ABS_MASK === 0x7fff );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+A [half-precision floating-point number][ieee754] has the following format:
+
+```text
+1 11111 1111111111
+```
+
+where the first bit is the sign bit, the next 5 bits are the exponent, and the last 10 bits are the significand (mantissa). The mask `0x7fff` sets the sign bit to `0`, effectively clearing it while preserving all other bits.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT16_ABS_MASK = require( '@stdlib/constants/float16/abs-mask' );
+
+// Example: The bitmask in binary
+console.log( FLOAT16_ABS_MASK.toString( 2 ) );
+// => '111111111111111'
+
+// Example: The bitmask as a decimal
+console.log( FLOAT16_ABS_MASK );
+// => 32767
+
+// Example: The bitmask in hexadecimal
+console.log( '0x' + FLOAT16_ABS_MASK.toString( 16 ) );
+// => '0x7fff'
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/constants/float16/exponent-mask`][@stdlib/constants/float16/exponent-mask]</span><span class="delimiter">: </span><span class="description">mask for the exponent of a half-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/constants/float16/sign-mask`][@stdlib/constants/float16/sign-mask]</span><span class="delimiter">: </span><span class="description">mask for the sign bit of a half-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/constants/float16/significand-mask`][@stdlib/constants/float16/significand-mask]</span><span class="delimiter">: </span><span class="description">mask for the significand of a half-precision floating-point number.</span>
+
+</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> -->
+
+[@stdlib/constants/float16/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/exponent-mask
+
+[@stdlib/constants/float16/sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/sign-mask
+
+[@stdlib/constants/float16/significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/significand-mask
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/abs-mask/docs/repl.txt

@@ -0,0 +1,12 @@
+
+{{alias}}
+    Mask for excluding the sign bit of a half-precision floating-point number.
+
+    Examples
+    --------
+    > {{alias}}
+    32767
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/constants/float16/abs-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 excluding the sign bit of a half-precision floating-point number.
+*
+* @example
+* var val = FLOAT16_ABS_MASK;
+* // returns 32767
+*/
+declare const FLOAT16_ABS_MASK: number;
+
+
+// EXPORTS //
+
+export = FLOAT16_ABS_MASK;

lib/node_modules/@stdlib/constants/float16/abs-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_ABS_MASK = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT16_ABS_MASK; // $ExpectType number
+}

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

@@ -0,0 +1,30 @@
+/**
+* @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 FLOAT16_ABS_MASK = require( './../lib' );
+
+console.log( 'Decimal: ' + FLOAT16_ABS_MASK );
+// => 'Decimal: 32767'
+
+console.log( 'Hexadecimal: 0x' + FLOAT16_ABS_MASK.toString( 16 ) );
+// => 'Hexadecimal: 0x7fff'
+
+console.log( 'Binary: 0b' + FLOAT16_ABS_MASK.toString( 2 ) );
+// => 'Binary: 0b111111111111111'

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

lib/node_modules/@stdlib/constants/float16/abs-mask/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@stdlib/constants/float16/abs-mask",
+  "version": "0.0.0",
+  "description": "Half-precision floating-point absolute value bitmask.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdmath",
+    "constant",
+    "const",
+    "mathematics",
+    "math",
+    "mask",
+    "abs",
+    "absolute",
+    "bitmask",
+    "ieee754",
+    "float",
+    "floating-point",
+    "float16"
+  ]
+}

lib/node_modules/@stdlib/constants/float16/abs-mask/test/test.js

@@ -0,0 +1,43 @@
+/**
+* @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 tape = require( 'tape' );
+var FLOAT16_ABS_MASK = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a number', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof FLOAT16_ABS_MASK, 'number', 'main export is a number' );
+	t.end();
+});
+
+tape( 'the exported value equals 32767', function test( t ) {
+	t.strictEqual( FLOAT16_ABS_MASK, 32767, 'equals 32767' );
+	t.end();
+});
+
+tape( 'the exported value equals 0x7fff', function test( t ) {
+	t.strictEqual( FLOAT16_ABS_MASK, 0x7fff, 'equals 0x7fff' );
+	t.end();
+});