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 ndarray interface and refactor implementation for stats/base/dstdevyc #4628

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

feat: add C ndarray interface and refactor implementation for stats/base/dstdevyc #4628

wants to merge 7 commits into from
+514 −361

Conversation

aayush0325
Copy link
Member

Description

What is the purpose of this pull request?

This pull request:

  • adds C ndarray interface for stats/base/dstdevyc
  • refactors JavaScript implementation
  • updates tests, docs, examples and benchmarks

Related Issues

Does this pull request have any related issues?

No.

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

@aayush0325
feat: add C ndarray interface and refactor implementation
c13f7e5 
---
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: passed
  - 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
---
@aayush0325 aayush0325 marked this pull request as draft January 7, 2025 13:47
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Jan 7, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jan 7, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/dstdevyc $\color{green}358/358$
$\color{green}+100.00\%$ 		$\color{green}13/13$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}358/358$
$\color{green}+100.00\%$

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

@aayush0325
feat: finishing up
f4326e9 
---
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: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: passed
  - task: lint_c_examples
    status: passed
  - task: lint_c_benchmarks
    status: passed
  - 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
---
@aayush0325 aayush0325 marked this pull request as ready for review January 8, 2025 07:13
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 8, 2025
@aayush0325 aayush0325 marked this pull request as draft January 8, 2025 08:08
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jan 8, 2025
@aayush0325
chore: add missing decimals
90d576e 
---
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: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - 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
---
@aayush0325 aayush0325 marked this pull request as ready for review January 8, 2025 08:20
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 8, 2025
@aayush0325
Copy link
Member Author

good evening @kgryte, kindly go over this commit to see where the missing decimals can be added as discussed in a previously merged PR, if this is something worth rectifying i can drop a PR for that

kgryte
kgryte reviewed Jan 8, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/dstdevyc/docs/types/index.d.ts Outdated
@@ -59,7 +59,7 @@ interface Routine {
* var v = dstdevyc.ndarray( x.length, 1, x, 1, 0 );
Copy link
Member

Choose a reason for hiding this comment

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

Sigh. The lack of decimal points for the correction parameter is everywhere in this PR. This was my original mistake.

@aayush0325
Copy link
Member Author

i'd have to go over the package in detail to see where else we can make this change, is that something that you'd want me to do?

@kgryte
Copy link
Member

kgryte commented Jan 8, 2025

i'd have to go over the package in detail to see where else we can make this change, is that something that you'd want me to do?

Yeah, sorry. 😞 Now that we've gone down this route, we should be consistent, at least within this package.

@aayush0325
chore: add missing decimals
3746b91 
---
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: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
@aayush0325 aayush0325 marked this pull request as draft January 8, 2025 08:51
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jan 8, 2025
@aayush0325
chore: add missing decimals
697ecb2 
---
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: passed
  - 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
---
@aayush0325 aayush0325 marked this pull request as ready for review January 8, 2025 15:13
@aayush0325 aayush0325 requested a review from kgryte January 8, 2025 15:13
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 8, 2025
@aayush0325
Copy link
Member Author

aayush0325 commented Jan 8, 2025 •
edited
Loading

I believe we're consistent in using decimals to show that the correction parameter is a double in this package now @kgryte, sorry if i missed anything

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte Awaiting requested review from kgryte

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Needs Review A pull request which needs code review. 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.
3 participants
@aayush0325 @stdlib-bot @kgryte