Skip to content
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

feat: Add Rice Distribution Base Package #2727

Closed
wants to merge 1 commit into from

Conversation

CodeMaverick2
Copy link

@CodeMaverick2 CodeMaverick2 commented Aug 1, 2024

Issue

Description

This pull request implements the base package for the Rice distribution in the @stdlib/stats/base/dists/rice namespace. The base package includes the essential functions such as the probability density function (PDF) and cumulative distribution function (CDF) for the Rice distribution. This serves as the foundational implementation, and additional functions will be added in subsequent PRs as per the guidelines.

File Structure

@stdlib/
└── stats/
    └── base/
        └── dists/
            └── rice/
                ├── README.md
                ├── package.json
                ├── lib/
                │   ├── index.js
                │   ├── cdf.js
                │   └── pdf.js
                └── test/
                    ├── test.js
                    ├── test.cdf.js
                    └── test.pdf.js

Checklist

Other Information

  • Reference implementation from SciPy.
  • Future enhancements will include additional functions like the quantile function, mean, and median.

References

@stdlib-bot
Copy link
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@CodeMaverick2
Copy link
Author

@kgryte I've created a base package for rice distribution, If there are any issue do inform me and if we want to update the package to be more broad i can work on that if you say so

@kgryte kgryte added the autoclose: Project Conventions Pull request which should be auto-closed due to not following project conventions. label Aug 1, 2024
@stdlib-bot
Copy link
Contributor

Thank you for working on this pull request. However, we cannot accept your contribution as this pull request does not follow project conventions.

We place a high value on consistency throughout the stdlib codebase, and this pull request was found to significantly deviate from stdlib conventions. 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 continuing to work on this pull request.

Thank you again for your interest in stdlib, and we look forward to reviewing your future contriubtions.

@stdlib-bot stdlib-bot closed this Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autoclose: Project Conventions Pull request which should be auto-closed due to not following project conventions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants