feat(stats): add C implementation for `stats/base/dists/arcsine/mode` #4236

anandkaranubc · 2024-12-25T20:04:39Z

Type: pre_push_report

Description: Results of running various checks prior to pushing changes.
Report:

Task: run_javascript_examples Status: Success
Task: run_c_examples Status: Success
Task: run_cpp_examples Status: Not Applicable
Task: run_javascript_readme_examples Status: Success
Task: run_c_benchmarks Status: Success
Task: run_cpp_benchmarks Status: Not Applicable
Task: run_fortran_benchmarks Status: Not Applicable
Task: run_javascript_benchmarks Status: Success
Task: run_julia_benchmarks Status: Not Applicable
Task: run_python_benchmarks Status: Not Applicable
Task: run_r_benchmarks Status: Not Applicable
Task: run_javascript_tests Status: Success

Resolves #3405

Description

What is the purpose of this pull request?

This pull request:

Adds a C implementation of the @stdlib/stats/base/dists/arcsine/mode package, including a Node.js native addon.
Includes a C source implementation within the src directory of the package.
Provides a native add-on interface for calling the C implementation from JavaScript.
Adds a JavaScript file in the lib folder to enable benchmarking and unit testing for the native implementation.
Creates unit tests to validate expected behavior.
Includes C benchmarks to measure the performance of the implementation.
Supplies C examples to demonstrate usage.
Adds JavaScript benchmarks for measuring the performance of the native add-on.
Updates the README to document the added C API.
Provides build and configuration files for compiling and running the C source implementation using project make commands.

Related Issues

Does this pull request have any related issues?

This pull request:

Resolves [RFC]: Add C implementation for @stdlib/stats/base/dists/arcsine/mode #3405

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

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

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

stdlib-bot

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

--- 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: na - task: lint_package_json status: passed - 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: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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: 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 --- --- 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 --- --- 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 --- --- 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 · 2024-12-25T21:03:31Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dists/arcsine/mode	$\color{green}190/190$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}190/190$ $\color{green}+100.00\%$

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

anandkaranubc · 2024-12-29T05:14:31Z

@Planeshifter Can you give this a quick review please? Thanks!

Planeshifter

Thank you for your first PR, which is much appreciated!

Left a few comments. You will also need to update the README.md file to document the new C implementation.

lib/node_modules/@stdlib/stats/base/dists/arcsine/mode/src/main.c

lib/node_modules/@stdlib/stats/base/dists/arcsine/mode/manifest.json

lib/node_modules/@stdlib/stats/base/dists/arcsine/mode/examples/c/example.c

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

anandkaranubc · 2024-12-29T22:57:49Z

Thanks @Planeshifter for your feedback. I have made the necessary changes as you suggested over here and also in similar feature requests in #4241 and #4361

Planeshifter · 2024-12-30T03:37:59Z

/stdlib lint-autofix

anandkaranubc · 2025-01-02T19:42:56Z

/stdlib update-copyright-years

anandkaranubc · 2025-01-02T20:42:48Z

@Planeshifter

Sorry for the ping. Just wanted to get your feedback on whether I should change something now?

PS: Happy New Year!

--- 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: na - 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: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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: 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 --- --- 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 ---

anandkaranubc · 2025-01-04T21:21:50Z

/stdlib update-copyright-years
/stdlib lint-autofix

stdlib-bot · 2025-01-04T21:22:07Z

@anandkaranubc, slash command not recognized. Please use /stdlib help to view available commands.

anandkaranubc · 2025-01-08T04:12:58Z

/stdlib lint-autofix

--- 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: na - 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 ---

--- 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: na - 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: na - 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 ---

--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - 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: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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: 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 ---

--- 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: na - 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: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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: 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 ---

…eneration --- 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: na - 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: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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: 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: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---

...modules/@stdlib/stats/base/dists/arcsine/mode/include/stdlib/stats/base/dists/arcsine/mode.h

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

Planeshifter

Thanks, @anandkaranubc, for the edits and PR! Let's get it in...

stdlib-bot · 2025-01-15T02:58:43Z

PR Commit Message

feat: add C implementation for `stats/base/dists/arcsine/mode`

PR-URL: https://github.com/stdlib-js/stdlib/pull/4236
Closes: https://github.com/stdlib-js/stdlib/issues/3405

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.

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

