diff --git a/CHANGELOG.md b/CHANGELOG.md index 48c5b21..0ff7789 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -486,6 +486,28 @@ This release closes the following issue: +
+ +#### [@stdlib/constants/float32/sqrt-two-pi](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-two-pi) + +
+ +
+ +##### Features + +- [`5c28376`](https://github.com/stdlib-js/stdlib/commit/5c28376c28904602fd17dec34d0c40b67070d941) - add `constants/float32/sqrt-two-pi` [(#3345)](https://github.com/stdlib-js/stdlib/pull/3345) + +
+ + + +
+ +
+ + +
#### [@stdlib/constants/float64/max-safe-nth-tribonacci](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max-safe-nth-tribonacci) @@ -548,6 +570,7 @@ A total of 7 people contributed to this release. Thank you to the following cont
+- [`5c28376`](https://github.com/stdlib-js/stdlib/commit/5c28376c28904602fd17dec34d0c40b67070d941) - **feat:** add `constants/float32/sqrt-two-pi` [(#3345)](https://github.com/stdlib-js/stdlib/pull/3345) _(by Vivek maurya, stdlib-bot, Athan Reines)_ - [`ed63505`](https://github.com/stdlib-js/stdlib/commit/ed6350530cfae8d685f02987681d7933b83d88b7) - **feat:** add `constants/float32/max-safe-nth-lucas` [(#3337)](https://github.com/stdlib-js/stdlib/pull/3337) _(by Aayush Khanna, Athan Reines)_ - [`5a4f6ed`](https://github.com/stdlib-js/stdlib/commit/5a4f6edd9eb9e71c3b86e37bebc0d9125efe4931) - **feat:** add `constants/float32/ln-half` [(#3333)](https://github.com/stdlib-js/stdlib/pull/3333) _(by Vivek maurya, Athan Reines, Gunj Joshi, stdlib-bot)_ - [`fc8571d`](https://github.com/stdlib-js/stdlib/commit/fc8571d4e2f7981711a85db47ef8d4acfecfba32) - **feat:** add `constants/float32/ln-pi` [(#3342)](https://github.com/stdlib-js/stdlib/pull/3342) _(by Vivek maurya, Athan Reines, stdlib-bot)_ diff --git a/CONTRIBUTORS b/CONTRIBUTORS index ba851aa..1ba9b59 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -112,6 +112,7 @@ UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com> Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com> Varad Gupta Vinit Pandit <106718914+MeastroZI@users.noreply.github.com> +Vivek maurya <155618190+vivekmaurya001@users.noreply.github.com> Xiaochuan Ye Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com> Yernar Yergaziyev diff --git a/float32/sqrt-two-pi/README.md b/float32/sqrt-two-pi/README.md new file mode 100644 index 0000000..cfb257d --- /dev/null +++ b/float32/sqrt-two-pi/README.md @@ -0,0 +1,147 @@ + + +# FLOAT32_SQRT_TWO_PI + +> Square root of the mathematical constant [π][@stdlib/constants/float32/pi] times 2 as a single-precision floating-point number. + +
+ +## Usage + +```javascript +var FLOAT32_SQRT_TWO_PI = require( '@stdlib/constants/float32/sqrt-two-pi' ); +``` + +#### FLOAT32_SQRT_TWO_PI + +Square root of the mathematical constant [π][@stdlib/constants/float32/pi] times `2` as a single-precision floating-point number. + +```javascript +var bool = ( FLOAT32_SQRT_TWO_PI === 2.5066282749176025 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT32_SQRT_TWO_PI = require( '@stdlib/constants/float32/sqrt-two-pi' ); + +console.log( FLOAT32_SQRT_TWO_PI ); +// => 2.5066282749176025 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float32/sqrt_two_pi.h" +``` + +#### STDLIB_CONSTANT_FLOAT32_SQRT_TWO_PI + +Macro for the square root of the mathematical constant [π][@stdlib/constants/float32/pi] times `2` as a single-precision floating-point number. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + + + + + + + + + + diff --git a/float32/sqrt-two-pi/docs/repl.txt b/float32/sqrt-two-pi/docs/repl.txt new file mode 100644 index 0000000..1a42347 --- /dev/null +++ b/float32/sqrt-two-pi/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Square root of the `π` times `2` as single-precision floating-point number. + + Examples + -------- + > {{alias}} + 2.5066282749176025 + + See Also + -------- + diff --git a/float32/sqrt-two-pi/docs/types/index.d.ts b/float32/sqrt-two-pi/docs/types/index.d.ts new file mode 100644 index 0000000..e88c79b --- /dev/null +++ b/float32/sqrt-two-pi/docs/types/index.d.ts @@ -0,0 +1,33 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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 + +/** +* Square root of the mathematical constant `π` times `2` as a single-precision floating-point number. +* +* @example +* var val = FLOAT32_SQRT_TWO_PI; +* // returns 2.5066282749176025 +*/ +declare const FLOAT32_SQRT_TWO_PI: number; + + +// EXPORTS // + +export = FLOAT32_SQRT_TWO_PI; diff --git a/float32/sqrt-two-pi/docs/types/test.ts b/float32/sqrt-two-pi/docs/types/test.ts new file mode 100644 index 0000000..c984701 --- /dev/null +++ b/float32/sqrt-two-pi/docs/types/test.ts @@ -0,0 +1,28 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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_SQRT_TWO_PI = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT32_SQRT_TWO_PI; // $ExpectType number +} diff --git a/float32/sqrt-two-pi/examples/index.js b/float32/sqrt-two-pi/examples/index.js new file mode 100644 index 0000000..30d271e --- /dev/null +++ b/float32/sqrt-two-pi/examples/index.js @@ -0,0 +1,24 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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_SQRT_TWO_PI = require( './../lib' ); + +console.log( FLOAT32_SQRT_TWO_PI ); +// => 2.5066282749176025 diff --git a/float32/sqrt-two-pi/include/stdlib/constants/float32/sqrt_two_pi.h b/float32/sqrt-two-pi/include/stdlib/constants/float32/sqrt_two_pi.h new file mode 100644 index 0000000..d3bb066 --- /dev/null +++ b/float32/sqrt-two-pi/include/stdlib/constants/float32/sqrt_two_pi.h @@ -0,0 +1,27 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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_SQRT_TWO_PI_H +#define STDLIB_CONSTANTS_FLOAT32_SQRT_TWO_PI_H + +/** +* Macro for the square root of 2π as a single-precision floating-point number. +*/ +#define STDLIB_CONSTANT_FLOAT32_SQRT_TWO_PI 2.5066282749176025f + +#endif // !STDLIB_CONSTANTS_FLOAT32_SQRT_TWO_PI_H diff --git a/float32/sqrt-two-pi/lib/index.js b/float32/sqrt-two-pi/lib/index.js new file mode 100644 index 0000000..2e0e752 --- /dev/null +++ b/float32/sqrt-two-pi/lib/index.js @@ -0,0 +1,52 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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'; + +/** +* Square root of the mathematical constant `π` times `2` as a single-precision floating-point number. +* +* @module @stdlib/constants/float32/sqrt-two-pi +* @type {number} +* +* @example +* var FLOAT32_SQRT_TWO_PI = require( '@stdlib/constants/float32/sqrt-two-pi' ); +* // returns 2.5066282749176025 +*/ + +// MODULES // + +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); + + +// MAIN // + +/** +* Square root of the mathematical constant `π` times `2` as a single-precision floating-point number. +* +* @constant +* @type {number} +* @default 2.5066282749176025 +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi} +*/ +var FLOAT32_SQRT_TWO_PI = float64ToFloat32( 2.506628274631000502415765284811045253e+00 ); // eslint-disable-line max-len + + +// EXPORTS // + +module.exports = FLOAT32_SQRT_TWO_PI; diff --git a/float32/sqrt-two-pi/manifest.json b/float32/sqrt-two-pi/manifest.json new file mode 100644 index 0000000..844d692 --- /dev/null +++ b/float32/sqrt-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/float32/sqrt-two-pi/package.json b/float32/sqrt-two-pi/package.json new file mode 100644 index 0000000..1b44d37 --- /dev/null +++ b/float32/sqrt-two-pi/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/constants/float32/sqrt-two-pi", + "version": "0.0.0", + "description": "Square root of 2π as a 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", + "pi", + "2pi", + "sqrt", + "square", + "root", + "ieee754", + "float", + "single", + "floating-point", + "float32" + ] +} diff --git a/float32/sqrt-two-pi/test/test.js b/float32/sqrt-two-pi/test/test.js new file mode 100644 index 0000000..80c0d24 --- /dev/null +++ b/float32/sqrt-two-pi/test/test.js @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 FLOAT32_SQRT_TWO_PI = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_SQRT_TWO_PI, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is a single-precision floating-point number equal to square root of the `π` times `2`', function test( t ) { + t.equal( FLOAT32_SQRT_TWO_PI, 2.5066282749176025, 'returns expected value' ); + t.end(); +});