feat: add stats/base/ndarray/sstdev
#9341
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stdlib-bot
added
Statistics
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
added
Feature
kgryte
reviewed
Dec 24, 2025
|
|
||
| var bench = require( '@stdlib/bench' ); | ||
| var uniform = require( '@stdlib/random/array/uniform' ); | ||
| var isnan = require( '@stdlib/math/base/assert/is-nan' ); |
Member
There was a problem hiding this comment.
Suggested change
| var isnan = require( '@stdlib/math/base/assert/is-nan' ); | |
| var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); |
Single-precision.
kgryte
reviewed
Dec 24, 2025
Comment on lines
37
to
38
| > var xbuf = [ 1.0, -2.0, 2.0 ]; | ||
| > var dt = 'generic'; |
Member
There was a problem hiding this comment.
Suggested change
| > var xbuf = [ 1.0, -2.0, 2.0 ]; | |
| > var dt = 'generic'; | |
| > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] ); | |
| > var dt = 'float32'; |
Single-precision must be provided to single-precision.
kgryte
reviewed
Dec 24, 2025
|
|
||
| /// <reference types="@stdlib/types"/> | ||
|
|
||
| import { typedndarray } from '@stdlib/types/ndarray'; |
Member
There was a problem hiding this comment.
Suggested change
| import { typedndarray } from '@stdlib/types/ndarray'; | |
| import { float32ndarray, typedndarray } from '@stdlib/types/ndarray'; |
kgryte
reviewed
Dec 24, 2025
| * var v = sstdev( [ x, correction ] ); | ||
| * // returns ~2.0817 | ||
| */ | ||
| declare function sstdev<T extends typedndarray = typedndarray>( arrays: [ T, T ] ): number; |
Member
There was a problem hiding this comment.
Suggested change
| declare function sstdev<T extends typedndarray = typedndarray>( arrays: [ T, T ] ): number; | |
| declare function sstdev<T extends typedndarray<number> = typedndarray<number>>( arrays: [ float32ndarray, T ] ): number; |
kgryte
reviewed
Dec 24, 2025
| const x = zeros( [ 10 ], { | ||
| 'dtype': 'float32' | ||
| }); | ||
| const correction = scalar2ndarray( 1.0, { 'dtype': 'float32' } ); |
Member
There was a problem hiding this comment.
Suggested change
| const correction = scalar2ndarray( 1.0, { 'dtype': 'float32' } ); | |
| const correction = scalar2ndarray( 1.0, { | |
| 'dtype': 'float32' | |
| }); |
Be consistent. See L30-32.
kgryte
reviewed
Dec 24, 2025
| const x = zeros( [ 10 ], { | ||
| 'dtype': 'float32' | ||
| }); | ||
| const correction = scalar2ndarray( 1.0, { 'dtype': 'float32' } ); |
Member
There was a problem hiding this comment.
Suggested change
| const correction = scalar2ndarray( 1.0, { 'dtype': 'float32' } ); | |
| const correction = scalar2ndarray( 1.0, { | |
| 'dtype': 'float32' | |
| }); |
kgryte
reviewed
Dec 24, 2025
| * var sstdev = require( '@stdlib/stats/base/ndarray/sstdev' ); | ||
| * | ||
| * var opts = { | ||
| * 'dtype': 'generic' |
Member
There was a problem hiding this comment.
Incorrect. You need to pass down a Float32Array.
Member
There was a problem hiding this comment.
See main.js example. Beware of copy-paste mistakes.
kgryte
reviewed
Dec 24, 2025
|
|
||
| var tape = require( 'tape' ); | ||
| var sqrt = require( '@stdlib/math/base/special/sqrt' ); | ||
| var isnan = require( '@stdlib/math/base/assert/is-nan' ); |
Member
There was a problem hiding this comment.
Suggested change
| var isnan = require( '@stdlib/math/base/assert/is-nan' ); | |
| var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); |
Single-precision utils for single-precision data.
kgryte
reviewed
Dec 24, 2025
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| v = sstdev( [ x, correction ] ); | ||
| if ( isnan( v ) ) { |
Member
There was a problem hiding this comment.
Suggested change
| if ( isnan( v ) ) { | |
| if ( isnanf( v ) ) { |
kgryte
reviewed
Dec 24, 2025
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnan( v ) ) { |
Member
There was a problem hiding this comment.
Suggested change
| if ( isnan( v ) ) { | |
| if ( isnanf( v ) ) { |
kgryte
added
the
Needs Changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: passed
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: 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
Resolves None.
Description
What is the purpose of this pull request?
This pull request:
stats/base/ndarray/sstdevRelated Issues
Does this pull request have any related issues?
This pull request has the following related issues:
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?
If you answered "yes" above, how did you use AI assistance?
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.".
This PR was created by duplicating the
stdevpackage and adapting it to compute the maximum absolute value instead of the maximum value. GitHub Copilot assisted with updating test cases, documentation, and verifying consistency across all files.@stdlib-js/reviewers