From 3e6dfeeb89c1295c3bc2232efff18496e4f6f490 Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sat, 15 Mar 2025 17:45:52 +0530 Subject: [PATCH 1/2] feat: add JS implementation --- .../constants/float32/ln-two-pi/README.md | 147 ++++++++++++++++++ .../constants/float32/ln-two-pi/docs/repl.txt | 12 ++ .../float32/ln-two-pi/docs/types/index.d.ts | 33 ++++ .../float32/ln-two-pi/docs/types/test.ts | 28 ++++ .../float32/ln-two-pi/examples/index.js | 24 +++ .../stdlib/constants/float32/ln_two_pi.h | 27 ++++ .../constants/float32/ln-two-pi/lib/index.js | 55 +++++++ .../constants/float32/ln-two-pi/manifest.json | 36 +++++ .../constants/float32/ln-two-pi/package.json | 72 +++++++++ .../constants/float32/ln-two-pi/test/test.js | 56 +++++++ 10 files changed, 490 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/manifest.json create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/package.json create mode 100644 lib/node_modules/@stdlib/constants/float32/ln-two-pi/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md new file mode 100644 index 000000000000..d02363a3a2bb --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md @@ -0,0 +1,147 @@ + + +# FLOAT32_LN_TWO_PI + +> [Natural logarithm][@stdlib/math/base/special/lnf] of `2π`. + +
+ +## Usage + +```javascript +var FLOAT32_LN_TWO_PI = require( '@stdlib/constants/float32/ln-two-pi' ); +``` + +#### FLOAT32_LN_TWO_PI + +[Natural logarithm][@stdlib/math/base/special/lnf] of `2π`. + +```javascript +var bool = ( FLOAT32_LN_TWO_PI === 1.8378770351409912 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT32_LN_TWO_PI = require( '@stdlib/constants/float32/ln-two-pi' ); + +console.log( FLOAT32_LN_TWO_PI ); +// => 1.8378770351409912 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float32/ln_two_pi.h" +``` + +#### STDLIB_CONSTANT_FLOAT32_LN_TWO_PI + +Macro for the [natural logarithm][@stdlib/math/base/special/lnf] of `2π`. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/repl.txt b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/repl.txt new file mode 100644 index 000000000000..b5dfeef95ac9 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Natural logarithm of `2π`. + + Examples + -------- + > {{alias}} + 1.8378770351409912 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/types/index.d.ts new file mode 100644 index 000000000000..36289d1955eb --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/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 + +/** +* Natural logarithm of `2π`. +* +* @example +* var val = FLOAT32_LN_TWO_PI; +* // returns 1.8378770351409912 +*/ +declare const FLOAT32_LN_TWO_PI: number; + + +// EXPORTS // + +export = FLOAT32_LN_TWO_PI; diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/docs/types/test.ts new file mode 100644 index 000000000000..b6d2007e9cc9 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/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 FLOAT32_LN_TWO_PI = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT32_LN_TWO_PI; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/examples/index.js b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/examples/index.js new file mode 100644 index 000000000000..0b959881f4dd --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/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 FLOAT32_LN_TWO_PI = require( './../lib' ); + +console.log( FLOAT32_LN_TWO_PI ); +// => 1.8378770351409912 diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h new file mode 100644 index 000000000000..1de9886fed22 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h @@ -0,0 +1,27 @@ +/** +* @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. +*/ + +#ifndef STDLIB_CONSTANTS_FLOAT32_LN_TWO_PI_H +#define STDLIB_CONSTANTS_FLOAT32_LN_TWO_PI_H + +/** +* Macro for the natural logarithm of 2π. +*/ +#define STDLIB_CONSTANT_FLOAT32_LN_TWO_PI 1.8378770351409912 + +#endif // !STDLIB_CONSTANTS_FLOAT32_LN_TWO_PI_H diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/lib/index.js b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/lib/index.js new file mode 100644 index 000000000000..4f4140583fea --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/lib/index.js @@ -0,0 +1,55 @@ +/** +* @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'; + +/** +* Natural logarithm of `2π`. +* +* @module @stdlib/constants/float32/ln-two-pi +* @type {number} +* +* @example +* var FLOAT32_LN_TWO_PI = require( '@stdlib/constants/float32/ln-two-pi' ); +* // returns 1.8378770351409912 +*/ + +// MODULES // + +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); + + +// MAIN // + +/** +* Natural logarithm of `2π`. +* +* ```tex +* \ln 2\pi +* ``` +* +* @constant +* @type {number} +* @default 1.8378770351409912 +*/ +var FLOAT32_LN_TWO_PI = float64ToFloat32( 1.8378770664093456 ); + + +// EXPORTS // + +module.exports = FLOAT32_LN_TWO_PI; diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/manifest.json b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/manifest.json new file mode 100644 index 000000000000..844d692f6439 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/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/ln-two-pi/package.json b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/package.json new file mode 100644 index 000000000000..5ec7605e6b02 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/constants/float32/ln-two-pi", + "version": "0.0.0", + "description": "Natural logarithm of 2π.", + "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", + "ln", + "ln2", + "math.ln2", + "natural", + "logarithm", + "log", + "ieee754", + "precision", + "floating-point", + "float", + "float32", + "pi", + "2pi" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/test/test.js b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/test/test.js new file mode 100644 index 000000000000..8e2f9674b0b0 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/test/test.js @@ -0,0 +1,56 @@ +/** +* @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 lnf = require( '@stdlib/math/base/special/lnf' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var PI = require( '@stdlib/constants/float32/pi' ); +var FLOAT32_LN_TWO_PI = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_LN_TWO_PI, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a single-precision floating-point number equal to `1.8378770351409912`', function test( t ) { + t.equal( FLOAT32_LN_TWO_PI, 1.8378770351409912, 'equals 1.8378770351409912' ); + t.end(); +}); + +tape( 'export equals `ln(2*pi)`', function test( t ) { + var delta; + var tol; + var v; + + v = lnf( 2.0*PI ); + delta = absf( v - FLOAT32_LN_TWO_PI ); + tol = EPS * FLOAT32_LN_TWO_PI; + + t.ok( delta <= tol, 'equals ln(2*pi) within tolerance '+tol ); + + t.end(); +}); From c9df969fd6e5c2a072df2e40046cd70938006c6e Mon Sep 17 00:00:00 2001 From: Neerajpathak07 Date: Sun, 16 Mar 2025 15:17:00 +0530 Subject: [PATCH 2/2] chore: stuff from code review --- .../@stdlib/constants/float32/ln-two-pi/README.md | 12 ------------ .../include/stdlib/constants/float32/ln_two_pi.h | 2 +- 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md index d02363a3a2bb..1d5ea66943bb 100644 --- a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/README.md @@ -120,12 +120,6 @@ Macro for the [natural logarithm][@stdlib/math/base/special/lnf] of `2π`. @@ -136,12 +130,6 @@ Macro for the [natural logarithm][@stdlib/math/base/special/lnf] of `2π`. [@stdlib/math/base/special/lnf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/lnf - - -[@stdlib/constants/float32/two-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/two-pi - - - diff --git a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h index 1de9886fed22..a30da4d93f25 100644 --- a/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h +++ b/lib/node_modules/@stdlib/constants/float32/ln-two-pi/include/stdlib/constants/float32/ln_two_pi.h @@ -22,6 +22,6 @@ /** * Macro for the natural logarithm of 2π. */ -#define STDLIB_CONSTANT_FLOAT32_LN_TWO_PI 1.8378770351409912 +#define STDLIB_CONSTANT_FLOAT32_LN_TWO_PI 1.8378770351409912f #endif // !STDLIB_CONSTANTS_FLOAT32_LN_TWO_PI_H