From 4a95001e863fa35f6c5b41f711f40fa4d1a4a1d5 Mon Sep 17 00:00:00 2001 From: Girish Garg Date: Tue, 25 Mar 2025 10:35:35 +0530 Subject: [PATCH 1/2] feat: add single precision float min-ln --- .../constants/float32/min-ln/README.md | 149 ++++++++++++++++++ .../constants/float32/min-ln/docs/repl.txt | 13 ++ .../float32/min-ln/docs/types/index.d.ts | 33 ++++ .../float32/min-ln/docs/types/test.ts | 28 ++++ .../float32/min-ln/examples/index.js | 24 +++ .../include/stdlib/constants/float64/min_ln.h | 27 ++++ .../constants/float32/min-ln/lib/index.js | 56 +++++++ .../constants/float32/min-ln/manifest.json | 36 +++++ .../constants/float32/min-ln/package.json | 73 +++++++++ .../constants/float32/min-ln/test/test.js | 42 +++++ 10 files changed, 481 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/README.md create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_ln.h create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/manifest.json create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/package.json create mode 100644 lib/node_modules/@stdlib/constants/float32/min-ln/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/README.md b/lib/node_modules/@stdlib/constants/float32/min-ln/README.md new file mode 100644 index 000000000000..a73cbb9a3b02 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-ln/README.md @@ -0,0 +1,149 @@ + + +# FLOAT32_MIN_LN + +> [Natural logarithm][natural-logarithm] of the smallest **normalized** [single-precision floating-point number][ieee754]. + +
+ +## Usage + +```javascript +var FLOAT32_MIN_LN = require( '@stdlib/constants/float32/min-ln' ); +``` + +#### FLOAT32_MIN_LN + +[Natural logarithm][natural-logarithm] of the smallest **normalized** [single-precision floating-point number][ieee754]. + +```javascript +var bool = ( FLOAT32_MIN_LN === -87.3365478515625 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT32_MIN_LN = require( '@stdlib/constants/float32/min-ln' ); + +console.log( FLOAT32_MIN_LN ); +// => -87.3365478515625 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float32/min_ln.h" +``` + +#### STDLIB_CONSTANT_FLOAT32_MIN_LN + +Macro for the [natural logarithm][natural-logarithm] of the smallest **normalized** [single-precision floating-point number][ieee754]. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/constants/float64/max-ln`][@stdlib/constants/float64/max-ln]: natural logarithm of the maximum double-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/max-ln]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max-ln + + + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/docs/repl.txt b/lib/node_modules/@stdlib/constants/float32/min-ln/docs/repl.txt new file mode 100644 index 000000000000..0fa045190d6c --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-ln/docs/repl.txt @@ -0,0 +1,13 @@ + +{{alias}} + Natural logarithm of the smallest normalized single-precision floating-point + number. + + Examples + -------- + > {{alias}} + -87.3365478515625 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/index.d.ts new file mode 100644 index 000000000000..6b98213365e6 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-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 smallest normalized single-precision floating-point number. +* +* @example +* var min = FLOAT32_MIN_LN; +* // returns -87.3365478515625 +*/ +declare const FLOAT32_MIN_LN: number; + + +// EXPORTS // + +export = FLOAT32_MIN_LN; diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/test.ts new file mode 100644 index 000000000000..b3e36614f069 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-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_MIN_LN = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT32_MIN_LN; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/examples/index.js b/lib/node_modules/@stdlib/constants/float32/min-ln/examples/index.js new file mode 100644 index 000000000000..7e2d59000424 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-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_MIN_LN = require( './../lib' ); + +console.log( FLOAT32_MIN_LN ); +// => -87.3365478515625 diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_ln.h b/lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_ln.h new file mode 100644 index 000000000000..c611af493a8b --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_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_MIN_LN_H +#define STDLIB_CONSTANTS_FLOAT32_MIN_LN_H + +/** +* Macro for the natural logarithm of the smallest normalized single-precision floating-point number. +*/ +#define STDLIB_CONSTANT_FLOAT32_MIN_LN -87.3365478515625f + +#endif // !STDLIB_CONSTANTS_FLOAT32_MIN_LN_H diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float32/min-ln/lib/index.js new file mode 100644 index 000000000000..4d58c6710495 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-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 smallest normalized single-precision floating-point number. +* +* @module @stdlib/constants/float32/min-ln +* @type {number} +* +* @example +* var FLOAT32_MIN_LN = require( '@stdlib/constants/float32/min-ln' ); +* // returns -87.3365478515625 +*/ + + +// MAIN // + +/** +* Natural logarithm of the smallest normalized single-precision floating-point number. +* +* ## Notes +* +* The number has the value +* +* ```tex +* -\ln \left( 2^{127-1} \right) +* ``` +* +* @constant +* @type {number} +* @default -87.3365478515625 +* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} +*/ +var FLOAT32_MIN_LN = -87.3365478515625; + + +// EXPORTS // + +module.exports = FLOAT32_MIN_LN; diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/manifest.json b/lib/node_modules/@stdlib/constants/float32/min-ln/manifest.json new file mode 100644 index 000000000000..844d692f6439 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-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/min-ln/package.json b/lib/node_modules/@stdlib/constants/float32/min-ln/package.json new file mode 100644 index 000000000000..d480fd9f3e98 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-ln/package.json @@ -0,0 +1,73 @@ +{ + "name": "@stdlib/constants/float32/min-ln", + "version": "0.0.0", + "description": "Natural logarithm of the smallest normalized 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", + "smallest", + "minimum", + "floating-point", + "float64", + "float", + "64bit", + "ieee754", + "double", + "dbl", + "precision", + "min", + "normalized", + "logarithm", + "log" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/test/test.js b/lib/node_modules/@stdlib/constants/float32/min-ln/test/test.js new file mode 100644 index 000000000000..36baaef8de77 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-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 SMALLEST_NORMAL = require( '@stdlib/constants/float32/smallest-normal' ); +var FLOAT32_MIN_LN = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_MIN_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 smallest normalized single-precision floating-point number', function test( t ) { + t.equal( FLOAT32_MIN_LN, -ln( pow( 2, 126 ) ), 'equals the logarithm of the smallest normalized single-precision floating-point number' ); + t.equal( FLOAT32_MIN_LN, ln( SMALLEST_NORMAL ), 'equals the logarithm of the smallest normalized single-precision floating-point number' ); + t.end(); +}); From c8e56fe1fb3817650cb149100227a5776820f0b1 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 25 Mar 2025 07:20:00 +0000 Subject: [PATCH 2/2] chore: update copyright years --- lib/node_modules/@stdlib/constants/float32/min-ln/README.md | 2 +- .../@stdlib/constants/float32/min-ln/docs/types/index.d.ts | 2 +- .../@stdlib/constants/float32/min-ln/docs/types/test.ts | 2 +- .../@stdlib/constants/float32/min-ln/examples/index.js | 2 +- .../float32/min-ln/include/stdlib/constants/float64/min_ln.h | 2 +- lib/node_modules/@stdlib/constants/float32/min-ln/lib/index.js | 2 +- lib/node_modules/@stdlib/constants/float32/min-ln/test/test.js | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float32/min-ln/README.md b/lib/node_modules/@stdlib/constants/float32/min-ln/README.md index a73cbb9a3b02..037a5dfcdfb9 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/README.md +++ b/lib/node_modules/@stdlib/constants/float32/min-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/min-ln/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/index.d.ts index 6b98213365e6..ff607b532e70 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/constants/float32/min-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/min-ln/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/test.ts index b3e36614f069..c591d6d7a992 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/docs/types/test.ts +++ b/lib/node_modules/@stdlib/constants/float32/min-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/min-ln/examples/index.js b/lib/node_modules/@stdlib/constants/float32/min-ln/examples/index.js index 7e2d59000424..76277db1b427 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/examples/index.js +++ b/lib/node_modules/@stdlib/constants/float32/min-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/min-ln/include/stdlib/constants/float64/min_ln.h b/lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_ln.h index c611af493a8b..d4c1e08f2026 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_ln.h +++ b/lib/node_modules/@stdlib/constants/float32/min-ln/include/stdlib/constants/float64/min_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/min-ln/lib/index.js b/lib/node_modules/@stdlib/constants/float32/min-ln/lib/index.js index 4d58c6710495..ff8f7f3945ad 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float32/min-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/min-ln/test/test.js b/lib/node_modules/@stdlib/constants/float32/min-ln/test/test.js index 36baaef8de77..7535c4407076 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-ln/test/test.js +++ b/lib/node_modules/@stdlib/constants/float32/min-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.