Description
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/mode package.
When adding support, the following tasks should be completed:
- C source implementation should be added to a src folder within the package's directory.
- A native add-on interface should be added in order to call the C implementation from JavaScript.
- A JavaScript file should be added to the lib folder to allow benchmarking and unit testing the native implementation from JavaScript.
- A new test file should be created which includes unit tests testing against expected behavior.
- C benchmarks should be added which measure performance for the C source implementation.
- A file containing C examples should be added to demonstrate example usage.
- JavaScript benchmarks should be added which measure performance for the native add-on.
- Build and configuration files should be added to allow compiling and running the C source implementation using project make commands (as documented below).
- 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
- Review JavaScript implementation in lib/main.js and its required modules to identify all stdlib functions used.
- Verify C implementations exist for each required function.
Related Issues
Related issues #4350
Questions
No.
Other
No response
Checklist
- I have read and understood the Code of Conduct.
- Searched for existing issues and pull requests.
- The issue name begins with
RFC:
.
Metadata
Metadata
Assignees
Labels
No labels