feat: add constants/float16/pi-squared

PR-URL: #8928
Reviewed-by: Athan Reines <[email protected]>

Author: DivyanshuVortex

lib/node_modules/@stdlib/constants/float16/pi-squared/README.md

@@ -0,0 +1,77 @@
+<!--
+
+@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.
+
+-->
+
+# FLOAT16_PI_SQUARED
+
+> [π][@stdlib/constants/float16/pi]².
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var FLOAT16_PI_SQUARED = require( '@stdlib/constants/float16/pi-squared' );
+```
+
+#### FLOAT16_PI_SQUARED
+
+Square of the mathematical constant [π][@stdlib/constants/float16/pi].
+
+```javascript
+var bool = ( FLOAT16_PI_SQUARED === 9.8671875 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better example -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT16_PI_SQUARED = require( '@stdlib/constants/float16/pi-squared' );
+
+console.log( FLOAT16_PI_SQUARED );
+// => 9.8671875
+```
+
+</section>
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/constants/float16/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/pi
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/pi-squared/docs/repl.txt

@@ -0,0 +1,12 @@
+
+{{alias}}
+    Square of the mathematical constant `π`.
+
+    Examples
+    --------
+    > {{alias}}
+    9.8671875
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/constants/float16/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 = FLOAT16_PI_SQUARED;
+* // returns 9.8671875
+*/
+declare const FLOAT16_PI_SQUARED: number;
+
+
+// EXPORTS //
+
+export = FLOAT16_PI_SQUARED;

lib/node_modules/@stdlib/constants/float16/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 FLOAT16_PI_SQUARED = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT16_PI_SQUARED; // $ExpectType number
+}

lib/node_modules/@stdlib/constants/float16/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 FLOAT16_PI_SQUARED = require( './../lib' );
+
+console.log( FLOAT16_PI_SQUARED );
+// => 9.8671875

lib/node_modules/@stdlib/constants/float16/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/float16/pi-squared
+* @type {number}
+*
+* @example
+* var FLOAT16_PI_SQUARED = require( '@stdlib/constants/float16/pi-squared' );
+* // returns 9.8671875
+*/
+
+// MODULES //
+
+var float64ToFloat16 = require( '@stdlib/number/float64/base/to-float16' );
+
+
+// MAIN //
+
+/**
+* Square of the mathematical constant `π`.
+*
+* @constant
+* @type {number}
+* @default 9.8671875
+* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi}
+*/
+var FLOAT16_PI_SQUARED = float64ToFloat16( 9.8671875 );
+
+
+// EXPORTS //
+
+module.exports = FLOAT16_PI_SQUARED;

lib/node_modules/@stdlib/constants/float16/pi-squared/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@stdlib/constants/float16/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",
+    "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",
+    "float16",
+    "squared"
+  ]
+}

lib/node_modules/@stdlib/constants/float16/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 float64ToFloat16 = require( '@stdlib/number/float64/base/to-float16' );
+var EPS = require( '@stdlib/constants/float16/eps' );
+var PI = require( '@stdlib/constants/float32/pi' );
+var FLOAT16_PI_SQUARED = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a number', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof FLOAT16_PI_SQUARED, 'number', 'main export is a number' );
+	t.end();
+});
+
+tape( 'export is a half-precision floating-point number equal to 9.8671875', function test( t ) {
+	t.strictEqual( FLOAT16_PI_SQUARED, 9.8671875, 'returns expected value' );
+	t.end();
+});
+
+tape( 'export equals π²', function test( t ) {
+	var delta;
+	var tol;
+	var v;
+
+	v = float64ToFloat16( pow( PI, 2 ) );
+
+	delta = absf( FLOAT16_PI_SQUARED - v );
+	tol = EPS * v;
+
+	t.ok( delta <= tol, 'equals π² within tolerance '+tol+'. v: '+v+'. π²: '+FLOAT16_PI_SQUARED+'.' );
+	t.end();
+});