feat(stats): add C implementation for `stats/base/dists/chisquare/mgf` #4593

anandkaranubc · 2025-01-06T00:43:01Z

Resolves

#3506

Description

Purpose of this pull request

This pull request:

Adds a C implementation of the moment-generating function (MGF) for a chi-squared distribution.
Includes benchmarks for the C implementation.
Provides examples demonstrating the usage of the moment-generating function (MGF) for a chi-squared distribution in C.

Related Issues

Does this pull request have any related issues?

This pull request:

Resolves Issue #3506.

Questions

Any questions for reviewers of this pull request?

No.

Other Information

Any other relevant information?

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request:

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

--- 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: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - 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 ---

stdlib-bot · 2025-01-06T00:45:59Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/chisquare/mgf	$\color{green}259/259$ $\color{green}+100.00\%$	$\color{green}19/19$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}259/259$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

anandkaranubc · 2025-01-06T00:46:30Z

/stdlib lint-autofix

anandkaranubc · 2025-01-07T21:18:38Z

@Planeshifter @kgryte

Thank you for the OH. I was wondering if I can get some feedback from you on this PR. This is my most recent PR of all the ones I have created, based on learning from previous ones. I hope I can use the feedback I get on this PR and make any necessary changes in my other PRs as well based on this one. Thank you so much!

Planeshifter · 2025-01-07T23:23:46Z

@anandkaranubc Taking a look now...

Planeshifter · 2025-01-07T23:26:19Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/README.md

+
+        result = stdlib_base_dists_chisquare_mgf( t, k );
+
+        printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result );


See JS example:

Suggested change

printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result );

printf( "t: %lf, k: %lf, M_X(t;k): %lf \n", t, k, result );

Planeshifter · 2025-01-07T23:27:09Z

/stdlib update-copyright-years

Planeshifter · 2025-01-07T23:33:37Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/examples/c/example.c

+
+        result = stdlib_base_dists_chisquare_mgf( t, k );
+
+        printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result );


Suggested change

printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result );

printf( "t: %lf, k: %lf, M_X(t;k): %lf \n", t, k, result );

Planeshifter · 2025-01-07T23:34:02Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/examples/c/example.c

+    double t;
+    double k;
+    double result;
+    int i;


By convention, we order variable declarations by length:

Suggested change

double t;

double k;

double result;

int i;

double result;

double t;

double k;

int i;

thanks for mentioning! Was checking the other PRs comments so that I may fix the similar mistakes in mine! ehe!

Planeshifter · 2025-01-07T23:36:32Z

/stdlib lint-autofix

Planeshifter · 2025-01-07T23:38:12Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/package.json

+    "include": "./include",
    "example": "./examples",


Ordered alphabetically to make the CI linter happy:

Suggested change

"include": "./include",

"example": "./examples",

"example": "./examples",

"include": "./include",

Planeshifter · 2025-01-07T23:40:06Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/examples/c/example.c

+#include <stdio.h>
+
+static double random_uniform( const double min, const double max ) {
+    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );


This file should be tab-indented. We had a bug on CI that caused the EditorConfig linting to not catch these. Make sure you have EditorConfig setup in your IDE; then saving C files should automatically indent them using TABs

Planeshifter · 2025-01-07T23:41:08Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/binding.gyp

+# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
+# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
+{
+    # List of files to include in this file:


Should be two-space indented. Should be correctly formatted on save when EditorConfig is setup.

Planeshifter · 2025-01-07T23:41:33Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/include.gypi

+# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
+# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
+{
+    # Define variables to be used throughout the configuration for all targets:


Two-space indentation.

Planeshifter · 2025-01-07T23:42:13Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/src/main.c

+* @example
+* double y = stdlib_base_dists_chisquare_mgf( 0.4, 2.0 );
+* // returns ~5.0
+*
+* @example
+* double y = stdlib_base_dists_chisquare_mgf( -1.0, 5.0 );
+* // returns ~0.0642
+*
+* @example
+* double y = stdlib_base_dists_chisquare_mgf( 0.0, 10.0 );
+* // returns 1.0
+*/


Per convention, we only keep one example in the C files:

Suggested change

* @example

* double y = stdlib_base_dists_chisquare_mgf( 0.4, 2.0 );

* // returns ~5.0

*

* @example

* double y = stdlib_base_dists_chisquare_mgf( -1.0, 5.0 );

* // returns ~0.0642

*

* @example

* double y = stdlib_base_dists_chisquare_mgf( 0.0, 10.0 );

* // returns 1.0

*/

* @example

* double y = stdlib_base_dists_chisquare_mgf( 0.4, 2.0 );

* // returns ~5.0

*/

Planeshifter · 2025-01-07T23:43:16Z

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/src/main.c

+* // returns 1.0
+*/
+double stdlib_base_dists_chisquare_mgf( const double t, const double k ) {
+    if ( stdlib_base_is_nan( t ) || stdlib_base_is_nan( k ) || k < 0.0 || t >= 0.5 ) {


Should be TAB-indentation here. You could also break up the if-clause over multiple lines.

All the changes have been merged successfully! 😃

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/README.md

Signed-off-by: Philipp Burckhardt <[email protected]>

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/src/main.c

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/examples/c/example.c

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/README.md

Signed-off-by: Philipp Burckhardt <[email protected]>

Planeshifter

Thanks for your updates! PR should be in good shape now. Will merge shortly after CI checks have passed.

stdlib-bot · 2025-01-08T12:56:34Z

PR Commit Message

feat(stats): add C implementation for `stats/base/dists/chisquare/mgf`

PR-URL: https://github.com/stdlib-js/stdlib/pull/4593
Ref: https://github.com/stdlib-js/stdlib/issues/3506

Co-authored-by: Karan Anand <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
Co-authored-by: stdlib-bot <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>

Please review the above commit message and make any necessary adjustments.

anandkaranubc added 5 commits January 5, 2025 16:40

feat: add the C src files

31fd9b5

feat: add the C benchmark and example files

24b9448

feat: add the JS native files

802c112

build: added the json and gyp dependency files

1a5005d

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Jan 6, 2025

stdlib-bot added bot: In Progress Pull request is currently awaiting automation. and removed bot: In Progress Pull request is currently awaiting automation. labels Jan 6, 2025

Planeshifter self-requested a review January 7, 2025 23:23

Planeshifter reviewed Jan 7, 2025

View reviewed changes

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Jan 7, 2025

chore: update copyright years

60f110c

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jan 7, 2025

Planeshifter reviewed Jan 7, 2025

View reviewed changes

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Jan 7, 2025

Planeshifter reviewed Jan 7, 2025

View reviewed changes

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jan 7, 2025

Planeshifter reviewed Jan 7, 2025

View reviewed changes

Planeshifter reviewed Jan 8, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/README.md Outdated Show resolved Hide resolved

docs: reorder declarations in example code

4f07e8e

Signed-off-by: Philipp Burckhardt <[email protected]>

Planeshifter reviewed Jan 8, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/src/main.c Outdated Show resolved Hide resolved

Planeshifter reviewed Jan 8, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/examples/c/example.c Outdated Show resolved Hide resolved

Planeshifter reviewed Jan 8, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dists/chisquare/mgf/README.md Outdated Show resolved Hide resolved

chore: apply suggestions from code review

99670a0

Signed-off-by: Philipp Burckhardt <[email protected]>

Planeshifter approved these changes Jan 8, 2025

View reviewed changes

Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Jan 8, 2025

stdlib-bot removed Needs Review A pull request which needs code review. Needs Changes Pull request which needs changes before being merged. labels Jan 8, 2025

Planeshifter merged commit 6def8d6 into stdlib-js:develop Jan 8, 2025
28 of 29 checks passed

anandkaranubc deleted the rfc/chisquare-mgf branch January 8, 2025 17:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stats): add C implementation for `stats/base/dists/chisquare/mgf` #4593

feat(stats): add C implementation for `stats/base/dists/chisquare/mgf` #4593

anandkaranubc commented Jan 6, 2025

stdlib-bot commented Jan 6, 2025 •

edited

Loading

anandkaranubc commented Jan 6, 2025

anandkaranubc commented Jan 7, 2025

Planeshifter commented Jan 7, 2025

Planeshifter Jan 7, 2025

Planeshifter commented Jan 7, 2025

Planeshifter Jan 7, 2025

Planeshifter Jan 7, 2025 •

edited

Loading

NishchayRajput Jan 8, 2025

Planeshifter commented Jan 7, 2025

Planeshifter Jan 7, 2025

Planeshifter Jan 7, 2025 •

edited

Loading

Planeshifter Jan 7, 2025

Planeshifter Jan 7, 2025

Planeshifter Jan 7, 2025

Planeshifter Jan 7, 2025

anandkaranubc Jan 8, 2025

Planeshifter left a comment

stdlib-bot commented Jan 8, 2025


		result = stdlib_base_dists_chisquare_mgf( t, k );

		printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result );

	printf( "t: %lf, k: %lf, MGF: %lf \n", t, k, result );
	printf( "t: %lf, k: %lf, M_X(t;k): %lf \n", t, k, result );

feat(stats): add C implementation for stats/base/dists/chisquare/mgf #4593

feat(stats): add C implementation for stats/base/dists/chisquare/mgf #4593

Conversation

anandkaranubc commented Jan 6, 2025

Resolves

Description

Purpose of this pull request

Related Issues

Does this pull request have any related issues?

Questions

Any questions for reviewers of this pull request?

Other Information

Any other relevant information?

Checklist

stdlib-bot commented Jan 6, 2025 • edited Loading

Coverage Report

anandkaranubc commented Jan 6, 2025

anandkaranubc commented Jan 7, 2025

Planeshifter commented Jan 7, 2025

Choose a reason for hiding this comment

Planeshifter commented Jan 7, 2025

Choose a reason for hiding this comment

Planeshifter Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Planeshifter commented Jan 7, 2025

Choose a reason for hiding this comment

Planeshifter Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Planeshifter left a comment

Choose a reason for hiding this comment

stdlib-bot commented Jan 8, 2025

PR Commit Message

feat(stats): add C implementation for `stats/base/dists/chisquare/mgf` #4593

feat(stats): add C implementation for `stats/base/dists/chisquare/mgf` #4593

stdlib-bot commented Jan 6, 2025 •

edited

Loading

Planeshifter Jan 7, 2025 •

edited

Loading

Planeshifter Jan 7, 2025 •

edited

Loading