-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: add constants/float16/apery
#8997
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Planeshifter
merged 3 commits into
stdlib-js:develop
from
Amansingh0807:feat/constants-float16-apery
Dec 13, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
99 changes: 99 additions & 0 deletions
99
lib/node_modules/@stdlib/constants/float16/apery/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # FLOAT16_APERY | ||
|
|
||
| > [Apéry's constant][apery-constant]. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| [Apéry's constant][apery-constant] is defined as | ||
|
|
||
| <!-- <equation class="equation" label="eq:apery_constant" align="center" raw="\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)" alt="Apéry's constant"> --> | ||
|
|
||
| ```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) | ||
| ``` | ||
|
|
||
| <!-- </equation> --> | ||
|
|
||
| where `ζ(s)` is the Riemann zeta function. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); | ||
| ``` | ||
|
|
||
| #### FLOAT16_APERY | ||
|
|
||
| [Apéry's constant][apery-constant]. | ||
|
|
||
| ```javascript | ||
| var bool = ( FLOAT16_APERY === 1.2021484375 ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- TODO: better example --> | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); | ||
|
|
||
| console.log( FLOAT16_APERY ); | ||
| // => 1.2021484375 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
|
||
| <section class="related"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.related --> | ||
|
|
||
| <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="links"> | ||
|
|
||
| [apery-constant]: https://en.wikipedia.org/wiki/Ap%C3%A9ry%27s_constant | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> |
12 changes: 12 additions & 0 deletions
12
lib/node_modules/@stdlib/constants/float16/apery/docs/repl.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
|
|
||
| {{alias}} | ||
| Apéry's constant. | ||
|
|
||
| Examples | ||
| -------- | ||
| > {{alias}} | ||
| 1.2021484375 | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/constants/float16/apery/docs/types/index.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; |
28 changes: 28 additions & 0 deletions
28
lib/node_modules/@stdlib/constants/float16/apery/docs/types/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| } |
24 changes: 24 additions & 0 deletions
24
lib/node_modules/@stdlib/constants/float16/apery/examples/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
49 changes: 49 additions & 0 deletions
49
lib/node_modules/@stdlib/constants/float16/apery/lib/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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'; | ||
|
|
||
| /** | ||
| * Apéry's constant. | ||
| * | ||
| * @module @stdlib/constants/float16/apery | ||
| * @type {number} | ||
| * | ||
| * @example | ||
| * var FLOAT16_APERY = require( '@stdlib/constants/float16/apery' ); | ||
| * // returns 1.2021484375 | ||
| */ | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * 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; | ||
64 changes: 64 additions & 0 deletions
64
lib/node_modules/@stdlib/constants/float16/apery/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| ] | ||
| } |
38 changes: 38 additions & 0 deletions
38
lib/node_modules/@stdlib/constants/float16/apery/test/test.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.