diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/README.md b/lib/node_modules/@stdlib/constants/float32/pi-squared/README.md new file mode 100644 index 000000000000..240d4c9c9f13 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/README.md @@ -0,0 +1,135 @@ + + +# FLOAT32_PI_SQUARED + +> [π][@stdlib/constants/float32/pi]². + +
+ +## Usage + +```javascript +var FLOAT32_PI_SQUARED = require( '@stdlib/constants/float32/pi-squared' ); +``` + +#### FLOAT32_PI_SQUARED + +Square of the mathematical constant [π][@stdlib/constants/float32/pi]. + +```javascript +var bool = ( FLOAT32_PI_SQUARED === 9.869604110717773 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT32_PI_SQUARED = require( '@stdlib/constants/float32/pi-squared' ); + +console.log( FLOAT32_PI_SQUARED ); +// => 9.869604110717773 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float32/pi_squared.h" +``` + +#### STDLIB_CONSTANT_FLOAT32_PI_SQUARED + +Macro for the square of the mathematical constant [π][@stdlib/constants/float32/pi]. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/repl.txt b/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/repl.txt new file mode 100644 index 000000000000..849755343e47 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/repl.txt @@ -0,0 +1,12 @@ + +{{alias}} + Square of the mathematical constant `π`. + + Examples + -------- + > {{alias}} + 9.869604110717773 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/types/index.d.ts new file mode 100644 index 000000000000..eff3312b900e --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/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 + +/** +* Square of the mathematical constant `π`. +* +* @example +* var val = FLOAT32_PI_SQUARED; +* // returns 9.869604110717773 +*/ +declare const FLOAT32_PI_SQUARED: number; + + +// EXPORTS // + +export = FLOAT32_PI_SQUARED; diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/pi-squared/docs/types/test.ts new file mode 100644 index 000000000000..9e360316dc9b --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/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_PI_SQUARED = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT32_PI_SQUARED; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/examples/index.js b/lib/node_modules/@stdlib/constants/float32/pi-squared/examples/index.js new file mode 100644 index 000000000000..f8640ea050e3 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/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_PI_SQUARED = require( './../lib' ); + +console.log( FLOAT32_PI_SQUARED ); +// => 9.869604110717773 diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/include/stdlib/constants/float32/pi_squared.h b/lib/node_modules/@stdlib/constants/float32/pi-squared/include/stdlib/constants/float32/pi_squared.h new file mode 100644 index 000000000000..abe8aaa0b621 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/include/stdlib/constants/float32/pi_squared.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_PI_SQUARED_H +#define STDLIB_CONSTANTS_FLOAT32_PI_SQUARED_H + +/** +* Macro for π². +*/ +#define STDLIB_CONSTANT_FLOAT32_PI_SQUARED 9.869604401089358f + +#endif // !STDLIB_CONSTANTS_FLOAT32_PI_SQUARED_H diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/lib/index.js b/lib/node_modules/@stdlib/constants/float32/pi-squared/lib/index.js new file mode 100644 index 000000000000..05f320fbdf86 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/lib/index.js @@ -0,0 +1,52 @@ +/** +* @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'; + +/** +* Square of the mathematical constant `π`. +* +* @module @stdlib/constants/float32/pi-squared +* @type {number} +* +* @example +* var FLOAT32_PI_SQUARED = require( '@stdlib/constants/float32/pi-squared' ); +* // returns 9.869604110717773 +*/ + +// MODULES // + +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); + + +// MAIN // + +/** +* Square of the mathematical constant `π`. +* +* @constant +* @type {number} +* @default 9.869604110717773 +* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi} +*/ +var FLOAT32_PI_SQUARED = float64ToFloat32( 9.869604401089358 ); + + +// EXPORTS // + +module.exports = FLOAT32_PI_SQUARED; diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/manifest.json b/lib/node_modules/@stdlib/constants/float32/pi-squared/manifest.json new file mode 100644 index 000000000000..844d692f6439 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/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/pi-squared/package.json b/lib/node_modules/@stdlib/constants/float32/pi-squared/package.json new file mode 100644 index 000000000000..c1dc59318bcb --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/constants/float32/pi-squared", + "version": "0.0.0", + "description": "π².", + "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", + "ieee754", + "floating-point", + "float", + "float32", + "squared" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float32/pi-squared/test/test.js b/lib/node_modules/@stdlib/constants/float32/pi-squared/test/test.js new file mode 100644 index 000000000000..f0fa39f44608 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/pi-squared/test/test.js @@ -0,0 +1,57 @@ +/** +* @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 pow = require( '@stdlib/math/base/special/pow' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var PI = require( '@stdlib/constants/float32/pi' ); +var FLOAT32_PI_SQUARED = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_PI_SQUARED, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'export is a double-precision floating-point number equal to 9.869604110717773', function test( t ) { + t.equal( FLOAT32_PI_SQUARED, 9.869604110717773, 'equals 9.869604110717773' ); + t.end(); +}); + +tape( 'export equals π²', function test( t ) { + var delta; + var tol; + var v; + + v = float64ToFloat32( pow( PI, 2 ) ); + + delta = absf( FLOAT32_PI_SQUARED - v ); + tol = EPS * v; + + t.ok( delta <= tol, 'equals π² within tolerance '+tol+'. v: '+v+'. π²: '+FLOAT32_PI_SQUARED+'.' ); + t.end(); +});