From 9cdf9e9f8e4bf0414e6673d403d5375e0d510b22 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 12 Dec 2025 19:51:51 +0530 Subject: [PATCH 1/2] feat: add @stdlib/constants/float16/phi --- .../@stdlib/constants/float16/phi/README.md | 99 +++++++++++++++++++ .../constants/float16/phi/docs/repl.txt | 12 +++ .../float16/phi/docs/types/index.d.ts | 33 +++++++ .../constants/float16/phi/docs/types/test.ts | 28 ++++++ .../constants/float16/phi/examples/index.js | 24 +++++ .../constants/float16/phi/lib/index.js | 49 +++++++++ .../constants/float16/phi/package.json | 64 ++++++++++++ .../constants/float16/phi/test/test.js | 38 +++++++ 8 files changed, 347 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/README.md create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/package.json create mode 100644 lib/node_modules/@stdlib/constants/float16/phi/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float16/phi/README.md b/lib/node_modules/@stdlib/constants/float16/phi/README.md new file mode 100644 index 000000000000..b7100920dc13 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/README.md @@ -0,0 +1,99 @@ + + +# FLOAT16_PHI + +> The [golden ratio][phi]. + +
+ +## Usage + +```javascript +var FLOAT16_PHI = require( '@stdlib/constants/float16/phi' ); +``` + +#### FLOAT16_PHI + +The [golden ratio][phi]. + +```javascript +var bool = ( FLOAT16_PHI === 1.6181640625 ); +// returns true +``` + +
+ + + +
+ +## Notes + +The golden ratio `φ` is defined as + + + +```math +\phi = \frac{1 + \sqrt{5}}{2} +``` + + + +The value is approximately `1.6180339887498948482...` in double precision. Due to the limited precision of half-precision floating-point format (float16), the constant is rounded to `1.6181640625`. + +
+ + + +
+ +## Examples + + + +```javascript +var FLOAT16_PHI = require( '@stdlib/constants/float16/phi' ); + +console.log( FLOAT16_PHI ); +// => 1.6181640625 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[phi]: https://en.wikipedia.org/wiki/Golden_ratio + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float16/phi/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/phi/docs/repl.txt new file mode 100644 index 000000000000..f651974a1151 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + The golden ratio `φ`. + + Examples + -------- + > {{alias}} + 1.6181640625 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/phi/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/phi/docs/types/index.d.ts new file mode 100644 index 000000000000..f1a4313f174a --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/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 + +/** +* The golden ratio `φ`. +* +* @example +* var val = FLOAT16_PHI; +* // returns 1.6181640625 +*/ +declare const FLOAT16_PHI: number; + + +// EXPORTS // + +export = FLOAT16_PHI; diff --git a/lib/node_modules/@stdlib/constants/float16/phi/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/phi/docs/types/test.ts new file mode 100644 index 000000000000..233fea57c2d8 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/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_PHI = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_PHI; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/phi/examples/index.js b/lib/node_modules/@stdlib/constants/float16/phi/examples/index.js new file mode 100644 index 000000000000..0f91172b6945 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/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_PHI = require( './../lib' ); + +console.log( FLOAT16_PHI ); +// => 1.6181640625 diff --git a/lib/node_modules/@stdlib/constants/float16/phi/lib/index.js b/lib/node_modules/@stdlib/constants/float16/phi/lib/index.js new file mode 100644 index 000000000000..4926187fdee5 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/lib/index.js @@ -0,0 +1,49 @@ +/** +* @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'; + +/** +* The golden ratio `φ`. +* +* @module @stdlib/constants/float16/phi +* @type {number} +* +* @example +* var FLOAT16_PHI = require( '@stdlib/constants/float16/phi' ); +* // returns 1.6181640625 +*/ + + +// MAIN // + +/** +* The golden ratio `φ`. +* +* @constant +* @type {number} +* @default 1.6181640625 +* @see [OEIS]{@link http://oeis.org/A001622} +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Golden_ratio} +*/ +var FLOAT16_PHI = 1.6181640625; + + +// EXPORTS // + +module.exports = FLOAT16_PHI; diff --git a/lib/node_modules/@stdlib/constants/float16/phi/package.json b/lib/node_modules/@stdlib/constants/float16/phi/package.json new file mode 100644 index 000000000000..fe96893eb602 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/package.json @@ -0,0 +1,64 @@ +{ + "name": "@stdlib/constants/float16/phi", + "version": "0.0.0", + "description": "Half-precision (float16) approximation of the golden ratio (φ).", + "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", + "phi", + "golden-ratio", + "ieee754", + "float", + "floating-point", + "float16" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/phi/test/test.js b/lib/node_modules/@stdlib/constants/float16/phi/test/test.js new file mode 100644 index 000000000000..7107a6134215 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/phi/test/test.js @@ -0,0 +1,38 @@ +/** +* @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 FLOAT16_PHI = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_PHI, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a half-precision floating-point number equal to 1.6181640625', function test( t ) { + t.strictEqual( FLOAT16_PHI, 1.6181640625, 'returns expected value' ); + t.end(); +}); From 15d4f34b3453f595d82a0bc9f4d1b00e3b2961fc Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Sat, 13 Dec 2025 11:33:09 +0530 Subject: [PATCH 2/2] fix: move golden ratio formula to intro section per convention --- .../@stdlib/constants/float16/phi/README.md | 28 +++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float16/phi/README.md b/lib/node_modules/@stdlib/constants/float16/phi/README.md index b7100920dc13..17229e0892de 100644 --- a/lib/node_modules/@stdlib/constants/float16/phi/README.md +++ b/lib/node_modules/@stdlib/constants/float16/phi/README.md @@ -20,7 +20,23 @@ limitations under the License. # FLOAT16_PHI -> The [golden ratio][phi]. +> [Golden ratio][phi]. + +
+ +The [golden ratio][phi] can be defined algebraically as + + + +```math +\phi = \frac{1 + \sqrt{5}}{2} +``` + + + +
+ +
@@ -47,16 +63,6 @@ var bool = ( FLOAT16_PHI === 1.6181640625 ); ## Notes -The golden ratio `φ` is defined as - - - -```math -\phi = \frac{1 + \sqrt{5}}{2} -``` - - - The value is approximately `1.6180339887498948482...` in double precision. Due to the limited precision of half-precision floating-point format (float16), the constant is rounded to `1.6181640625`.