From 4a787f165cf881148149d80320332482c9e81fd1 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 12 Dec 2025 13:01:26 +0530 Subject: [PATCH 1/4] feat: add constants/float16/sqrt-three --- .../constants/float16/sqrt-three/README.md | 99 +++++++++++++++++++ .../float16/sqrt-three/docs/repl.txt | 12 +++ .../float16/sqrt-three/docs/types/index.d.ts | 33 +++++++ .../float16/sqrt-three/docs/types/test.ts | 28 ++++++ .../float16/sqrt-three/examples/index.js | 24 +++++ .../constants/float16/sqrt-three/lib/index.js | 51 ++++++++++ .../constants/float16/sqrt-three/package.json | 70 +++++++++++++ .../constants/float16/sqrt-three/test/test.js | 38 +++++++ 8 files changed, 355 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json create mode 100644 lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md b/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md new file mode 100644 index 000000000000..c2ad50537f94 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md @@ -0,0 +1,99 @@ + + +# FLOAT16_SQRT3 + +> [Square root][@stdlib/math/base/special/sqrt] of `3` as a half-precision floating-point number. + +
+ +## Usage + +```javascript +var FLOAT16_SQRT3 = require( '@stdlib/constants/float16/sqrt-three' ); +``` + +#### FLOAT16_SQRT3 + +[Square root][@stdlib/math/base/special/sqrt] of `3` as a half-precision floating-point number. + +```javascript +var bool = ( FLOAT16_SQRT3 === 1.732421875 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_SQRT3 = require( '@stdlib/constants/float16/sqrt-three' ); + +console.log( FLOAT16_SQRT3 ); +// => 1.732421875 +``` + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/constants/float16/sqrt-eps`][@stdlib/constants/float16/sqrt-eps]: square root of half-precision floating-point epsilon. +- [`@stdlib/constants/float32/sqrt-three`][@stdlib/constants/float32/sqrt-three]: square root of `3` as a single-precision floating-point number. +- [`@stdlib/constants/float64/sqrt-three`][@stdlib/constants/float64/sqrt-three]: square root of 3. + +
+ + + + + +
+ +[@stdlib/math/base/special/sqrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sqrt + + + +[@stdlib/constants/float16/sqrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/sqrt-eps + +[@stdlib/constants/float32/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-three + +[@stdlib/constants/float64/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/sqrt-three + + + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt new file mode 100644 index 000000000000..e25e28210307 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Square root of `3` as a half-precision floating-point number. + + Examples + -------- + > {{alias}} + 1.732421875 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts new file mode 100644 index 000000000000..655bef0ed3e2 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts @@ -0,0 +1,33 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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 `3` as a half-precision floating-point number. +* +* @example +* var val = FLOAT16_SQRT3; +* // returns 1.732421875 +*/ +declare const FLOAT16_SQRT3: number; + + +// EXPORTS // + +export = FLOAT16_SQRT3; diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts new file mode 100644 index 000000000000..dd52452cea3b --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts @@ -0,0 +1,28 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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_SQRT3 = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_SQRT3; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js b/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js new file mode 100644 index 000000000000..2a51eb72d968 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js @@ -0,0 +1,24 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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_SQRT3 = require( './../lib' ); + +console.log( FLOAT16_SQRT3 ); +// => 1.732421875 diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js b/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js new file mode 100644 index 000000000000..6e22d3fcf45f --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js @@ -0,0 +1,51 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 `3` as a half-precision floating-point number. +* +* @module @stdlib/constants/float16/sqrt-three +* @type {number} +* +* @example +* var FLOAT16_SQRT3 = require( '@stdlib/constants/float16/sqrt-three' ); +* // returns 1.732421875 +*/ + + +// MAIN // + +/** +* Square root of `3` as a half-precision floating-point number. +* +* ```tex +* \sqrt{3} +* ``` +* +* @constant +* @type {number} +* @default 1.732421875 +*/ +var FLOAT16_SQRT3 = 1.732421875; + + +// EXPORTS // + +module.exports = FLOAT16_SQRT3; diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json b/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json new file mode 100644 index 000000000000..2908feb94e61 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/constants/float16/sqrt-three", + "version": "0.0.0", + "description": "Square root of 3 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", + "sqrt", + "square", + "root", + "three", + "sqrt3", + "ieee754", + "half", + "half-precision", + "floating-point", + "float16", + "16bit", + "16-bit" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js b/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js new file mode 100644 index 000000000000..a900fa07bead --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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_SQRT3 = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_SQRT3, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is a half-precision floating-point number equal to the square root of 3', function test( t ) { + t.strictEqual( FLOAT16_SQRT3, 1.732421875, 'returns expected value' ); + t.end(); +}); From 1c3c80ede47a68ff53febb6a461e591b4250ec1b Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 12 Dec 2025 13:23:01 +0530 Subject: [PATCH 2/4] fix: update copyright year --- lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md | 2 +- .../@stdlib/constants/float16/sqrt-three/docs/repl.txt | 2 ++ .../@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts | 2 +- .../@stdlib/constants/float16/sqrt-three/docs/types/test.ts | 2 +- .../@stdlib/constants/float16/sqrt-three/examples/index.js | 2 +- .../@stdlib/constants/float16/sqrt-three/lib/index.js | 2 +- .../@stdlib/constants/float16/sqrt-three/package.json | 1 + .../@stdlib/constants/float16/sqrt-three/test/test.js | 2 +- 8 files changed, 9 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md b/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md index c2ad50537f94..82bea328c8cd 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2024 The Stdlib Authors. +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. diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt index e25e28210307..db48477ea27a 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt @@ -2,11 +2,13 @@ {{alias}} Square root of `3` as a half-precision floating-point number. + Examples -------- > {{alias}} 1.732421875 + See Also -------- diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts index 655bef0ed3e2..0e48ec773818 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts index dd52452cea3b..e2b3cd0650fe 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js b/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js index 2a51eb72d968..dbd9a5d2e02e 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js b/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js index 6e22d3fcf45f..2a967f4b2ba9 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json b/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json index 2908feb94e61..22c3de423145 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json @@ -1,4 +1,5 @@ { + "_comment": "Copyright (c) 2025 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0).", "name": "@stdlib/constants/float16/sqrt-three", "version": "0.0.0", "description": "Square root of 3 as a half-precision floating-point number.", diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js b/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js index a900fa07bead..f15beda5b7a9 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* 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. From 83796aeb2bc95e499fa4f04d0830fe861bde9d15 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 12 Dec 2025 13:24:18 +0530 Subject: [PATCH 3/4] little updation --- .../@stdlib/constants/float16/sqrt-three/package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json b/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json index 22c3de423145..2908feb94e61 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json @@ -1,5 +1,4 @@ { - "_comment": "Copyright (c) 2025 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0).", "name": "@stdlib/constants/float16/sqrt-three", "version": "0.0.0", "description": "Square root of 3 as a half-precision floating-point number.", From 52c8cdc71733322f36b51ed77d562e473aae2beb Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Sat, 13 Dec 2025 12:44:56 +0530 Subject: [PATCH 4/4] fix: remove auto-populated content from related and links sections --- .../constants/float16/sqrt-three/README.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md b/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md index 82bea328c8cd..be8b2f04c382 100644 --- a/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md +++ b/lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md @@ -66,14 +66,6 @@ console.log( FLOAT16_SQRT3 );
-* * * - -## See Also - -- [`@stdlib/constants/float16/sqrt-eps`][@stdlib/constants/float16/sqrt-eps]: square root of half-precision floating-point epsilon. -- [`@stdlib/constants/float32/sqrt-three`][@stdlib/constants/float32/sqrt-three]: square root of `3` as a single-precision floating-point number. -- [`@stdlib/constants/float64/sqrt-three`][@stdlib/constants/float64/sqrt-three]: square root of 3. -
@@ -84,16 +76,6 @@ console.log( FLOAT16_SQRT3 ); [@stdlib/math/base/special/sqrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sqrt - - -[@stdlib/constants/float16/sqrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/sqrt-eps - -[@stdlib/constants/float32/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-three - -[@stdlib/constants/float64/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/sqrt-three - - -