Skip to content

feat: add stats/base/dists/bradford/stdev #5333

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
Merged
merged 2 commits into from
Feb 22, 2025
Merged

feat: add stats/base/dists/bradford/stdev #5333

merged 2 commits into from
Feb 22, 2025

Conversation

@anandkaranubc
Copy link
Contributor

@anandkaranubc anandkaranubc commented Feb 20, 2025 •
edited
Loading

Progresses #168

Description

What is the purpose of this pull request?

This pull request:

  • Adds the JS implementation of the standard deviation of a Bradford distribution.

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

@anandkaranubc
feat: add implementation and tests
f4f5f1a 
---
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: passed
  - 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
---
@anandkaranubc
feat: add JSDoc
3be8c29 
---
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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - 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: passed
  - 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
---
@anandkaranubc anandkaranubc changed the title feat: add stats/base/dists/bradford/variance feat: add stats/base/dists/bradford/stdev Feb 20, 2025
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Feb 20, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Feb 20, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/bradford/stdev $\color{green}118/118$
$\color{green}+100.00\%$ 		$\color{green}6/6$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}118/118$
$\color{green}+100.00\%$

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

anandkaranubc
anandkaranubc commented Feb 20, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/dists/bradford/stdev/test/test.js
Comment on lines +83 to +89
/*
* NOTE: the tolerance is set high in this case due to:
*
* 1. The shape parameter being very small which causes differences in the `ln` calculations when compared to the test fixtures by SciPy.
* 2. The expected values being very small.
*/
tol = 322.0 * EPS * abs( expected[ i ] );
Copy link
Contributor Author

@anandkaranubc anandkaranubc Feb 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The same comment applies here as in the variance implementation.

I tested it using both log1p and ln. The version with ln requires a lower tolerance than the one with log1p. Also, the tolerance is "smaller" here compared to variance because of the sqrt operation.

SciPy’s implementation also uses np.log, which aligns with our approach.

@Planeshifter Planeshifter added Ready To Merge A pull request which is ready to be merged. autoclose: Contributor Guidelines Pull request which should be auto-closed due to not following the Contributor Guidelines. labels Feb 22, 2025
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Feb 22, 2025
@stdlib-bot stdlib-bot closed this Feb 22, 2025
@kgryte

This comment was marked as outdated.

Sign in to view
@stdlib-bot
Copy link
Contributor

PR Commit Message

feat: add `stats/base/dists/bradford/stdev`

PR-URL: https://github.com/stdlib-js/stdlib/pull/5333

Co-authored-by: Karan Anand <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

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

@kgryte kgryte removed the autoclose: Contributor Guidelines Pull request which should be auto-closed due to not following the Contributor Guidelines. label Feb 22, 2025
@Planeshifter

This comment was marked as outdated.

Sign in to view
@stdlib-js stdlib-js deleted a comment from stdlib-bot Feb 22, 2025
@kgryte kgryte reopened this Feb 22, 2025
@Planeshifter Planeshifter merged commit 1ca8479 into stdlib-js:develop Feb 22, 2025
91 checks passed
@anandkaranubc anandkaranubc deleted the bradford/stdev branch May 10, 2025 14:33
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 the Bradford distribution

4 participants

@anandkaranubc @stdlib-bot @kgryte @Planeshifter