Skip to content

feat: add stats/base/ndarray/variancewd #9634

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
Open
DivyanshuVortex wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

feat: add stats/base/ndarray/variancewd #9634

DivyanshuVortex wants to merge 3 commits into from
+980 −0

Conversation

@DivyanshuVortex
Copy link
Contributor

@DivyanshuVortex DivyanshuVortex commented Jan 8, 2026 •
edited
Loading

Resolves : none.

Description

What is the purpose of this pull request?

This pull request:

  • feat: add stats/base/ndarray/variancewd

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

  • 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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

{{TODO: add disclosure if applicable}}

@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 Jan 8, 2026
@DivyanshuVortex DivyanshuVortex changed the title feat: add stats/base/ndarray/variancech feat: add stats/base/ndarray/variancewd Jan 8, 2026
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jan 8, 2026 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/ndarray/variancewd $\color{green}123/123$
$\color{green}+0.00%$ 		$\color{green}3/3$
$\color{green}+0.00%$ 		$\color{green}1/1$
$\color{green}+0.00%$ 		$\color{green}123/123$
$\color{green}+0.00%$

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

@DivyanshuVortex
fix(variancewd): fixing a package stats/base/ndarray/variancewd
77d6e85 
---
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: passed
  - 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: na
  - task: lint_license_headers
    status: passed
---
Planeshifter
Planeshifter requested changes Jan 9, 2026
View reviewed changes
lib/node_modules/@stdlib/stats/base/ndarray/variancewd/docs/types/index.d.ts Outdated
Comment on lines 26 to 29
* Computes the variancewd of a one-dimensional ndarray using Welford's algorithm.
*
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
* @returns variancewd
Copy link
Member

@Planeshifter Planeshifter Jan 9, 2026

Choose a reason for hiding this comment

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

The description and @returns tag say "variancewd" but should say "variance" - it should describe what's being computed, not the function name. Compare with stdevwd which says "standard deviation", not "stdevwd".

Suggested change
* Computes the variancewd of a one-dimensional ndarray using Welford's algorithm.
*
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
* @returns variancewd
/**
* Computes the variance of a one-dimensional ndarray using Welford's algorithm.
*
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
* @returns variance

lib/node_modules/@stdlib/stats/base/ndarray/variancewd/docs/repl.txt Outdated
> var opts = { 'dtype': dt };
> var correction = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, opts );

// Compute the variancewd:
Copy link
Member

@Planeshifter Planeshifter Jan 9, 2026

Choose a reason for hiding this comment

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

Same thing here - the comment should describe what's being computed ("Compute the variance:")

Suggested change
// Compute the variancewd:
// Compute the variance:

@Planeshifter Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Jan 9, 2026
@DivyanshuVortex
fix(variancewd): fixing a package stats/base/ndarray/variancewd
7b5ac65 
---
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: 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: passed
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Planeshifter Planeshifter Awaiting requested review from Planeshifter

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

Needs Changes Pull request which needs changes before being merged. 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

@DivyanshuVortex @stdlib-bot @Planeshifter