From 4d774bb6152413448f790d10194a6810fe37de9a Mon Sep 17 00:00:00 2001 From: Girish Garg Date: Tue, 25 Mar 2025 19:49:01 +0530 Subject: [PATCH 1/2] feat: add single-precision max-ln --- .../constants/float32/max-ln/README.md | 149 ++++++++++++++++++ .../constants/float32/max-ln/docs/repl.txt | 12 ++ .../float32/max-ln/docs/types/index.d.ts | 33 ++++ .../float32/max-ln/docs/types/test.ts | 28 ++++ .../float32/max-ln/examples/index.js | 24 +++ .../include/stdlib/constants/float64/max_ln.h | 27 ++++ .../constants/float32/max-ln/lib/index.js | 56 +++++++ .../constants/float32/max-ln/manifest.json | 36 +++++ .../constants/float32/max-ln/package.json | 75 +++++++++ .../constants/float32/max-ln/test/test.js | 42 +++++ 10 files changed, 482 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/README.md create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/manifest.json create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/package.json create mode 100644 lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/README.md b/lib/node_modules/@stdlib/constants/float32/max-ln/README.md new file mode 100644 index 000000000000..30fd0f71cf78 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/README.md @@ -0,0 +1,149 @@ + + +# FLOAT32_MAX_LN + +> [Natural logarithm][natural-logarithm] of the maximum [single-precision floating-point number][ieee754]. + +
+ +## Usage + +```javascript +var FLOAT32_MAX_LN = require( '@stdlib/constants/float32/max-ln' ); +``` + +#### FLOAT32_MAX_LN + +[Natural logarithm][natural-logarithm] of the maximum [single-precision floating-point number][ieee754]. + +```javascript +var bool = ( FLOAT32_MAX_LN === 88.72283935546875 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT32_MAX_LN = require( '@stdlib/constants/float32/max-ln' ); + +console.log( FLOAT32_MAX_LN ); +// => 88.72283935546875 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float32/max_ln.h" +``` + +#### STDLIB_CONSTANT_FLOAT32_MAX_LN + +Macro for the [natural logarithm][natural-logarithm] of the maximum [single-precision floating-point number][ieee754]. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/constants/float32/min-ln`][@stdlib/constants/float32/min-ln]: natural logarithm of the smallest normalized single-precision floating-point number. + +
+ + + + + +
+ +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + +[natural-logarithm]: https://en.wikipedia.org/wiki/Natural_logarithm + + + +[@stdlib/constants/float64/min-ln]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-ln + + + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/repl.txt b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/repl.txt new file mode 100644 index 000000000000..e00a636fbcdc --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Natural logarithm of the maximum double-precision floating-point number. + + Examples + -------- + > {{alias}} + 88.72283935546875 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts new file mode 100644 index 000000000000..2c17d9cf38cd --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts @@ -0,0 +1,33 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2019 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 + +/** +* Natural logarithm of the maximum single-precision floating-point number. +* +* @example +* var val = FLOAT32_MAX_LN; +* // returns 88.72283935546875 +*/ +declare const FLOAT32_MAX_LN: number; + + +// EXPORTS // + +export = FLOAT32_MAX_LN; diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts new file mode 100644 index 000000000000..2c1d6106122d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts @@ -0,0 +1,28 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2019 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 FLOAT32_MAX_LN = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT32_MAX_LN; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js b/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js new file mode 100644 index 000000000000..e3cfdd08da1a --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js @@ -0,0 +1,24 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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 FLOAT32_MAX_LN = require( './../lib' ); + +console.log( FLOAT32_MAX_LN ); +// => 88.72283935546875 diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h b/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h new file mode 100644 index 000000000000..b183f884223e --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h @@ -0,0 +1,27 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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. +*/ + +#ifndef STDLIB_CONSTANTS_FLOAT32_MAX_LN_H +#define STDLIB_CONSTANTS_FLOAT32_MAX_LN_H + +/** +* Macro for the natural logarithm of the maximum float-precision floating-point number. +*/ +#define STDLIB_CONSTANT_FLOAT64_MAX_LN 88.72283935546875f + +#endif // !STDLIB_CONSTANTS_FLOAT32_MAX_LN_H diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js new file mode 100644 index 000000000000..ec08880fce52 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js @@ -0,0 +1,56 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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'; + +/** +* Natural logarithm of the maximum single-precision floating-point number. +* +* @module @stdlib/constants/float32/max-ln +* @type {number} +* +* @example +* var FLOAT32_MAX_LN = require( '@stdlib/constants/float32/max-ln' ); +* // returns 88.72283935546875 +*/ + + +// MAIN // + +/** +* Natural logarithm of the maximum single-precision floating-point number. +* +* ## Notes +* +* The natural logarithm of the maximum is given by +* +* ```tex +* \ln \left( 2^{127} (2 - 2^{-23}) \right) +* ``` +* +* @constant +* @type {number} +* @default 88.72283935546875 +* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} +*/ +var FLOAT32_MAX_LN = 88.72283935546875; + + +// EXPORTS // + +module.exports = FLOAT32_MAX_LN; diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/manifest.json b/lib/node_modules/@stdlib/constants/float32/max-ln/manifest.json new file mode 100644 index 000000000000..844d692f6439 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/manifest.json @@ -0,0 +1,36 @@ +{ + "options": {}, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "src": [], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + } + ] +} diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/package.json b/lib/node_modules/@stdlib/constants/float32/max-ln/package.json new file mode 100644 index 000000000000..b469c6426688 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/package.json @@ -0,0 +1,75 @@ +{ + "name": "@stdlib/constants/float32/max-ln", + "version": "0.0.0", + "description": "Natural logarithm of the maximum single-precision floating-point number.", + "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", + "include": "./include", + "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", + "max", + "maximum", + "floating-point", + "float64", + "float", + "64bit", + "ieee754", + "double", + "dbl", + "precision", + "largest", + "greatest", + "natural", + "logarithm", + "log", + "ln" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js b/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js new file mode 100644 index 000000000000..88f451aa3488 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js @@ -0,0 +1,42 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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 pow = require( '@stdlib/math/base/special/pow' ); +var ln = require( '@stdlib/math/base/special/lnf' ); +var FLOAT32_MAX = require( '@stdlib/constants/float32/max' ); +var FLOAT32_MAX_LN = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_MAX_LN, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a single-precision floating-point number equal to the natural logarithm of the max single-precision floating-point number', function test( t ) { + t.equal( FLOAT32_MAX_LN, ln( pow(2, 127) * (2-pow(2, -23)) ), 'equals the logarithm of the max value (computed)' ); + t.equal( FLOAT32_MAX_LN, ln( FLOAT32_MAX ), 'equals the logarithm of the max value' ); + t.end(); +}); From 5b16a70bf0dd0e28c12571dbbc4c19c06aa05f66 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 25 Mar 2025 14:24:39 +0000 Subject: [PATCH 2/2] chore: update copyright years --- lib/node_modules/@stdlib/constants/float32/max-ln/README.md | 2 +- .../@stdlib/constants/float32/max-ln/docs/types/index.d.ts | 2 +- .../@stdlib/constants/float32/max-ln/docs/types/test.ts | 2 +- .../@stdlib/constants/float32/max-ln/examples/index.js | 2 +- .../float32/max-ln/include/stdlib/constants/float64/max_ln.h | 2 +- lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js | 2 +- lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/README.md b/lib/node_modules/@stdlib/constants/float32/max-ln/README.md index 30fd0f71cf78..e02e9da14a74 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/README.md +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2018 The Stdlib Authors. +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. diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts index 2c17d9cf38cd..a7ceda019f7f 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts index 2c1d6106122d..7a0b1605f82d 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js b/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js index e3cfdd08da1a..340c06a756a7 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h b/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h index b183f884223e..436e26099abb 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/include/stdlib/constants/float64/max_ln.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2022 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js index ec08880fce52..ad17dc96ff26 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js b/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js index 88f451aa3488..08d3771803c6 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js +++ b/lib/node_modules/@stdlib/constants/float32/max-ln/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* 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.