Auto-generated commit

stdlib-js · Aug 1, 2024 · 1c66f15 · 1c66f15
1 parent dbaab30
commit 1c66f15
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 124 deletions.
diff --git a/.github/.keepalive b/.github/.keepalive
@@ -0,0 +1 @@
+2024-08-01T03:48:33.821Z
diff --git a/.gitignore b/.gitignore
@@ -101,6 +101,8 @@ docs/**/node_modules/
 pids
 *.pid
 *.seed
+yarn.lock
+package-lock.json
 
 # Typescript #
 ##############

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,20 +2,17 @@
 
 > Package changelog.
 
-<section class="release" id="v0.2.2">
+<section class="release" id="unreleased">
 
-## 0.2.2 (2024-07-28)
+## Unreleased (2024-08-01)
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
--   [`5d37de2`](https://github.com/stdlib-js/stdlib/commit/5d37de2476ae2eb3e0f4fd196a092f26120a5478) - **docs:** update style and examples [(#2189)](https://github.com/stdlib-js/stdlib/pull/2189) _(by Gunj Joshi)_
--   [`700d3df`](https://github.com/stdlib-js/stdlib/commit/700d3dfcc75d9e6615f7199f123b80cdcbe2fec0) - **docs:** fix example return value [(#2186)](https://github.com/stdlib-js/stdlib/pull/2186) _(by Gunj Joshi)_
--   [`41d41e9`](https://github.com/stdlib-js/stdlib/commit/41d41e959b4eaad3c631e6898e3144a4015a5458) - **test:** include trailing newlines in Julia-generated JSON fixtures _(by Philipp Burckhardt)_
--   [`9ed7d0e`](https://github.com/stdlib-js/stdlib/commit/9ed7d0e7d57edb5ad0dfb65c944bed87d475cbf3) - **chore:** add missing trailing newlines _(by Philipp Burckhardt)_
+-   [`22c4d29`](https://github.com/stdlib-js/stdlib/commit/22c4d29898e2b5bb4cb071a6b7f62536027eaf28) - **docs:** remove blank line _(by Athan Reines)_
 
 </details>
 
@@ -27,10 +24,9 @@
 
 ### Contributors
 
-A total of 2 people contributed to this release. Thank you to the following contributors:
+A total of 1 person contributed to this release. Thank you to this contributor:
 
--   Gunj Joshi
--   Philipp Burckhardt
+-   Athan Reines
 
 </section>
 
@@ -40,45 +36,31 @@ A total of 2 people contributed to this release. Thank you to the following cont
 
 <!-- /.release -->
 
-<section class="release" id="v0.2.1">
+<section class="release" id="v0.2.2">
 
-## 0.2.1 (2024-02-24)
+## 0.2.2 (2024-07-28)
 
 No changes reported for this release.
 
 </section>
 
 <!-- /.release -->
 
-<section class="release" id="v0.2.0">
-
-## 0.2.0 (2024-02-14)
-
-<section class="commits">
-
-### Commits
-
-<details>
+<section class="release" id="v0.2.1">
 
--   [`215dfe6`](https://github.com/stdlib-js/stdlib/commit/215dfe690670731f044d09c92832081bc99372cc) - **docs:** update links _(by Athan Reines)_
+## 0.2.1 (2024-02-24)
 
-</details>
+No changes reported for this release.
 
 </section>
 
-<!-- /.commits -->
-
-<section class="contributors">
-
-### Contributors
-
-A total of 1 person contributed to this release. Thank you to this contributor:
+<!-- /.release -->
 
--   Athan Reines
+<section class="release" id="v0.2.0">
 
-</section>
+## 0.2.0 (2024-02-14)
 
-<!-- /.contributors -->
+No changes reported for this release.
 
 </section>
 
@@ -98,61 +80,7 @@ No changes reported for this release.
 
 ## 0.1.0 (2023-09-23)
 
-<section class="features">
-
-### Features
-
--   [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9) - update minimum TypeScript version
-
-</section>
-
-<!-- /.features -->
-
-<section class="breaking-changes">
-
-### BREAKING CHANGES
-
--   [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9): update minimum TypeScript version
--   [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9): update minimum TypeScript version to 4.1 
-
-    -   To migrate, users should upgrade their TypeScript version to at least version 4.1.
-
-</section>
-
-<!-- /.breaking-changes -->
-
-<section class="commits">
-
-### Commits
-
-<details>
-
--   [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9) - **feat:** update minimum TypeScript version _(by Philipp Burckhardt)_
--   [`b734544`](https://github.com/stdlib-js/stdlib/commit/b734544a52783cb7f5cf1115f4355cabe46d0abe) - **refactor:** use strictEqual checks _(by Philipp Burckhardt)_
--   [`ce7e336`](https://github.com/stdlib-js/stdlib/commit/ce7e3367c0f9477773fe76dd0eca64dc6ad33c02) - **docs:** update equations _(by Philipp Burckhardt)_
--   [`5363054`](https://github.com/stdlib-js/stdlib/commit/536305400d60ff7450198139f2f9aef9eb06581a) - **docs:** resolve C lint errors _(by Athan Reines)_
--   [`b9e414a`](https://github.com/stdlib-js/stdlib/commit/b9e414a8958f7e59ebf824db6923eb6aba0010a0) - **docs:** resolve C lint errors _(by Athan Reines)_
--   [`28e1c84`](https://github.com/stdlib-js/stdlib/commit/28e1c84390d88044883c9ef940a12f38d66ea3ef) - **docs:** resolve C lint errors _(by Athan Reines)_
--   [`c5da1f9`](https://github.com/stdlib-js/stdlib/commit/c5da1f9a22b1033d40115798acf13a09acf9410d) - **docs:** render equations via math code blocks _(by Philipp Burckhardt)_
-
-</details>
-
-</section>
-
-<!-- /.commits -->
-
-<section class="contributors">
-
-### Contributors
-
-A total of 2 people contributed to this release. Thank you to the following contributors:
-
--   Athan Reines
--   Philipp Burckhardt
-
-</section>
-
-<!-- /.contributors -->
+No changes reported for this release.
 
 </section>
 

diff --git a/README.md b/README.md
@@ -266,8 +266,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-rcbrt.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-rcbrt
 
-[test-image]: https://github.com/stdlib-js/math-base-special-rcbrt/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/math-base-special-rcbrt/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/math-base-special-rcbrt/actions/workflows/test.yml/badge.svg?branch=main
+[test-url]: https://github.com/stdlib-js/math-base-special-rcbrt/actions/workflows/test.yml?query=branch:main
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-rcbrt/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-rcbrt?branch=main

diff --git a/benchmark/c/benchmark.c b/benchmark/c/benchmark.c
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Benchmark `rcbrt`.
-*/
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>
@@ -32,7 +29,7 @@
 /**
 * Prints the TAP version.
 */
-void print_version() {
+static void print_version( void ) {
 	printf( "TAP version 13\n" );
 }
 
@@ -42,7 +39,7 @@ void print_version() {
 * @param total     total number of tests
 * @param passing   total number of passing tests
 */
-void print_summary( int total, int passing ) {
+static void print_summary( int total, int passing ) {
 	printf( "#\n" );
 	printf( "1..%d\n", total ); // TAP plan
 	printf( "# total %d\n", total );
@@ -56,7 +53,7 @@ void print_summary( int total, int passing ) {
 *
 * @param elapsed   elapsed time in seconds
 */
-void print_results( double elapsed ) {
+static void print_results( double elapsed ) {
 	double rate = (double)ITERATIONS / elapsed;
 	printf( "  ---\n" );
 	printf( "  iterations: %d\n", ITERATIONS );
@@ -70,18 +67,18 @@ void print_results( double elapsed ) {
 *
 * @return clock time
 */
-double tic() {
+static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
 	return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
 }
 
 /**
-* Generates a random number on the interval [0,1].
+* Generates a random number on the interval [0,1).
 *
 * @return random number
 */
-double rand_double() {
+static double rand_double( void ) {
 	int r = rand();
 	return (double)r / ( (double)RAND_MAX + 1.0 );
 }
@@ -91,7 +88,7 @@ double rand_double() {
 *
 * @return elapsed time in seconds
 */
-double benchmark() {
+static double benchmark( void ) {
 	double elapsed;
 	double x;
 	double y;

diff --git a/benchmark/c/cephes/benchmark.c b/benchmark/c/cephes/benchmark.c
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Benchmark Cephes.
-*/
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>
@@ -37,7 +34,7 @@ extern double cbrt( double x );
 /**
 * Prints the TAP version.
 */
-void print_version() {
+static void print_version( void ) {
 	printf( "TAP version 13\n" );
 }
 
@@ -47,7 +44,7 @@ void print_version() {
 * @param total     total number of tests
 * @param passing   total number of passing tests
 */
-void print_summary( int total, int passing ) {
+static void print_summary( int total, int passing ) {
 	printf( "#\n" );
 	printf( "1..%d\n", total ); // TAP plan
 	printf( "# total %d\n", total );
@@ -61,7 +58,7 @@ void print_summary( int total, int passing ) {
 *
 * @param elapsed   elapsed time in seconds
 */
-void print_results( double elapsed ) {
+static void print_results( double elapsed ) {
 	double rate = (double)ITERATIONS / elapsed;
 	printf( "  ---\n" );
 	printf( "  iterations: %d\n", ITERATIONS );
@@ -75,18 +72,18 @@ void print_results( double elapsed ) {
 *
 * @return clock time
 */
-double tic() {
+static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
 	return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
 }
 
 /**
-* Generates a random number on the interval [0,1].
+* Generates a random number on the interval [0,1).
 *
 * @return random number
 */
-double rand_double() {
+static double rand_double( void ) {
 	int r = rand();
 	return (double)r / ( (double)RAND_MAX + 1.0 );
 }
@@ -96,7 +93,7 @@ double rand_double() {
 *
 * @return elapsed time in seconds
 */
-double benchmark() {
+static double benchmark( void ) {
 	double elapsed;
 	double x;
 	double y;

diff --git a/benchmark/c/native/benchmark.c b/benchmark/c/native/benchmark.c
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Benchmark `rcbrt`.
-*/
 #include "stdlib/math/base/special/rcbrt.h"
 #include <stdlib.h>
 #include <stdio.h>
@@ -33,7 +30,7 @@
 /**
 * Prints the TAP version.
 */
-void print_version() {
+static void print_version( void ) {
 	printf( "TAP version 13\n" );
 }
 
@@ -43,7 +40,7 @@ void print_version() {
 * @param total     total number of tests
 * @param passing   total number of passing tests
 */
-void print_summary( int total, int passing ) {
+static void print_summary( int total, int passing ) {
 	printf( "#\n" );
 	printf( "1..%d\n", total ); // TAP plan
 	printf( "# total %d\n", total );
@@ -57,7 +54,7 @@ void print_summary( int total, int passing ) {
 *
 * @param elapsed   elapsed time in seconds
 */
-void print_results( double elapsed ) {
+static void print_results( double elapsed ) {
 	double rate = (double)ITERATIONS / elapsed;
 	printf( "  ---\n" );
 	printf( "  iterations: %d\n", ITERATIONS );
@@ -71,18 +68,18 @@ void print_results( double elapsed ) {
 *
 * @return clock time
 */
-double tic() {
+static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
 	return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
 }
 
 /**
-* Generates a random number on the interval [0,1].
+* Generates a random number on the interval [0,1).
 *
 * @return random number
 */
-double rand_double() {
+static double rand_double( void ) {
 	int r = rand();
 	return (double)r / ( (double)RAND_MAX + 1.0 );
 }
@@ -92,7 +89,7 @@ double rand_double() {
 *
 * @return elapsed time in seconds
 */
-double benchmark() {
+static double benchmark( void ) {
 	double elapsed;
 	double x;
 	double y;

diff --git a/include/stdlib/math/base/special/rcbrt.h b/include/stdlib/math/base/special/rcbrt.h
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Header file containing function declarations.
-*/
 #ifndef STDLIB_MATH_BASE_SPECIAL_RCBRT_H
 #define STDLIB_MATH_BASE_SPECIAL_RCBRT_H