[RFC]: Add C implementation for `@stdlib/stats/base/dists/betaprime/logcdf`
- Lingua principale
- JavaScript
- Stelle
- 6k
- Fork
- 1.3k
- Merge medio
- 1g 3h
- PR unite (30g)
- 611
Descrizione
### 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/betaprime/logcdf`](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf) package.
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 https://github.com/stdlib-js/stdlib/pull/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
#3355
### Questions
No.
### Other
Once the implementation is ready including C examples and benchmarks, we should be able to run the following `make` commands.
#### Build native add-on
```bash
NODE_ADDONS_PATTERN="@stdlib/stats/base/dists/betaprime/logcdf" make install-node-addons
```
#### Run C examples
```bash
make examples-c-files FILES="$(pwd)/lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/examples/c/example.c"
```
#### Run C benchmarks
```bash
make benchmark-c-files FILES="$(pwd)/lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/benchmark/c/benchmark.c"
```
#### Run JavaScript benchmarks
```bash
make benchmark-javascript-files FILES="$(pwd)/lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/benchmark/benchmark.native.js"
```
#### Run all tests
```bash
make TESTS_FILTER=".*/@stdlib/stats/base/dists/betaprime/logcdf/.*" test
```
### Notes
- If you are interested in contributing a PR which addresses this RFC and are a **first-time contributor** or not yet familiar with our project conventions, please minimize the submission of LLM-generated code. Please consult our [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) and the associated [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md). Failure to respect project conventions will result in your PR being rejected without review. Thank you for understanding!
### Checklist
- [x] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [x] Searched for existing issues and pull requests.
- [x] The issue name begins with `RFC:`.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Review lib/main.js and its required modules, then compare the structure of PR #3354 for the analogous C implementation. Use the listed make commands to build the native add-on, run C and JavaScript benchmarks, examples, and filtered tests. Done means the C source, native interface, tests, benchmarks, examples, build configuration, and README documentation are present and those commands work.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- c, javascript, node.js
- Ambito
- backend, build-system, documentation, performance, testing
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 35/100