-
-
Notifications
You must be signed in to change notification settings - Fork 757
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.
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
feat(stats): add nanmgmean package #6243
base: develop
Are you sure you want to change the base?
Conversation
--- 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 ---
Coverage Report
The above coverage report was generated for the changes in this PR. |
--- 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: 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 ---
var i; | ||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
f = incrnanmgmean( (i%5)+1 ); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
f = incrnanmgmean( (i%5)+1 ); | |
f = incrnanmgmean( ( i%5 )+1 ); |
type accumulator = ( x?: number ) => number | null; | ||
|
||
/** | ||
* Returns an accumulator function which incrementally computes a moving geometric mean. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Returns an accumulator function which incrementally computes a moving geometric mean. | |
* Returns an accumulator function which incrementally computes a moving geometric mean, ignoring `NaN` value. |
* @returns accumulator function | ||
* | ||
* @example | ||
* var accumulator = incrmgmean( 3 ); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* var accumulator = incrmgmean( 3 ); | |
* var accumulator = incrnanmgmean( 3 ); |
* v = accumulator(); | ||
* // returns ~4.22 | ||
*/ | ||
declare function incrmgmean( W: number ): accumulator; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
declare function incrmgmean( W: number ): accumulator; | |
declare function incrnanmgmean( W: number ): accumulator; |
|
||
// EXPORTS // | ||
|
||
export = incrmgmean; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export = incrmgmean; | |
export = incrnanmgmean; |
|
||
/** | ||
* If provided a value, returns an updated geometric mean; otherwise, returns the current geometric mean. | ||
* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove line from L25-29
* limitations under the License. | ||
*/ | ||
|
||
import incrmgmean = require( './index' ); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update incrmgmean
to incrnanmgmean
in whole file.
{ | ||
"name": "@stdlib/stats/incr/nanmgmean", | ||
"version": "0.0.0", | ||
"description": "Compute a moving geometric mean incrementally.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"description": "Compute a moving geometric mean incrementally.", | |
"description": "Compute a moving geometric mean incrementally, ignoring `NaN` value.", |
--- 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: 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 ---
@hrshya i have updated the corresponding portions based on your comments, Thanks for the reminder! |
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:
Resolves #5576
Description
This pull request introduces the nanmgmean package—a thin wrapper around mgmean that enhances robustness. It adds type checking so that if a NaN or non-numeric value is provided, the update is skipped and the accumulator continues to return the previously computed mean directional accuracy. Test cases have been updated to verify that these edge cases are correctly handled.
This pull request:
test coverage:

example:

benchmark:

Related Issues
This pull request:
stats/incr/nanmgmean
#5576Questions
No.
Other
No.
Checklist
@stdlib-js/reviewers