Skip to content

[RFC]: Add C implementation for @stdlib/stats/base/dists/planck/median #4937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
3 tasks done
yuvi-mittal opened this issue Jan 28, 2025 · 0 comments · Fixed by #4938
Closed
3 tasks done

[RFC]: Add C implementation for @stdlib/stats/base/dists/planck/median #4937

yuvi-mittal opened this issue Jan 28, 2025 · 0 comments · Fixed by #4938

Comments

@yuvi-mittal
Copy link
Contributor

Description

This RFC proposes adding a C implementation, including a Node.js native addon, C benchmarks, and C examples, for the @stdlib/stats/base/dists/planck/median

When adding support, the following tasks should be completed:

  1. A C source implementation should be added to a src folder within the package's directory.
  2. A native add-on interface should be added in order to call the C implementation from JavaScript.
  3. A JavaScript file should be added to the lib folder to allow benchmarking and unit testing the native implementation from JavaScript.
  4. A new test file should be created which includes unit tests testing against expected behavior.
  5. C benchmarks should be added which measure performance for the C source implementation.
  6. A file containing C examples should be added to demonstrate example usage.
  7. JavaScript benchmarks should be added which measure performance for the native add-on.
  8. Build and configuration files should be added to allow compiling and running the C source implementation using project make commands (as documented below).
  9. The README should be updated to include documentation for the added C API.

To provide a concrete example of what a PR adding the desired method should contain, see #3354, which is a PR adding a C implementation for the CDF of an arcsine distribution. This should provide an idea of what is expected.

Prerequisites

  1. Review JavaScript implementation in lib/main.js and its required modules to identify all stdlib functions used.
  2. Verify C implementations exist for each required function.

Related Issues

Related issues #4346

Questions

No.

Other

No.

Checklist

  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
@yuvi-mittal yuvi-mittal changed the title [RFC]: Add C implementation for @stdlib/stats/base/dists/planck/median [RFC]: Add C implementation for @stdlib/stats/base/dists/planck/median Jan 28, 2025
Planeshifter added a commit that referenced this issue Feb 15, 2025
PR-URL: #4938
Closes: #4937

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]>
ShabiShett07 pushed a commit to ShabiShett07/stdlib that referenced this issue Feb 26, 2025
PR-URL: stdlib-js#4938
Closes: stdlib-js#4937

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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant