Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/inv-pi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<!--

@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_INV_PI

> Inverse of the mathematical constant [π][pi].

<section class="usage">

## Usage

```javascript
var FLOAT16_INV_PI = require( '@stdlib/constants/float16/inv-pi' );
```

#### FLOAT16_INV_PI

Inverse of the mathematical constant [π][pi].

```javascript
var bool = ( FLOAT16_INV_PI === 0.31835937 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var FLOAT16_INV_PI = require( '@stdlib/constants/float16/inv-pi' );

console.log( FLOAT16_INV_PI );
// => 0.31835937
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float16/pi`][@stdlib/constants/float16/pi]</span><span class="delimiter">: </span><span class="description">π.</span>
- <span class="package-name">[`@stdlib/constants/float64/inv-pi`][@stdlib/constants/float64/inv-pi]</span><span class="delimiter">: </span><span class="description">inverse π.</span>

</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">

[pi]: https://en.wikipedia.org/wiki/Pi
[@stdlib/constants/float16/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/pi
[@stdlib/constants/float64/inv-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/inv-pi

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/inv-pi/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

{{alias}}
Inverse of the mathematical constant `π` (1/π).

Examples
--------
> {{alias}}
0.31835937

See Also
--------

Original file line number Diff line number Diff line change
@@ -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

/**
* Inverse of the mathematical constant `π` (1/π).
*
* @example
* var val = FLOAT16_INV_PI;
* // returns 0.31835937
*/
declare const FLOAT16_INV_PI: number;


// EXPORTS //

export = FLOAT16_INV_PI;
Original file line number Diff line number Diff line change
@@ -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_INV_PI = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_INV_PI; // $ExpectType number
}
Original file line number Diff line number Diff line change
@@ -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_INV_PI = require( './../lib' );

console.log( FLOAT16_INV_PI );
// => 0.31835937
48 changes: 48 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/inv-pi/lib/index.js
Original file line number Diff line number Diff line change
@@ -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';

/**
* Inverse of the mathematical constant `π` (1/π).
*
* @module @stdlib/constants/float16/inv-pi
* @type {number}
*
* @example
* var FLOAT16_INV_PI = require( '@stdlib/constants/float16/inv-pi' );
* // returns 0.31835937
*/


// MAIN //

/**
* Inverse of the mathematical constant `π` (1/π).
*
* @constant
* @type {number}
* @default 0.31835937
* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi}
*/
var FLOAT16_INV_PI = 0.31835937;


// EXPORTS //

module.exports = FLOAT16_INV_PI;
65 changes: 65 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/inv-pi/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"name": "@stdlib/constants/float16/inv-pi",
"version": "0.0.0",
"description": "Inverse π (1/π).",
"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",
"inverse",
"inv",
"pi",
"ieee754",
"float",
"floating-point",
"float16"
]
}
38 changes: 38 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/inv-pi/test/test.js
Original file line number Diff line number Diff line change
@@ -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_INV_PI = require( './../lib' );


// TESTS //

tape( 'main export is a number', function test( t ) {
t.ok( true, __filename );
t.strictEqual( typeof FLOAT16_INV_PI, 'number', 'main export is a number' );
t.end();
});

tape( 'export is a half-precision floating-point number equal to 0.31835937', function test( t ) {
t.strictEqual( FLOAT16_INV_PI, 0.31835937, 'returns expected value' );
t.end();
});