From 170f568c4c96227e062441247c34f4de11ac031a Mon Sep 17 00:00:00 2001 From: DivyanshuVorrtex Date: Tue, 16 Dec 2025 16:47:12 +0000 Subject: [PATCH] feat(constants/float16): add Glaisher-kinkelin constants --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../float16/glaisher-kinkelin/README.md | 121 ++++++++++++++++++ .../equation_glaisher_kinkelin_constant.svg | 84 ++++++++++++ .../docs/img/equation_k_function.svg | 38 ++++++ .../float16/glaisher-kinkelin/docs/repl.txt | 12 ++ .../glaisher-kinkelin/docs/types/index.d.ts | 33 +++++ .../glaisher-kinkelin/docs/types/test.ts | 28 ++++ .../glaisher-kinkelin/examples/index.js | 24 ++++ .../float16/glaisher-kinkelin/lib/index.js | 48 +++++++ .../float16/glaisher-kinkelin/package.json | 72 +++++++++++ .../float16/glaisher-kinkelin/test/test.js | 38 ++++++ 10 files changed, 498 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/README.md create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_glaisher_kinkelin_constant.svg create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_k_function.svg create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/package.json create mode 100644 lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/README.md b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/README.md new file mode 100644 index 000000000000..cb4db4a8c244 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/README.md @@ -0,0 +1,121 @@ + + +# FLOAT16_GLAISHER + +> [Glaisher-Kinkelin][glaisher-constant] constant. + +
+ +[Glaisher-Kinkelin][glaisher-constant] constant is defined as + + + +```math +A = \lim_{n\to\infty} \frac{K(n + 1)}{n^{n^2/2 + n/2 + 1/12}e^{-n^2/4}} +``` + + + + + +where + + + +```math +K(n) = \prod_{k=1}^{n-1} k^k +``` + + + + + +is the [K-function][k-function]. + +
+ + + +
+ +## Usage + +```javascript +var FLOAT16_GLAISHER = require( '@stdlib/constants/float16/glaisher-kinkelin' ); +``` + +#### FLOAT16_GLAISHER + +The [Glaisher-Kinkelin][glaisher-constant] constant. + +```javascript +var bool = ( FLOAT16_GLAISHER === 1.2822265625 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_GLAISHER = require( '@stdlib/constants/float16/glaisher-kinkelin' ); + +console.log( 'Glaisher\'s constant: %d', FLOAT16_GLAISHER ); +// => 'Glaisher\'s constant: 1.2822265625' +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[glaisher-constant]: https://en.wikipedia.org/wiki/Glaisher%E2%80%93Kinkelin_constant + +[k-function]: https://en.wikipedia.org/wiki/K-function + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_glaisher_kinkelin_constant.svg b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_glaisher_kinkelin_constant.svg new file mode 100644 index 000000000000..01c46397cd30 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_glaisher_kinkelin_constant.svg @@ -0,0 +1,84 @@ + +upper A equals limit Underscript n right-arrow normal infinity Endscripts StartFraction upper K left-parenthesis n plus 1 right-parenthesis Over n Superscript n squared slash 2 plus n slash 2 plus 1 slash 12 Baseline e Superscript minus n squared slash 4 Baseline EndFraction + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_k_function.svg b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_k_function.svg new file mode 100644 index 000000000000..18eded010cc9 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/img/equation_k_function.svg @@ -0,0 +1,38 @@ + +upper K left-parenthesis n right-parenthesis equals product Underscript k equals 1 Overscript n minus 1 Endscripts k Superscript k + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/repl.txt new file mode 100644 index 000000000000..7bcd9f22965a --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Glaisher-Kinkelin constant. + + Examples + -------- + > {{alias}} + 1.2822265625 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/types/index.d.ts new file mode 100644 index 000000000000..6e3988377e57 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/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 + +/** +* Glaisher-Kinkelin constant. +* +* @example +* var val = FLOAT16_GLAISHER; +* // returns 1.2822265625 +*/ +declare const FLOAT16_GLAISHER: number; + + +// EXPORTS // + +export = FLOAT16_GLAISHER; diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/docs/types/test.ts new file mode 100644 index 000000000000..ad76c89a8c8d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/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_GLAISHER = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_GLAISHER; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/examples/index.js b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/examples/index.js new file mode 100644 index 000000000000..4ccf120a30d7 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/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_GLAISHER = require( './../lib' ); + +console.log( 'Glaisher\'s constant: %d', FLOAT16_GLAISHER ); +// => 'Glaisher\'s constant: 1.2822265625' diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/lib/index.js b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/lib/index.js new file mode 100644 index 000000000000..3410abcb9c1b --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/lib/index.js @@ -0,0 +1,48 @@ +/** +* @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'; + +/** +* Glaisher–Kinkelin constant. +* +* @module @stdlib/constants/float16/glaisher-kinkelin +* @type {number} +* +* @example +* var FLOAT16_GLAISHER = require( '@stdlib/constants/float16/glaisher-kinkelin' ); +* // returns 1.2822265625 +*/ + +// MAIN // + +/** +* Glaisher–Kinkelin constant. +* +* @constant +* @type {number} +* @default 1.2822265625 +* @see [OEIS]{@link https://oeis.org/A074962} +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Glaisher%E2%80%93Kinkelin_constant} +*/ +var FLOAT16_GLAISHER = 1.2822265625; + + +// EXPORTS // + +module.exports = FLOAT16_GLAISHER; diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/package.json b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/package.json new file mode 100644 index 000000000000..31fc9b5c4125 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/constants/float16/glaisher-kinkelin", + "version": "0.0.0", + "description": "Glaisher-Kinkelin 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", + "glaisher-kinkelin", + "glaisher", + "kinkelin", + "riemann", + "zeta", + "special functions", + "k function", + "barnes g function", + "gamma", + "ieee754", + "precision", + "floating-point", + "float", + "float16" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/test/test.js b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/test/test.js new file mode 100644 index 000000000000..0d622cd66f0a --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/glaisher-kinkelin/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_GLAISHER = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_GLAISHER, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is a half-precision floating-point number equal to `1.2822265625`', function test( t ) { + t.equal( FLOAT16_GLAISHER, 1.2822265625, 'returns 1.2822265625' ); + t.end(); +});