Skip to content

feat: add C ndarray interface and refactor implementation for stats/base/dvariancetk #4534

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 3 commits into from
Jan 6, 2025
Merged

feat: add C ndarray interface and refactor implementation for stats/base/dvariancetk #4534

merged 3 commits into from
Jan 6, 2025

Conversation

@aayush0325
Copy link
Member

Resolves None

Description

What is the purpose of this pull request?

This pull request:

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

Related Issues

Does this pull request have any related issues?

This pull request:

  • resolves None

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
58ee359 
---
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
---
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Jan 4, 2025
@aayush0325 aayush0325 added the Feature Issue or pull request for adding a new feature. label Jan 4, 2025
@aayush0325
Copy link
Member Author

/stdlib update-copyright-years

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Jan 4, 2025
@aayush0325 aayush0325 added the C Issue involves or relates to C. label Jan 4, 2025
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jan 4, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jan 4, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/dvariancetk $\color{green}367/367$
$\color{green}+100.00\%$ 		$\color{green}21/21$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}367/367$
$\color{green}+100.00\%$

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

@DhruvArvindSingh
Copy link
Contributor

DhruvArvindSingh commented Jan 4, 2025 •
edited
Loading

@aayush0325 I have a small doubt.... Why have you used CBLAS_INT instead of int64_t in the main.c file?

@aayush0325
Copy link
Member Author

@aayush0325 I have a small doubt.... Why have you used CBLAS_INT instead of int64_t in the main.c file?

I believe it is a convention thing, if you'll see stdlib/blas/base/shared.h you'll notice that CBLAS_INT is a wrapper over int32_t and int64_t based on specific conditions during compilation. rest i believe @kgryte can give a better explanation than i can.

@aayush0325
feat: missing changes in main.c
b0fb176 
---
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
---
@kgryte
Copy link
Member

kgryte commented Jan 6, 2025

@DhruvArvindSingh CBLAS_INT stems from @stdlib/blas/base/*. This value can be set at compilation to create either 32- or 64-bit interfaces, depending on hardware support, etc. This follows BLAS, which supports something similar. (aside: historically, BLAS was only 32-bit. Only recently was 64-bit support added.) While most modern platforms have 64-bit support, that is not true of all systems, particularly embedded systems with limited memory. By supporting API_SUFFIX and CBLAS_INT, we ensure consistent conventions across our strided array interfaces, not just in BLAS.

kgryte
kgryte approved these changes Jan 6, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

LGTM

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jan 6, 2025
@kgryte kgryte merged commit 2572caf into stdlib-js:develop Jan 6, 2025
13 checks passed
@aayush0325 aayush0325 deleted the ndarray-dvariancetk branch January 8, 2025 19:03
0PrashantYadav0 pushed a commit to 0PrashantYadav0/stdlib that referenced this pull request Jan 9, 2025
@aayush0325 @stdlib-bot @0PrashantYadav0
feat: add C ndarray interface and refactor implementation for `stats/…
c2700af 
…base/dvariancetk`

PR-URL: stdlib-js#4534
Reviewed-by: Athan Reines <[email protected]>
Co-authored-by: stdlib-bot <[email protected]>
Neerajpathak07 pushed a commit to Neerajpathak07/stdlib that referenced this pull request Jan 23, 2025
@aayush0325 @stdlib-bot @Neerajpathak07
feat: add C ndarray interface and refactor implementation for `stats/…
d09f6e7 
…base/dvariancetk`

PR-URL: stdlib-js#4534
Reviewed-by: Athan Reines <[email protected]>
Co-authored-by: stdlib-bot <[email protected]>
ShabiShett07 pushed a commit to ShabiShett07/stdlib that referenced this pull request Feb 26, 2025
@aayush0325 @stdlib-bot @ShabiShett07
feat: add C ndarray interface and refactor implementation for `stats/…
e2652fb 
…base/dvariancetk`

PR-URL: stdlib-js#4534
Reviewed-by: Athan Reines <[email protected]>
Co-authored-by: stdlib-bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

C Issue involves or relates to C. Feature Issue or pull request for adding a new feature. 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.

4 participants

@aayush0325 @stdlib-bot @DhruvArvindSingh @kgryte