refactor: apply suggestions from previous PRs

anandkaranubc · anandkaranubc · commit 52afe5278fff · 2025-01-10T23:42:26.000-08:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: missing_dependencies
  - task: lint_c_examples
    status: missing_dependencies
  - task: lint_c_benchmarks
    status: missing_dependencies
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: passed
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: passed
  - task: run_c_benchmarks
    status: passed
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/README.md
@@ -204,7 +204,7 @@ for ( i = 0; i < 10; i++ ) {
 
 #### stdlib_base_negative_binomial_mgf( t, r, p )
 
-Evaluates the moment-generating function (MGF) for a negative binomial distribution.ion function (CDF) for an arcsine distribution.
+Evaluates the [moment-generating function][mgf] for a [negative binomial][negative-binomial-distribution] distribution with number of successes until experiment is stopped `r` and success probability `p`.
 
 ```c
 double out = stdlib_base_negative_binomial_mgf( 0.05, 20.0, 0.8 );
@@ -258,10 +258,10 @@ int main( void ) {
 
     for ( i = 0; i < 25; i++ ) {
         t = random_uniform( -1.0, 1.0 );
-        r = random_uniform( 1.0, 10.0 ); // r must be positive
-        p = random_uniform( 0.0, 1.0 );  // p must be between 0 and 1
+        r = random_uniform( 1.0, 10.0 );
+        p = random_uniform( 0.0, 1.0 );
         y = stdlib_base_negative_binomial_mgf( t, r, p );
-        printf( "t: %lf, r: %lf, p: %lf, MGF(t;r,p): %lf\n", t, r, p, y );
+        printf( "t: %lf, r: %lf, p: %lf, M_X(t;r,p): %lf\n", t, r, p, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/benchmark/c/benchmark.c
@@ -16,12 +16,12 @@
 * limitations under the License.
 */
 
+#include <sys/time.h>
 #include "stdlib/stats/base/dists/negative-binomial/mgf.h"
-#include <stdlib.h>
-#include <stdio.h>
 #include <math.h>
+#include <stdio.h>
+#include <stdlib.h>
 #include <time.h>
-#include <sys/time.h>
 
 #define NAME "negative-binomial-mgf"
 #define ITERATIONS 1000000
@@ -31,7 +31,7 @@
 * Prints the TAP version.
 */
 static void print_version( void ) {
-    printf( "TAP version 13\n" );
+	printf( "TAP version 13\n" );
 }
 
 /**
@@ -41,12 +41,12 @@ static void print_version( void ) {
 * @param passing   total number of passing tests
 */
 static void print_summary( int total, int passing ) {
-    printf( "#\n" );
-    printf( "1..%d\n", total ); // TAP plan
-    printf( "# total %d\n", total );
-    printf( "# pass  %d\n", passing );
-    printf( "#\n" );
-    printf( "# ok\n" );
+	printf( "#\n" );
+	printf( "1..%d\n", total ); // TAP plan
+	printf( "# total %d\n", total );
+	printf( "# pass  %d\n", passing );
+	printf( "#\n" );
+	printf( "# ok\n" );
 }
 
 /**
@@ -55,12 +55,12 @@ static void print_summary( int total, int passing ) {
 * @param elapsed   elapsed time in seconds
 */
 static void print_results( double elapsed ) {
-    double rate = (double)ITERATIONS / elapsed;
-    printf( "  ---\n" );
-    printf( "  iterations: %d\n", ITERATIONS );
-    printf( "  elapsed: %0.9f\n", elapsed );
-    printf( "  rate: %0.9f\n", rate );
-    printf( "  ...\n" );
+	double rate = (double)ITERATIONS / elapsed;
+	printf( "  ---\n" );
+	printf( "  iterations: %d\n", ITERATIONS );
+	printf( "  elapsed: %0.9f\n", elapsed );
+	printf( "  rate: %0.9f\n", rate );
+	printf( "  ...\n" );
 }
 
 /**
@@ -69,9 +69,9 @@ static void print_results( double elapsed ) {
 * @return clock time
 */
 static double tic( void ) {
-    struct timeval now;
-    gettimeofday( &now, NULL );
-    return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
+	struct timeval now;
+	gettimeofday( &now, NULL );
+	return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
 }
 
 /**
@@ -82,8 +82,8 @@ static double tic( void ) {
 * @return       random number
 */
 static double random_uniform( const double min, const double max ) {
-    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
-    return min + ( v*(max-min) );
+	double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+	return min + ( v * ( max - min ) );
 }
 
 /**
@@ -92,51 +92,51 @@ static double random_uniform( const double min, const double max ) {
 * @return elapsed time in seconds
 */
 static double benchmark( void ) {
-    double elapsed;
-    double t[ 100 ];
-    double r[ 100 ];
-    double p[ 100 ];
-    double y;
-    double time;
-    int i;
+	double elapsed;
+	double t[ 100 ];
+	double r[ 100 ];
+	double p[ 100 ];
+	double y;
+	double time;
+	int i;
 
-    for ( i = 0; i < 100; i++ ) {
-        t[ i ] = random_uniform( -2.0, 0.0 );
-        r[ i ] = random_uniform( 1.0, 100.0 );
-        p[ i ] = random_uniform( 0.1, 1.0 );
-    }
+	for ( i = 0; i < 100; i++ ) {
+		t[ i ] = random_uniform( -2.0, 0.0 );
+		r[ i ] = random_uniform( 1.0, 100.0 );
+		p[ i ] = random_uniform( 0.1, 1.0 );
+	}
 
-    time = tic();
-    for ( i = 0; i < ITERATIONS; i++ ) {
-        y = stdlib_base_negative_binomial_mgf( t[ i % 100 ], r[ i % 100 ], p[ i % 100 ] );
-        if ( y != y ) {
-            printf( "should not return NaN\n" );
-            break;
-        }
-    }
-    elapsed = tic() - time;
-    if ( y != y ) {
-        printf( "should not return NaN\n" );
-    }
-    return elapsed;
+	time = tic();
+	for ( i = 0; i < ITERATIONS; i++ ) {
+		y = stdlib_base_negative_binomial_mgf( t[ i % 100 ], r[ i % 100 ], p[ i % 100 ] );
+		if ( y != y ) {
+			printf( "should not return NaN\n" );
+			break;
+		}
+	}
+	elapsed = tic() - time;
+	if ( y != y ) {
+		printf( "should not return NaN\n" );
+	}
+	return elapsed;
 }
 
 /**
 * Main execution sequence.
 */
 int main( void ) {
-    double elapsed;
-    int i;
+	double elapsed;
+	int i;
 
-    // Use the current time to seed the random number generator:
-    srand( time( NULL ) );
+	// Use the current time to seed the random number generator:
+	srand( time( NULL ) );
 
-    print_version();
-    for ( i = 0; i < REPEATS; i++ ) {
-        printf( "# c::%s\n", NAME );
-        elapsed = benchmark();
-        print_results( elapsed );
-        printf( "ok %d benchmark finished\n", i+1 );
-    }
-    print_summary( REPEATS, REPEATS );
+	print_version();
+	for ( i = 0; i < REPEATS; i++ ) {
+		printf( "# c::%s\n", NAME );
+		elapsed = benchmark();
+		print_results( elapsed );
+		printf( "ok %d benchmark finished\n", i + 1 );
+	}
+	print_summary( REPEATS, REPEATS );
 }
diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/examples/c/example.c
@@ -1,44 +1,44 @@
 /**
- * @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.
- */
+* @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.
+*/
 
 #include "stdlib/stats/base/dists/negative-binomial/mgf.h"
-#include <stdlib.h>
 #include <stdio.h>
+#include <stdlib.h>
 
 static double random_uniform( const double min, const double max ) {
-    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
-    return min + ( v * ( max - min ) );
+	double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+	return min + ( v * ( max - min ) );
 }
 
 int main( void ) {
-    double t;
-    double r;
-    double p;
-    double y;
-    int i;
+	double t;
+	double r;
+	double p;
+	double y;
+	int i;
 
-    for ( i = 0; i < 25; i++ ) {
-        t = random_uniform( -1.0, 1.0 );
-        r = random_uniform( 1.0, 10.0 ); // r must be positive
-        p = random_uniform( 0.0, 1.0 );  // p must be between 0 and 1
-        y = stdlib_base_negative_binomial_mgf( t, r, p );
-        printf( "t: %lf, r: %lf, p: %lf, MGF(t;r,p): %lf\n", t, r, p, y );
-    }
+	for ( i = 0; i < 25; i++ ) {
+		t = random_uniform( -1.0, 1.0 );
+		r = random_uniform( 1.0, 10.0 );
+		p = random_uniform( 0.0, 1.0 );
+		y = stdlib_base_negative_binomial_mgf( t, r, p );
+		printf( "t: %lf, r: %lf, p: %lf, M_X(t;r,p): %lf\n", t, r, p, y );
+	}
 
-    return 0;
+	return 0;
 }
diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/include/stdlib/stats/base/dists/negative-binomial/mgf.h b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/include/stdlib/stats/base/dists/negative-binomial/mgf.h
@@ -1,20 +1,20 @@
 /**
- * @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.
- */
+* @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.
+*/
 
 #ifndef STDLIB_STATS_BASE_DISTS_NEGATIVE_BINOMIAL_MGF_H
 #define STDLIB_STATS_BASE_DISTS_NEGATIVE_BINOMIAL_MGF_H
diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/src/addon.c
@@ -1,20 +1,20 @@
 /**
- * @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.
- */
+* @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.
+*/
 
 #include "stdlib/stats/base/dists/negative-binomial/mgf.h"
 #include "stdlib/math/base/napi/ternary.h"
diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/mgf/src/main.c
