Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Dec 13, 2024
1 parent 905d19e commit 9c90b2b
Show file tree
Hide file tree
Showing 12 changed files with 490 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,28 @@ This release closes the following issue:

<!-- /.package -->

<section class="package" id="constants-float32-sqrt-two-pi-unreleased">

#### [@stdlib/constants/float32/sqrt-two-pi](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-two-pi)

<details>

<section class="features">

##### 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)

</section>

<!-- /.features -->

</details>

</section>

<!-- /.package -->

<section class="package" id="constants-float64-max-safe-nth-tribonacci-unreleased">

#### [@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)
Expand Down Expand Up @@ -548,6 +570,7 @@ A total of 7 people contributed to this release. Thank you to the following cont

<details>

- [`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)_
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
Varad Gupta <varadgupta21@gmail.com>
Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
Vivek maurya <155618190+vivekmaurya001@users.noreply.github.com>
Xiaochuan Ye <tap91624@gmail.com>
Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
Expand Down
147 changes: 147 additions & 0 deletions float32/sqrt-two-pi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!--
@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.
-->

# FLOAT32_SQRT_TWO_PI

> Square root of the mathematical constant [π][@stdlib/constants/float32/pi] times 2 as a single-precision floating-point number.
<section class="usage">

## 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
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

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

```javascript
var FLOAT32_SQRT_TWO_PI = require( '@stdlib/constants/float32/sqrt-two-pi' );

console.log( FLOAT32_SQRT_TWO_PI );
// => 2.5066282749176025
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### 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.

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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/float32/two-pi`][@stdlib/constants/float32/two-pi]</span><span class="delimiter">: </span><span class="description">2π.</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">

[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/constants/tree/main/float32/pi

<!-- <related-links> -->

[@stdlib/constants/float32/two-pi]: https://github.com/stdlib-js/constants/tree/main/float32/two-pi

<!-- </related-links> -->

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions float32/sqrt-two-pi/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

{{alias}}
Square root of the `π` times `2` as single-precision floating-point number.

Examples
--------
> {{alias}}
2.5066282749176025

See Also
--------

33 changes: 33 additions & 0 deletions float32/sqrt-two-pi/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -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;
28 changes: 28 additions & 0 deletions float32/sqrt-two-pi/docs/types/test.ts
Original file line number Diff line number Diff line change
@@ -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
}
24 changes: 24 additions & 0 deletions float32/sqrt-two-pi/examples/index.js
Original file line number Diff line number Diff line change
@@ -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
27 changes: 27 additions & 0 deletions float32/sqrt-two-pi/include/stdlib/constants/float32/sqrt_two_pi.h
Original file line number Diff line number Diff line change
@@ -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
52 changes: 52 additions & 0 deletions float32/sqrt-two-pi/lib/index.js
Original file line number Diff line number Diff line change
@@ -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;
Loading

0 comments on commit 9c90b2b

Please sign in to comment.