-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add constants/float16/eulergamma
#9002
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 5 commits into
stdlib-js:develop
from
Amansingh0807:feat-float16-eulergamma
Dec 13, 2025
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d5fc683
feat: add @stdlib/constants/float16/eulergamma
Amansingh0807 ae68590
fix: remove related and links sections from eulergamma README per gui…
Amansingh0807 1454e96
fix: convert reference-style links to inline links to resolve linting…
Amansingh0807 adcc608
Revert: restore related and links sections per maintainer feedback
Amansingh0807 58535da
fix: move Euler-Mascheroni constant formula to intro section per conv…
Amansingh0807 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
81 changes: 81 additions & 0 deletions
81
lib/node_modules/@stdlib/constants/float16/eulergamma/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,81 @@ | ||
| <!-- | ||
|
|
||
| @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_EULER_GAMMA | ||
|
|
||
| > The [Euler–Mascheroni constant](https://en.wikipedia.org/wiki/Euler-Mascheroni_constant). | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var FLOAT16_EULER_GAMMA = require( '@stdlib/constants/float16/eulergamma' ); | ||
| ``` | ||
|
|
||
| #### FLOAT16_EULER_GAMMA | ||
|
|
||
| The [Euler–Mascheroni constant](https://en.wikipedia.org/wiki/Euler-Mascheroni_constant). | ||
|
|
||
| ```javascript | ||
| var bool = ( FLOAT16_EULER_GAMMA === 0.5771484375 ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| The Euler–Mascheroni constant `γ` is defined as the limiting difference between the harmonic series and the natural logarithm: | ||
|
|
||
| <!-- <equation class="equation" label="eq:eulergamma" align="center" raw="\gamma = \lim_{n \to \infty} \left( \sum_{k=1}^{n} \frac{1}{k} - \ln(n) \right)" alt="Euler–Mascheroni constant"> --> | ||
|
|
||
| ```math | ||
| \gamma = \lim_{n \to \infty} \left( \sum_{k=1}^{n} \frac{1}{k} - \ln(n) \right) | ||
| ``` | ||
|
|
||
| <!-- </equation> --> | ||
|
|
||
| The value is approximately `0.5772156649015328606...` in double precision. Due to the limited precision of half-precision floating-point format (float16), the constant is rounded to `0.5771484375`. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var FLOAT16_EULER_GAMMA = require( '@stdlib/constants/float16/eulergamma' ); | ||
|
|
||
| console.log( FLOAT16_EULER_GAMMA ); | ||
| // => 0.5771484375 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
12 changes: 12 additions & 0 deletions
12
lib/node_modules/@stdlib/constants/float16/eulergamma/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}} | ||
| The Euler–Mascheroni constant `γ`. | ||
|
|
||
| Examples | ||
| -------- | ||
| > {{alias}} | ||
| 0.5771484375 | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/constants/float16/eulergamma/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 | ||
|
|
||
| /** | ||
| * The Euler–Mascheroni constant `γ`. | ||
| * | ||
| * @example | ||
| * var val = FLOAT16_EULER_GAMMA; | ||
| * // returns 0.5771484375 | ||
| */ | ||
| declare const FLOAT16_EULER_GAMMA: number; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = FLOAT16_EULER_GAMMA; |
28 changes: 28 additions & 0 deletions
28
lib/node_modules/@stdlib/constants/float16/eulergamma/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_EULER_GAMMA = require( './index' ); | ||
|
|
||
|
|
||
| // TESTS // | ||
|
|
||
| // The export is a number... | ||
| { | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
| FLOAT16_EULER_GAMMA; // $ExpectType number | ||
| } |
24 changes: 24 additions & 0 deletions
24
lib/node_modules/@stdlib/constants/float16/eulergamma/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_EULER_GAMMA = require( './../lib' ); | ||
|
|
||
| console.log( FLOAT16_EULER_GAMMA ); | ||
| // => 0.5771484375 |
49 changes: 49 additions & 0 deletions
49
lib/node_modules/@stdlib/constants/float16/eulergamma/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'; | ||
|
|
||
| /** | ||
| * The Euler–Mascheroni constant `γ`. | ||
| * | ||
| * @module @stdlib/constants/float16/eulergamma | ||
| * @type {number} | ||
| * | ||
| * @example | ||
| * var FLOAT16_EULER_GAMMA = require( '@stdlib/constants/float16/eulergamma' ); | ||
| * // returns 0.5771484375 | ||
| */ | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * The Euler–Mascheroni constant `γ`. | ||
| * | ||
| * @constant | ||
| * @type {number} | ||
| * @default 0.5771484375 | ||
| * @see [OEIS]{@link http://oeis.org/A001620} | ||
| * @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Euler-Mascheroni_constant} | ||
| */ | ||
| var FLOAT16_EULER_GAMMA = 0.5771484375; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| module.exports = FLOAT16_EULER_GAMMA; |
65 changes: 65 additions & 0 deletions
65
lib/node_modules/@stdlib/constants/float16/eulergamma/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,65 @@ | ||
| { | ||
| "name": "@stdlib/constants/float16/eulergamma", | ||
| "version": "0.0.0", | ||
| "description": "Half-precision (float16) approximation of the Euler–Mascheroni 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", | ||
| "euler", | ||
| "eulergamma", | ||
| "gamma", | ||
| "ieee754", | ||
| "float", | ||
| "floating-point", | ||
| "float16" | ||
| ] | ||
| } |
38 changes: 38 additions & 0 deletions
38
lib/node_modules/@stdlib/constants/float16/eulergamma/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_EULER_GAMMA = require( './../lib' ); | ||
|
|
||
|
|
||
| // TESTS // | ||
|
|
||
| tape( 'main export is a number', function test( t ) { | ||
| t.ok( true, __filename ); | ||
| t.strictEqual( typeof FLOAT16_EULER_GAMMA, 'number', 'main export is a number' ); | ||
| t.end(); | ||
| }); | ||
|
|
||
| tape( 'export is a half-precision floating-point number equal to 0.5771484375', function test( t ) { | ||
| t.strictEqual( FLOAT16_EULER_GAMMA, 0.5771484375, '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.