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.

Sign up for GitHub

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

Jump to bottom

feat: add C implementation for stats/base/dists/normal/entropy #3930

Merged
merged 6 commits into from
Dec 29, 2024
Merged

feat: add C implementation for stats/base/dists/normal/entropy #3930

merged 6 commits into from
Dec 29, 2024

Conversation

manvith2003
Copy link
Contributor

@manvith2003 manvith2003 commented Dec 15, 2024 •
edited
Loading

Resolves #3772

Description

What is the purpose of this pull request?

This pull request:

  • adds C implementation for @stdlib/stats/base/dists/normal/entropy along with relevant docs, tests, examples and benchmarks.

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@stdlib-js/reviewers

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Dec 15, 2024
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 15, 2024 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/normal/entropy $\color{green}178/178$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}178/178$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

@Planeshifter Planeshifter changed the title feat: add C implementation for stats/base/dists/normal/entropy feat: add C implementation for stats/base/dists/normal/entropy Dec 18, 2024
@kgryte
Copy link
Member

kgryte commented Dec 18, 2024

/stdlib merge

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 18, 2024
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 18, 2024
Planeshifter
Planeshifter requested changes Dec 20, 2024
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall. However, we should use math/base/special/ln for the natural logarithm. That should be updated before merging.

lib/node_modules/@stdlib/stats/base/dists/normal/entropy/src/main.c Outdated Show resolved Hide resolved
lib/node_modules/@stdlib/stats/base/dists/normal/entropy/src/main.c Outdated Show resolved Hide resolved
Planeshifter
Planeshifter reviewed Dec 20, 2024
View reviewed changes
lib/node_modules/@stdlib/stats/base/dists/normal/entropy/manifest.json Outdated
"@stdlib/math/base/napi/binary",
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/ln",
"@stdlib/math/base/special/sqrt",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manvith2003 I believe sqrt is not used and can be removed in these three configs. Please double-check.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Planeshifter resolved it

@manvith2003
docs: resolved the issue in mainfest.json
ffb96f4 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: na
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
Planeshifter
Planeshifter approved these changes Dec 29, 2024
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update. Let's get your PR merged...

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Dec 29, 2024
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Dec 29, 2024
@stdlib-bot
Copy link
Contributor

PR Commit Message

feat: add C implementation for `stats/base/dists/normal/entropy`

PR-URL: https://github.com/stdlib-js/stdlib/pull/3930
Closes: https://github.com/stdlib-js/stdlib/issues/3772

Co-authored-by: stdlib-bot <noreply@stdlib.io>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>

Please review the above commit message and make any necessary adjustments.

@Planeshifter Planeshifter merged commit bc9651b into stdlib-js:develop Dec 29, 2024
29 checks passed
Neerajpathak07 pushed a commit to Neerajpathak07/stdlib that referenced this pull request Jan 1, 2025
@manvith2003 @stdlib-bot @Neerajpathak07
feat: add C implementation for stats/base/dists/normal/entropy
09c0390 
PR-URL: stdlib-js#3930
Closes: stdlib-js#3772

Co-authored-by: stdlib-bot <noreply@stdlib.io>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
0PrashantYadav0 pushed a commit to 0PrashantYadav0/stdlib that referenced this pull request Jan 9, 2025
@manvith2003 @stdlib-bot @0PrashantYadav0
feat: add C implementation for stats/base/dists/normal/entropy
20be4f4 
PR-URL: stdlib-js#3930
Closes: stdlib-js#3772

Co-authored-by: stdlib-bot <noreply@stdlib.io>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Planeshifter Planeshifter Planeshifter approved these changes

Assignees
No one assigned
Labels
Ready To Merge A pull request which is ready to be merged. Statistics Issue or pull request related to statistical functionality.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[RFC]: Add C implementation for @stdlib/stats/base/dists/normal/entropy
4 participants
@manvith2003 @stdlib-bot @kgryte @Planeshifter