PR-URL: stdlib-js#4236 Closes: stdlib-js#3405 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]>

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Dec 25, 2024

stdlib-bot reviewed Dec 25, 2024

View reviewed changes

Planeshifter changed the title ~~[RFC]: Add C implementation for @stdlib/stats/base/dists/arcsine/mode~~ [RFC]: Add C implementation for stats/base/dists/arcsine/mode Dec 25, 2024

anandkaranubc force-pushed the rfc/mode-c branch from 700ba57 to 207f87d Compare December 25, 2024 21:01

Planeshifter requested changes Dec 29, 2024

View reviewed changes

anandkaranubc added 5 commits December 29, 2024 13:58

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 30, 2024

anandkaranubc changed the title ~~[RFC]: Add C implementation for stats/base/dists/arcsine/mode~~ feat: Add C implementation for stats/base/dists/arcsine/mode Dec 30, 2024

anandkaranubc changed the title ~~feat: Add C implementation for stats/base/dists/arcsine/mode~~ feat(stats): add C implementation for stats/base/dists/arcsine/mode Dec 30, 2024

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 30, 2024

anandkaranubc requested a review from Planeshifter December 31, 2024 09:09

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 2, 2025

anandkaranubc force-pushed the rfc/mode-c branch from 359b231 to 3a44544 Compare January 4, 2025 21:21

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

anandkaranubc marked this pull request as draft January 8, 2025 03:53

stdlib-bot removed the Needs Review A pull request which needs code review. label Jan 8, 2025

anandkaranubc marked this pull request as ready for review January 8, 2025 04:12

stdlib-bot added Needs Review A pull request which needs code review. bot: In Progress Pull request is currently awaiting automation. and removed bot: In Progress Pull request is currently awaiting automation. labels Jan 8, 2025

anandkaranubc marked this pull request as draft January 9, 2025 04:18

stdlib-bot removed the Needs Review A pull request which needs code review. label Jan 9, 2025

anandkaranubc added 4 commits January 8, 2025 21:14

anandkaranubc marked this pull request as ready for review January 11, 2025 07:02

stdlib-bot added the Needs Review A pull request which needs code review. label Jan 11, 2025

Planeshifter reviewed Jan 15, 2025

View reviewed changes

...modules/@stdlib/stats/base/dists/arcsine/mode/include/stdlib/stats/base/dists/arcsine/mode.h Show resolved Hide resolved

docs: exclude param and return descriptions from header file comment

368173d

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

Planeshifter approved these changes Jan 15, 2025

View reviewed changes

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

stdlib-bot removed the Needs Review A pull request which needs code review. label Jan 15, 2025

Merge branch 'develop' into rfc/mode-c

b494109

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

Planeshifter merged commit 3afe09e into stdlib-js:develop Jan 15, 2025
11 checks passed

anandkaranubc deleted the rfc/mode-c branch January 15, 2025 06:08

Uh oh!

feat(stats): add C implementation for stats/base/dists/arcsine/mode #4236

feat(stats): add C implementation for stats/base/dists/arcsine/mode #4236

Uh oh!

Conversation

anandkaranubc commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type: pre_push_report

Description

Related Issues

Questions

Other

Checklist

Uh oh!

stdlib-bot left a comment

Choose a reason for hiding this comment

Uh oh!

stdlib-bot commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

anandkaranubc commented Dec 29, 2024

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anandkaranubc commented Dec 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Planeshifter commented Dec 30, 2024

Uh oh!

anandkaranubc commented Jan 2, 2025

Uh oh!

anandkaranubc commented Jan 2, 2025

Uh oh!

anandkaranubc commented Jan 4, 2025

Uh oh!

stdlib-bot commented Jan 4, 2025

Uh oh!

anandkaranubc commented Jan 8, 2025

Uh oh!

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

stdlib-bot commented Jan 15, 2025 • edited by Planeshifter Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Commit Message

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(stats): add C implementation for `stats/base/dists/arcsine/mode` #4236

feat(stats): add C implementation for `stats/base/dists/arcsine/mode` #4236

anandkaranubc commented Dec 25, 2024 •

edited

Loading

stdlib-bot commented Dec 25, 2024 •

edited

Loading

anandkaranubc commented Dec 29, 2024 •

edited

Loading

stdlib-bot commented Jan 15, 2025 •

edited by Planeshifter

Loading