diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/README.md b/lib/node_modules/@stdlib/constants/float16/ln-pi/README.md new file mode 100644 index 000000000000..1d3718992974 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-pi/README.md @@ -0,0 +1,81 @@ + + +# FLOAT16_LN_PI + +> Natural logarithm of the mathematical constant [π][pi] as a half-precision floating-point number. + +
+ +## Usage + +```javascript +var FLOAT16_LN_PI = require( '@stdlib/constants/float16/ln-pi' ); +``` + +#### FLOAT16_LN_PI + +Natural logarithm of the mathematical constant [π][pi] as a half-precision floating-point number. + +```javascript +var bool = ( FLOAT16_LN_PI === 1.14453125 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT16_LN_PI = require( '@stdlib/constants/float16/ln-pi' ); + +console.log( FLOAT16_LN_PI ); +// => 1.14453125 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[pi]: https://en.wikipedia.org/wiki/Pi + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/repl.txt b/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/repl.txt new file mode 100644 index 000000000000..9d2130f2c3b5 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/repl.txt @@ -0,0 +1,13 @@ + +{{alias}} + Natural logarithm of the mathematical constant `π` as a half-precision + floating-point number. + + Examples + -------- + > {{alias}} + 1.14453125 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/types/index.d.ts new file mode 100644 index 000000000000..be48890dbdd7 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-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 the mathematical constant `π` as a half-precision floating-point number. +* +* @example +* var val = FLOAT16_LN_PI; +* // returns 1.14453125 +*/ +declare const FLOAT16_LN_PI: number; + + +// EXPORTS // + +export = FLOAT16_LN_PI; diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float16/ln-pi/docs/types/test.ts new file mode 100644 index 000000000000..2ecbf2090b11 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-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 FLOAT16_LN_PI = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT16_LN_PI; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/examples/index.js b/lib/node_modules/@stdlib/constants/float16/ln-pi/examples/index.js new file mode 100644 index 000000000000..1bf73f748502 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-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 FLOAT16_LN_PI = require( './../lib' ); + +console.log( FLOAT16_LN_PI ); +// => 1.14453125 diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/lib/index.js b/lib/node_modules/@stdlib/constants/float16/ln-pi/lib/index.js new file mode 100644 index 000000000000..0acaf6be71bb --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-pi/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'; + +/** +* Natural logarithm of the mathematical constant `π` as a half-precision floating-point number. +* +* @module @stdlib/constants/float16/ln-pi +* @type {number} +* +* @example +* var FLOAT16_LN_PI = require( '@stdlib/constants/float16/ln-pi' ); +* // returns 1.14453125 +*/ + + +// MAIN // + +/** +* Natural logarithm of the mathematical constant `π` as a half-precision floating-point number. +* +* @constant +* @type {number} +* @default 1.14453125 +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi} +*/ +var FLOAT16_LN_PI = 1.14453125; + + +// EXPORTS // + +module.exports = FLOAT16_LN_PI; diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/package.json b/lib/node_modules/@stdlib/constants/float16/ln-pi/package.json new file mode 100644 index 000000000000..490c8f674733 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-pi/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/constants/float16/ln-pi", + "version": "0.0.0", + "description": "Natural logarithm of π as a half-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", + "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", + "natural", + "logarithm", + "log", + "lnpi", + "logpi", + "pi", + "ieee754", + "float", + "half", + "floating-point", + "float16" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float16/ln-pi/test/test.js b/lib/node_modules/@stdlib/constants/float16/ln-pi/test/test.js new file mode 100644 index 000000000000..dc311a42fe68 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float16/ln-pi/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_LN_PI = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT16_LN_PI, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a half-precision floating-point number equal to `1.14453125`', function test( t ) { + t.strictEqual( FLOAT16_LN_PI, 1.14453125, 'returns expected value' ); + t.end(); +});