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..2a633cb64dd6 --- /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' ); +``` + +#### FLOAT16_MIN_LN + +[Natural logarithm][natural-logarithm] of the smallest **normalized** [half-precision floating-point number][ieee754]. + +```javascript +var bool = ( FLOAT16_MIN_LN === -9.703125 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_MIN_LN = require( '@stdlib/constants/float16/min-ln' ); + +console.log( FLOAT16_MIN_LN ); +// => -9.703125 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[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..074e8a59eab1 --- /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}} + -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 new file mode 100644 index 000000000000..65e720ce0a54 --- /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 -9.703125 +*/ +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..08a15382579e --- /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 ); +// => -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 new file mode 100644 index 000000000000..b10154399052 --- /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 -9.703125 +*/ + +// MAIN // + +/** +* Natural logarithm of the smallest normalized half-precision floating-point number. +* +* ## Notes +* +* The number has the value +* +* ```tex +* -\ln \left( 2^{15-1} \right) +* ``` +* +* @constant +* @type {number} +* @default -9.703125 +* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} +*/ +var FLOAT16_MIN_LN = -9.703125; + + +// 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..c3ab6b00df64 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min-ln/package.json @@ -0,0 +1,71 @@ +{ + "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", + "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..1a2eb8253986 --- /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/float16/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, 14 ) ) ), 'returns expected value' ); + t.strictEqual( FLOAT16_MIN_LN, float64ToFloat16( ln( SMALLEST_NORMAL ) ), 'returns expected value' ); + t.end(); +});