Auto-generated commit

stdlib-js · Dec 13, 2024 · eedb8d2 · eedb8d2
1 parent cd9fb92
commit eedb8d2
Show file tree

Hide file tree

Showing 11 changed files with 506 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-10)
+## Unreleased (2024-12-13)
 
 <section class="packages">
 
@@ -32,6 +32,40 @@
 
 <!-- /.package -->
 
+<section class="package" id="constants-float32-ln-pi-unreleased">
+
+#### [@stdlib/constants/float32/ln-pi](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-pi)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`fc8571d`](https://github.com/stdlib-js/stdlib/commit/fc8571d4e2f7981711a85db47ef8d4acfecfba32) - add `constants/float32/ln-pi` [(#3342)](https://github.com/stdlib-js/stdlib/pull/3342)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+##### Closed Issues
+
+This release closes the following issue:
+
+[#3344](https://github.com/stdlib-js/stdlib/issues/3344)
+
+</section>
+
+<!-- /.issues -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="constants-float32-ln-two-unreleased">
 
 #### [@stdlib/constants/float32/ln-two](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-two)
@@ -414,9 +448,9 @@ This release closes the following issue:
 
 ### Closed Issues
 
-A total of 5 issues were closed in this release:
+A total of 6 issues were closed in this release:
 
-[#3090](https://github.com/stdlib-js/stdlib/issues/3090), [#3093](https://github.com/stdlib-js/stdlib/issues/3093), [#3094](https://github.com/stdlib-js/stdlib/issues/3094), [#3325](https://github.com/stdlib-js/stdlib/issues/3325), [#3327](https://github.com/stdlib-js/stdlib/issues/3327)
+[#3090](https://github.com/stdlib-js/stdlib/issues/3090), [#3093](https://github.com/stdlib-js/stdlib/issues/3093), [#3094](https://github.com/stdlib-js/stdlib/issues/3094), [#3325](https://github.com/stdlib-js/stdlib/issues/3325), [#3327](https://github.com/stdlib-js/stdlib/issues/3327), [#3344](https://github.com/stdlib-js/stdlib/issues/3344)
 
 </section>
 
@@ -426,14 +460,15 @@ A total of 5 issues were closed in this release:
 
 ### Contributors
 
-A total of 6 people contributed to this release. Thank you to the following contributors:
+A total of 7 people contributed to this release. Thank you to the following contributors:
 
 -   Aayush Khanna
 -   Athan Reines
 -   Gunj Joshi
 -   Gururaj Gurram
 -   Manvith M
 -   Philipp Burckhardt
+-   Vivek maurya
 
 </section>
 
@@ -445,6 +480,7 @@ A total of 6 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`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)_
 -   [`d7dc119`](https://github.com/stdlib-js/stdlib/commit/d7dc1197d55a17e6d3f9df1c17b2e13fe57df916) - **fix:** ensure header files reside in correct directories _(by Philipp Burckhardt)_
 -   [`1c56b73`](https://github.com/stdlib-js/stdlib/commit/1c56b737ec018cc818cebf19e5c7947fa684e126) - **docs:** update related packages sections [(#3380)](https://github.com/stdlib-js/stdlib/pull/3380) _(by stdlib-bot)_
 -   [`7e8187a`](https://github.com/stdlib-js/stdlib/commit/7e8187a766886c2fb9cdc356cf781f0a1802172c) - **docs:** update related packages sections [(#3368)](https://github.com/stdlib-js/stdlib/pull/3368) _(by stdlib-bot)_

diff --git a/float32/ln-pi/README.md b/float32/ln-pi/README.md
@@ -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_LN_PI
+
+> Natural logarithm of the mathematical constant [π][pi] as a single-precision floating-point number.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var FLOAT32_LN_PI = require( '@stdlib/constants/float32/ln-pi' );
+```
+
+#### FLOAT32_LN_PI
+
+Natural logarithm of the mathematical constant [π][pi] as a single-precision floating-point number.
+
+```javascript
+var bool = ( FLOAT32_LN_PI === 1.1447298526763916 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better example -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT32_LN_PI = require( '@stdlib/constants/float32/ln-pi' );
+
+console.log( FLOAT32_LN_PI );
+// => 1.1447298526763916
+```
+
+</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/ln_pi.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT32_LN_PI
+
+Macro for the natural logarithm of the mathematical constant [π][pi] 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/pi`][@stdlib/constants/float32/pi]</span><span class="delimiter">: </span><span class="description">π.</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
+
+<!-- <related-links> -->
+
+[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/constants/tree/main/float32/pi
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->
diff --git a/float32/ln-pi/docs/repl.txt b/float32/ln-pi/docs/repl.txt
@@ -0,0 +1,13 @@
+
+{{alias}}
+    Natural logarithm of the mathematical constant `π` as a single-precision
+    floating-point number.
+
+    Examples
+    --------
+    > {{alias}}
+    1.1447298526763916
+
+    See Also
+    --------
+
diff --git a/float32/ln-pi/docs/types/index.d.ts b/float32/ln-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
+
+/**
+* Natural logarithm of the mathematical constant `π` as a single-precision floating-point number.
+*
+* @example
+* var val = FLOAT32_LN_PI;
+* // returns 1.1447298526763916
+*/
+declare const FLOAT32_LN_PI: number;
+
+
+// EXPORTS //
+
+export = FLOAT32_LN_PI;
diff --git a/float32/ln-pi/docs/types/test.ts b/float32/ln-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_LN_PI = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT32_LN_PI; // $ExpectType number
+}
diff --git a/float32/ln-pi/examples/index.js b/float32/ln-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_LN_PI = require( './../lib' );
+
+console.log( FLOAT32_LN_PI );
+// => 1.1447298526763916
diff --git a/float32/ln-pi/include/stdlib/constants/float32/ln_pi.h b/float32/ln-pi/include/stdlib/constants/float32/ln_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_LN_PI_H
+#define STDLIB_CONSTANTS_FLOAT32_LN_PI_H
+
+/**
+* Macro for the natural logarithm of π as a single-precision floating-point number.
+*/
+#define STDLIB_CONSTANT_FLOAT32_LN_PI 1.1447298526763916f
+
+#endif // !STDLIB_CONSTANTS_FLOAT32_LN_PI_H