Repository navigation
[RFC]: Add C implementation for @stdlib/stats/base/dists/studentized-range/quantile #3888
Description
Activity
- added
on Dec 13, 2024 🚨 Important: PLEASE READ 🚨
This issue has been labeled as a good first issue and is available for anyone to work on.
If this is your first time contributing to an open source project, some aspects of the development process may seem unusual, arcane, or some combination of both.
- You cannot "claim" issues. People new to open source often want to "claim" or be assigned an issue before beginning work. The typical rationale is that people want to avoid wasted work in the event that someone else ends up working the issue. However, this practice is not effective in open source, as it often leads to "issue squatting", in which an individual asks to be assigned, is granted their request, and then never ends up working on the issue. Accordingly, you are encouraged to communicate your intent to address this issue, ideally by providing a rough outline as to how you plan to address the issue or asking clarifying questions, but, at the end of the day, we will take running code and rough consensus in order to move forward quickly.
- We have a very high bar for contributions. We have very high standards for contributions and expect all contributions—whether new features, tests, or documentation—to be rigorous, thorough, and complete. Once a pull request is merged into stdlib, that contribution immediately becomes the collective responsibility of all maintainers of stdlib. When we merge code into stdlib, we are saying that we, the maintainers, commit to reviewing subsequent changes and making bugfixes to the code. Hence, in order to ensure future maintainability, this naturally leads to a higher standard of contribution.
Before working on this issue and opening a pull request, please read the project's contributing guidelines. These guidelines and the associated development guide provide important information, including links to stdlib's Code of Conduct, license policy, and steps for setting up your local development environment.
To reiterate, we strongly encourage you to refer to our contributing guides before beginning work on this issue. Failure to follow our guidelines significantly decreases the likelihood that you'll successfully contribute to stdlib and may result in automatic closure of a pull request without review.
Setting up your local development environment is a critical first step, as doing so ensures that automated development processes for linting, license verification, and unit testing can run prior to authoring commits and pushing changes. If you would prefer to avoid manual setup, we provide pre-configured development containers for use locally or in GitHub Codespaces.
We place a high value on consistency throughout the stdlib codebase. We encourage you to closely examine other packages in stdlib and attempt to emulate the practices and conventions found therein.
- If you are attempting to contribute a new package, sometimes the best approach is to simply copy the contents of an existing package and then modify the minimum amount necessary to implement the feature (e.g., changing descriptions, parameter names, and implementation).
- If you are contributing tests, find a package implementing a similar feature and emulate the tests of that package.
- If you are updating documentation, examine several similar packages and emulate the content, style, and prose of those packages.
In short, the more effort you put in to ensure that your contribution looks and feels like stdlib—including variables names, bracket spacing, line breaks, etc—the more likely that your contribution will be reviewed and ultimately accepted. We encourage you to closely study the codebase before beginning work on this issue.
✨ Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions. ✨
Hey @Planeshifter, I am very keen to work on this issue. I would be really happy if you could assign this issue to me.
@stdlib-bot and @Planeshifter is this issue solved ?
If not then I am interested to work on this.@Planeshifter , hey if the issue is not resolved , i can work on this..../
Requires merging of c implementation of
@stdlib/stats/base/dists/studentized-range/cdf@Planeshifter Can I try to work on this issue? I know it's an year old issue but since it's not closed I would like to give it a try.
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/studentized-range/quantilepackage.When adding support, the following tasks should be completed:
srcfolder within the package's directory.libfolder to allow benchmarking and unit testing the native implementation from JavaScript.makecommands (as documented below).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
lib/main.jsand its required modules to identify allstdlibfunctions used.Related Issues
#3355
Questions
No.
Other
Once the implementation is ready including C examples and benchmarks, we should be able to run the following
makecommands.Build native add-on
NODE_ADDONS_PATTERN="@stdlib/stats/base/dists/studentized-range/quantile" make install-node-addonsRun C examples
make examples-c-files FILES="$(pwd)/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/examples/c/example.c"Run C benchmarks
make benchmark-c-files FILES="$(pwd)/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/benchmark/c/benchmark.c"Run JavaScript benchmarks
make benchmark-javascript-files FILES="$(pwd)/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/benchmark/benchmark.native.js"Run all tests
Notes
Checklist
RFC:.