From 10cf65b545cd0b7da867f00e5b76d4d8dce58ce9 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 12 Dec 2025 15:36:35 +0530 Subject: [PATCH 1/3] feat: add @stdlib/constants/float16/apery package MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add half-precision (float16) approximation of Apéry's constant - Value: 1.2021484375 (correctly rounded ζ(3) from 1.202056903159594) - Include complete documentation, tests, and TypeScript definitions - Follow stdlib conventions and structure --- .../@stdlib/constants/float16/apery/README.md | 81 +++++++++++++++++++ .../constants/float16/apery/docs/repl.txt | 12 +++ .../float16/apery/docs/types/index.d.ts | 33 ++++++++ .../float16/apery/docs/types/test.ts | 28 +++++++ .../constants/float16/apery/examples/index.js | 24 ++++++ .../constants/float16/apery/lib/index.js | 46 +++++++++++ .../constants/float16/apery/package.json | 64 +++++++++++++++ .../constants/float16/apery/test/test.js | 38 +++++++++ 8 files changed, 326 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/README.md create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/package.json create mode 100644 lib/node_modules/@stdlib/constants/float16/apery/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float16/apery/README.md b/lib/node_modules/@stdlib/constants/float16/apery/README.md new file mode 100644 index 000000000000..90d65f7fc155 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/README.md @@ -0,0 +1,81 @@ + + +# FLOAT16_APERY + +> [Apéry's constant][apery-constant]. + +
+ +## Usage + +```javascript +var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); +``` + +#### FLOAT16_APERY + +[Apéry's constant][apery-constant], the value of the Riemann zeta function ζ(3), represented in half-precision floating-point format. + +```javascript +var bool = ( FLOAT16_APERY === 1.2021484375 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); + +console.log( FLOAT16_APERY ); +// => 1.2021484375 +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/constants/float16/apery/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/apery/docs/repl.txt new file mode 100644 index 000000000000..428cead167aa --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Apéry's constant. + + Examples + -------- + > {{alias}} + 1.2021484375 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/apery/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/apery/docs/types/index.d.ts new file mode 100644 index 000000000000..95e3b888560b --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/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 + +/** +* Apéry's constant. +* +* @example +* var val = FLOAT16_APERY; +* // returns 1.2021484375 +*/ +declare const FLOAT16_APERY: number; + + +// EXPORTS // + +export = FLOAT16_APERY; diff --git a/lib/node_modules/@stdlib/constants/float16/apery/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/apery/docs/types/test.ts new file mode 100644 index 000000000000..d10bacd0fec6 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/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_APERY = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_APERY; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/apery/examples/index.js b/lib/node_modules/@stdlib/constants/float16/apery/examples/index.js new file mode 100644 index 000000000000..cf6afcb29d3e --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/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_APERY = require( './../lib' ); + +console.log( FLOAT16_APERY ); +// => 1.2021484375 diff --git a/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js b/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js new file mode 100644 index 000000000000..601098a5e482 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js @@ -0,0 +1,46 @@ +/** +* @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'; + +/** +* Apéry's constant. +* +* @module @stdlib/constants/float16/apery +* @type {number} +* +* @example +* var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); +* // returns 1.2021484375 +*/ + +/** +* Apéry's constant. +* +* @constant +* @type {number} +* @default 1.2021484375 +* @see [OEIS]{@link https://oeis.org/A002117} +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Ap%C3%A9ry%27s_constant} +*/ +var FLOAT16_APERY = 1.2021484375; + + +// EXPORTS // + +module.exports = FLOAT16_APERY; diff --git a/lib/node_modules/@stdlib/constants/float16/apery/package.json b/lib/node_modules/@stdlib/constants/float16/apery/package.json new file mode 100644 index 000000000000..a713d675deed --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/package.json @@ -0,0 +1,64 @@ +{ + "name": "@stdlib/constants/float16/apery", + "version": "0.0.0", + "description": "Half-precision (float16) approximation of Apéry's constant.", + "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", + "apery", + "zeta", + "ieee754", + "float", + "floating-point", + "float16" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/apery/test/test.js b/lib/node_modules/@stdlib/constants/float16/apery/test/test.js new file mode 100644 index 000000000000..cb93e8e0d2f3 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/apery/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_APERY = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_APERY, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a half-precision floating-point number equal to 1.2021484375', function test( t ) { + t.strictEqual( FLOAT16_APERY, 1.2021484375, 'returns expected value' ); + t.end(); +}); From 9cf6ee5e3b21307ad1ec577d81f5908fb787f532 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Sat, 13 Dec 2025 11:51:33 +0530 Subject: [PATCH 2/3] fix: add intro section with Apery's constant formula per convention --- .../@stdlib/constants/float16/apery/README.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/constants/float16/apery/README.md b/lib/node_modules/@stdlib/constants/float16/apery/README.md index 90d65f7fc155..745067c81c9a 100644 --- a/lib/node_modules/@stdlib/constants/float16/apery/README.md +++ b/lib/node_modules/@stdlib/constants/float16/apery/README.md @@ -22,6 +22,24 @@ limitations under the License. > [Apéry's constant][apery-constant]. +
+ +[Apéry's constant][apery-constant] is defined as + + + +```math +\zeta(3) = \sum_{n=1}^\infty \frac{1}{n^3} = \lim_{n\to\infty} \biggl(\frac{1}{1^3} + \frac{1}{2^3} + \cdots + \frac{1}{n^3}\biggr) +``` + + + +where `ζ(s)` is the Riemann zeta function. + +
+ + +
## Usage @@ -32,7 +50,7 @@ var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); #### FLOAT16_APERY -[Apéry's constant][apery-constant], the value of the Riemann zeta function ζ(3), represented in half-precision floating-point format. +[Apéry's constant][apery-constant]. ```javascript var bool = ( FLOAT16_APERY === 1.2021484375 ); From fedb4e701fa23bf7810836b5ffafb22cb1ef9eb1 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 13 Dec 2025 01:01:29 -0600 Subject: [PATCH 3/3] chore: add section heading Signed-off-by: Philipp Burckhardt --- lib/node_modules/@stdlib/constants/float16/apery/lib/index.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js b/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js index 601098a5e482..cc8cde11f10e 100644 --- a/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float16/apery/lib/index.js @@ -29,6 +29,9 @@ * // returns 1.2021484375 */ + +// MAIN // + /** * Apéry's constant. *