diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/README.md b/lib/node_modules/@stdlib/constants/float16/sqrt-half/README.md new file mode 100644 index 000000000000..6732d3b52165 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/README.md @@ -0,0 +1,77 @@ + + +# FLOAT16_SQRT_HALF + +> Square root of `1/2` as a half-precision floating-point number. + +
+ +## Usage + +```javascript +var FLOAT16_SQRT_HALF = require( '@stdlib/constants/float16/sqrt-half' ); +``` + +#### FLOAT16_SQRT_HALF + +Square root of `1/2` as a half-precision floating-point number. + +```javascript +var bool = ( FLOAT16_SQRT_HALF === 0.70703125 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + +```javascript +var FLOAT16_SQRT_HALF = require( '@stdlib/constants/float16/sqrt-half' ); + +console.log( FLOAT16_SQRT_HALF ); +// => 0.70703125 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/repl.txt new file mode 100644 index 000000000000..b549d4548770 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Square root of `1/2` as a half-precision floating-point number. + + Examples + -------- + > {{alias}} + 0.70703125 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/types/index.d.ts new file mode 100644 index 000000000000..29cc9a620ef2 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/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 + +/** +* Square root of `1/2` as a half-precision floating-point number. +* +* @example +* var val = FLOAT16_SQRT_HALF; +* // returns 0.70703125 +*/ +declare const FLOAT16_SQRT_HALF: number; + + +// EXPORTS // + +export = FLOAT16_SQRT_HALF; diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/sqrt-half/docs/types/test.ts new file mode 100644 index 000000000000..e5fc0b975993 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/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_SQRT_HALF = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_SQRT_HALF; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/examples/index.js b/lib/node_modules/@stdlib/constants/float16/sqrt-half/examples/index.js new file mode 100644 index 000000000000..c82431d2acd7 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/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_SQRT_HALF = require( './../lib' ); + +console.log( FLOAT16_SQRT_HALF ); +// => 0.70703125 diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/lib/index.js b/lib/node_modules/@stdlib/constants/float16/sqrt-half/lib/index.js new file mode 100644 index 000000000000..b4e76aacb073 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/lib/index.js @@ -0,0 +1,52 @@ +/** +* @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'; + +/** +* Square root of `1/2` as a half-precision floating-point number. +* +* @module @stdlib/constants/float16/sqrt-half +* @type {number} +* +* @example +* var FLOAT16_SQRT_HALF = require( '@stdlib/constants/float16/sqrt-half' ); +* // returns 0.70703125 +*/ + + +// MAIN // + +/** +* Square root of `1/2` as a half-precision floating-point number. +* +* ```tex +* \sqrt{\frac{1}{2}} +* ``` +* +* @constant +* @type {number} +* @default 0.70703125 +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Square_root_of_2} +*/ +var FLOAT16_SQRT_HALF = 0.70703125; + + +// EXPORTS // + +module.exports = FLOAT16_SQRT_HALF; diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/package.json b/lib/node_modules/@stdlib/constants/float16/sqrt-half/package.json new file mode 100644 index 000000000000..91422beeac7f --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/package.json @@ -0,0 +1,71 @@ +{ + "name": "@stdlib/constants/float16/sqrt-half", + "version": "0.0.0", + "description": "Square root of 1/2 as a 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", + "float", + "real", + "half", + "half-precision", + "floating-point", + "float16", + "16bit", + "16-bit", + "ieee754", + "sqrt", + "square", + "root", + "one-half" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-half/test/test.js b/lib/node_modules/@stdlib/constants/float16/sqrt-half/test/test.js new file mode 100644 index 000000000000..c16d253654a9 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-half/test/test.js @@ -0,0 +1,48 @@ +/** +* @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 abs = require( '@stdlib/math/base/special/abs' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); +var FLOAT16_SQRT_HALF = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_SQRT_HALF, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is a half-precision floating-point number equal to 0.70703125', function test( t ) { + t.strictEqual( FLOAT16_SQRT_HALF, 0.70703125, 'returns expected value' ); + t.end(); +}); + +tape( 'the exported value is close to sqrt(0.5) within float16 precision', function test( t ) { + var expected = sqrt( 0.5 ); + var delta = abs( FLOAT16_SQRT_HALF - expected ); + var tol = 1.0e-3; // float16 tolerance + t.ok( delta <= tol, 'within tolerance. expected: '+expected+'. actual: '+FLOAT16_SQRT_HALF+'. delta: '+delta+'. tol: '+tol+'.' ); + t.end(); +});