diff --git a/lib/node_modules/@stdlib/constants/float16/min/README.md b/lib/node_modules/@stdlib/constants/float16/min/README.md new file mode 100644 index 000000000000..65b8241c9292 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/README.md @@ -0,0 +1,96 @@ + + +# Min Value + +> Minimum [half-precision floating-point number][half-precision-floating-point-format]. + +
+ +## Usage + +```javascript +var FLOAT16_MIN = require( '@stdlib/constants/float16/min' ); +``` + +#### FLOAT16_MIN + +Minimum [half-precision floating-point number][half-precision-floating-point-format]. + +```javascript +var bool = (FLOAT16_MIN === 6.103515625e-05 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_MIN = require( '@stdlib/constants/float16/min' ); + +console.log( FLOAT16_MIN ); +// => 6.103515625e-05 +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/constants/float16/min/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/min/docs/repl.txt new file mode 100644 index 000000000000..42fa401cfa2d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Minimum half-precision floating-point number. + + Examples + -------- + > {{alias}} + 6.103515625e-05 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/min/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/min/docs/types/index.d.ts new file mode 100644 index 000000000000..1dcf65f715e2 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/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 + +/** +* Minimum half-precision floating-point number. +* +* @example +* var min = FLOAT16_MIN; +* // returns 6.103515625e-05 +*/ +declare const FLOAT16_MIN: number; + + +// EXPORTS // + +export = FLOAT16_MIN; diff --git a/lib/node_modules/@stdlib/constants/float16/min/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/min/docs/types/test.ts new file mode 100644 index 000000000000..9d6bd5199686 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/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 = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_MIN; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/min/examples/index.js b/lib/node_modules/@stdlib/constants/float16/min/examples/index.js new file mode 100644 index 000000000000..0a0382daa5f4 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/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 = require( './../lib' ); + +console.log( FLOAT16_MIN ); +// => 6.103515625e-05 diff --git a/lib/node_modules/@stdlib/constants/float16/min/lib/index.js b/lib/node_modules/@stdlib/constants/float16/min/lib/index.js new file mode 100644 index 000000000000..f139ff3c24b1 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/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'; + +/** +* Minimum half-precision floating-point number. +* +* @module @stdlib/constants/float16/min +* @type {number} +* +* @example +* var FLOAT16_MIN = require( '@stdlib/constants/float16/min' ); +* // returns 6.103515625e-05 +*/ + + +// MAIN // + +/** +* The minimum half-precision floating-point number. +* +* ## Notes +* +* The minimum is given by +* +* ```tex +* 2^{-14} +* ``` +* +* @constant +* @type {number} +* @default 6.103515625e-05 +* @see [half-precision floating-point form]{@link https://en.wikipedia.org/wiki/Half-precision_floating-point_format} +*/ +var FLOAT16_MIN = 6.103515625e-05; + + +// EXPORTS // + +module.exports = FLOAT16_MIN; diff --git a/lib/node_modules/@stdlib/constants/float16/min/package.json b/lib/node_modules/@stdlib/constants/float16/min/package.json new file mode 100644 index 000000000000..31356bfae5cc --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/constants/float16/min", + "version": "0.0.0", + "description": "Minimum 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", + "min", + "minimum", + "floating-point", + "float16", + "float", + "16bit", + "16-bit", + "ieee754", + "half", + "precision", + "largest", + "greatest" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/min/test/test.js b/lib/node_modules/@stdlib/constants/float16/min/test/test.js new file mode 100644 index 000000000000..77e446810067 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/min/test/test.js @@ -0,0 +1,39 @@ +/** +* @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 FLOAT16_MIN = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_MIN, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is equal to the minimum half-precision floating-point number', function test( t ) { + t.strictEqual( FLOAT16_MIN, pow(2, -14), 'returns expected value' ); + t.end(); +});