From 00f3587651908ef49a8a7425137cdbbd7cc0f7ff Mon Sep 17 00:00:00 2001 From: NEERAJ Date: Sun, 7 Dec 2025 17:23:13 +0530 Subject: [PATCH 1/5] feat: adding initial files --- .../constants/float16/min-ln/README.md | 83 +++++++++++++++++++ .../constants/float16/min-ln/docs/repl.txt | 12 +++ .../float16/min-ln/docs/types/index.d.ts | 33 ++++++++ .../float16/min-ln/docs/types/test.ts | 28 +++++++ .../float16/min-ln/examples/index.js | 24 ++++++ .../constants/float16/min-ln/lib/index.js | 55 ++++++++++++ .../constants/float16/min-ln/package.json | 72 ++++++++++++++++ .../constants/float16/min-ln/test/test.js | 43 ++++++++++ 8 files changed, 350 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/README.md create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/package.json create mode 100644 lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/README.md b/lib/node_modules/@stdlib/constants/float16/min-ln/README.md new file mode 100644 index 000000000000..383d47f377f6 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/README.md @@ -0,0 +1,83 @@ + + +# FLOAT16_MIN_LN + +> [Natural logarithm][natural-logarithm] of the smallest **normalized** [half-precision floating-point number][ieee754]. + +
+ +## Usage + +```javascript +var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); +``` + +#### FLOAT32_MIN_LN + +[Natural logarithm][natural-logarithm] of the smallest **normalized** [half-precision floating-point number][ieee754]. + +```javascript +var bool = ( FLOAT16_MIN_LN === -708.5 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); + +console.log( FLOAT16_MIN_LN ); +// => -708.5 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + +[natural-logarithm]: https://en.wikipedia.org/wiki/Natural_logarithm + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt new file mode 100644 index 000000000000..8cc8e592755d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Natural logarithm of the smallest normalized half-precision floating-point + number. + + Examples + -------- + > {{alias}} + -708.5 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts new file mode 100644 index 000000000000..62140d64c736 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/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 + +/** +* Natural logarithm of the smallest normalized half-precision floating-point number. +* +* @example +* var min = FLOAT16_MIN_LN; +* // returns -708.5 +*/ +declare const FLOAT16_MIN_LN: number; + + +// EXPORTS // + +export = FLOAT16_MIN_LN; diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/test.ts new file mode 100644 index 000000000000..aafb7e6df96d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/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_MIN_LN = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_MIN_LN; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js b/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js new file mode 100644 index 000000000000..9a060ef81e26 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js @@ -0,0 +1,24 @@ +/** +* @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_MIN_LN = require( './../lib' ); + +console.log( FLOAT16_MIN_LN ); +// => -708.5 diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js new file mode 100644 index 000000000000..a30c467203d7 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.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'; + +/** +* Natural logarithm of the smallest normalized half-precision floating-point number. +* +* @module @stdlib/constants/float16/min-ln +* @type {number} +* +* @example +* var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); +* // returns -708.5 +*/ + +// MAIN // + +/** +* Natural logarithm of the smallest normalized half-precision floating-point number. +* +* ## Notes +* +* The number has the value +* +* ```tex +* -\ln \left( 2^{127-1} \right) +* ``` +* +* @constant +* @type {number} +* @default -708.5 +* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} +*/ +var FLOAT16_MIN_LN = -708.5; + + +// EXPORTS // + +module.exports = FLOAT16_MIN_LN; diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/package.json b/lib/node_modules/@stdlib/constants/float16/min-ln/package.json new file mode 100644 index 000000000000..65195685db04 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/constants/float16/min-ln", + "version": "0.0.0", + "description": "Natural logarithm of the smallest normalized half-precision floating-point number.", + "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", + "include": "./include", + "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", + "smallest", + "minimum", + "floating-point", + "float16", + "float", + "16bit", + "ieee754", + "flt", + "precision", + "min", + "normalized", + "logarithm", + "log" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js b/lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js new file mode 100644 index 000000000000..9fa7c1887dad --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/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 pow = require( '@stdlib/math/base/special/pow' ); +var ln = require( '@stdlib/math/base/special/ln' ); +var float64ToFloat16 = require( '@stdlib/number/float64/base/to-float16' ); +var SMALLEST_NORMAL = require( '@stdlib/constants/float64/smallest-normal' ); +var FLOAT16_MIN_LN = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_MIN_LN, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a half-precision floating-point number equal to the natural logarithm of the smallest normalized half-precision floating-point number', function test( t ) { + t.strictEqual( FLOAT16_MIN_LN, float64ToFloat16( -ln( pow( 2, 1022 ) ) ), 'returns expected value' ); + t.strictEqual( FLOAT16_MIN_LN, float64ToFloat16( ln( SMALLEST_NORMAL ) ), 'returns expected value' ); + t.end(); +}); From 7c954a05a858c544ae66f0469b43ea16a9a60a56 Mon Sep 17 00:00:00 2001 From: NEERAJ Date: Sun, 7 Dec 2025 17:28:28 +0530 Subject: [PATCH 2/5] chore: clean up --- lib/node_modules/@stdlib/constants/float16/min-ln/package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/package.json b/lib/node_modules/@stdlib/constants/float16/min-ln/package.json index 65195685db04..c3ab6b00df64 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/package.json +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/package.json @@ -17,7 +17,6 @@ "directories": { "doc": "./docs", "example": "./examples", - "include": "./include", "lib": "./lib", "test": "./test" }, From 26a4b03d658986d66e12697a1e9d4b6ecd19ee4b Mon Sep 17 00:00:00 2001 From: NEERAJ Date: Mon, 8 Dec 2025 20:51:43 +0530 Subject: [PATCH 3/5] chore: applying changes from code review --- lib/node_modules/@stdlib/constants/float16/min-ln/README.md | 4 ++-- .../@stdlib/constants/float16/min-ln/docs/repl.txt | 2 +- .../@stdlib/constants/float16/min-ln/docs/types/index.d.ts | 2 +- .../@stdlib/constants/float16/min-ln/examples/index.js | 2 +- .../@stdlib/constants/float16/min-ln/lib/index.js | 6 +++--- .../@stdlib/constants/float16/min-ln/test/test.js | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/README.md b/lib/node_modules/@stdlib/constants/float16/min-ln/README.md index 383d47f377f6..ec651e8e41fe 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/README.md +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/README.md @@ -35,7 +35,7 @@ var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); [Natural logarithm][natural-logarithm] of the smallest **normalized** [half-precision floating-point number][ieee754]. ```javascript -var bool = ( FLOAT16_MIN_LN === -708.5 ); +var bool = ( FLOAT16_MIN_LN === -9.703125 ); // returns true ``` @@ -55,7 +55,7 @@ var bool = ( FLOAT16_MIN_LN === -708.5 ); var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); console.log( FLOAT16_MIN_LN ); -// => -708.5 +// => -9.703125 ``` diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt index 8cc8e592755d..074e8a59eab1 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/repl.txt @@ -6,7 +6,7 @@ Examples -------- > {{alias}} - -708.5 + -9.703125 See Also -------- diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts index 62140d64c736..65e720ce0a54 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/docs/types/index.d.ts @@ -23,7 +23,7 @@ * * @example * var min = FLOAT16_MIN_LN; -* // returns -708.5 +* // returns -9.703125 */ declare const FLOAT16_MIN_LN: number; diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js b/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js index 9a060ef81e26..08a15382579e 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/examples/index.js @@ -21,4 +21,4 @@ var FLOAT16_MIN_LN = require( './../lib' ); console.log( FLOAT16_MIN_LN ); -// => -708.5 +// => -9.703125 diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js index a30c467203d7..bfe83a2ffd57 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js @@ -26,7 +26,7 @@ * * @example * var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); -* // returns -708.5 +* // returns -9.703125 */ // MAIN // @@ -44,10 +44,10 @@ * * @constant * @type {number} -* @default -708.5 +* @default -9.703125 * @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} */ -var FLOAT16_MIN_LN = -708.5; +var FLOAT16_MIN_LN = -9.703125; // EXPORTS // diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js b/lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js index 9fa7c1887dad..1a2eb8253986 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/test/test.js @@ -24,7 +24,7 @@ var tape = require( 'tape' ); var pow = require( '@stdlib/math/base/special/pow' ); var ln = require( '@stdlib/math/base/special/ln' ); var float64ToFloat16 = require( '@stdlib/number/float64/base/to-float16' ); -var SMALLEST_NORMAL = require( '@stdlib/constants/float64/smallest-normal' ); +var SMALLEST_NORMAL = require( '@stdlib/constants/float16/smallest-normal' ); var FLOAT16_MIN_LN = require( './../lib' ); @@ -37,7 +37,7 @@ tape( 'main export is a number', function test( t ) { }); tape( 'export is a half-precision floating-point number equal to the natural logarithm of the smallest normalized half-precision floating-point number', function test( t ) { - t.strictEqual( FLOAT16_MIN_LN, float64ToFloat16( -ln( pow( 2, 1022 ) ) ), 'returns expected value' ); + t.strictEqual( FLOAT16_MIN_LN, float64ToFloat16( -ln( pow( 2, 14 ) ) ), 'returns expected value' ); t.strictEqual( FLOAT16_MIN_LN, float64ToFloat16( ln( SMALLEST_NORMAL ) ), 'returns expected value' ); t.end(); }); From 90787b2f079aefa13fde0c063e516af14a69aa5f Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 8 Dec 2025 17:32:16 -0800 Subject: [PATCH 4/5] docs: fix heading Signed-off-by: Athan --- lib/node_modules/@stdlib/constants/float16/min-ln/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/README.md b/lib/node_modules/@stdlib/constants/float16/min-ln/README.md index ec651e8e41fe..2a633cb64dd6 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/README.md +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/README.md @@ -30,7 +30,7 @@ limitations under the License. var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); ``` -#### FLOAT32_MIN_LN +#### FLOAT16_MIN_LN [Natural logarithm][natural-logarithm] of the smallest **normalized** [half-precision floating-point number][ieee754]. From bcb4fffd10a72b9839dd38475ba2e8dcbd5b678b Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 8 Dec 2025 17:34:03 -0800 Subject: [PATCH 5/5] docs: fix note Signed-off-by: Athan --- lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js index bfe83a2ffd57..b10154399052 100644 --- a/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/lib/index.js @@ -39,7 +39,7 @@ * The number has the value * * ```tex -* -\ln \left( 2^{127-1} \right) +* -\ln \left( 2^{15-1} \right) * ``` * * @constant