refactor: update `stats/incr/wmean` to handle nonnegative weights #4920

anandkaranubc · 2025-01-27T05:59:03Z

Resolves None

Description

What is the purpose of this pull request?

This pull request:

Updates the implementation of stats/incr/wmean to correctly handle nonnegative weights (w_i >= 0) and ensures mu is updated only after encountering a non-zero weight.
Adds corresponding test cases to validate the handling of zero weights.
Updates existing test cases to correctly test the new outputs

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.

Now the implementation doesn't return NaN when weight is NaN or is not provided in the accumulator function. Instead it throws a TypeError.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

… weights --- 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: passed - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---

--- 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: 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---

kgryte · 2025-01-27T23:28:47Z

lib/node_modules/@stdlib/stats/incr/wmean/lib/main.js

+		if ( !isNonNegativeNumber( w ) ) {
+			throw new TypeError( format( 'invalid argument. Must provide a nonnegative weight. Weight: `%s`.', w ) );
+		}
+		if (w === 0.0) {


Suggested change

if (w === 0.0) {

if ( w === 0.0 ) {

kgryte · 2025-01-27T23:38:30Z

lib/node_modules/@stdlib/stats/incr/wmean/lib/main.js

@@ -107,6 +116,12 @@ function incrwmean() {
 			}
 			return mu;
 		}
+		if ( !isNonNegativeNumber( w ) ) {
+			throw new TypeError( format( 'invalid argument. Must provide a nonnegative weight. Weight: `%s`.', w ) );


Suggested change

throw new TypeError( format( 'invalid argument. Must provide a nonnegative weight. Weight: `%s`.', w ) );

throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative number. Value: `%s`.', w ) );

We prefer general error messages in order to minimize the total number of unique error messages in the code base. See error/tools/* for additional context.

Thanks Athan! It will help me in the further implementations.

Applied the suggestions!

kgryte · 2025-01-27T23:38:47Z

lib/node_modules/@stdlib/stats/incr/wmean/lib/main.js

@@ -97,7 +105,8 @@ function incrwmean() {
 	*
 	* @private
 	* @param {number} [x] - value
-	* @param {number} [w] - weight
+	* @param {NonNegativeNumber} [w] - weight
+	* @throws {TypeError} must provide a nonnegative number as the weight


Suggested change

* @throws {TypeError} must provide a nonnegative number as the weight

* @throws {TypeError} second argument must be a nonnegative number

kgryte · 2025-01-27T23:40:32Z

lib/node_modules/@stdlib/stats/incr/wmean/test/test.js

+	t.equal( acc( 2.0, 0.0 ), null, 'returns the previous accumulated mean' );
+	t.equal( acc( 2.0, 2.0 ), 2.0, 'returns the current accumulated mean' );
+	t.equal( acc( 5.0, 0.0 ), 2.0, 'returns the previous accumulated mean' );


Suggested change

t.equal( acc( 2.0, 0.0 ), null, 'returns the previous accumulated mean' );

t.equal( acc( 2.0, 2.0 ), 2.0, 'returns the current accumulated mean' );

t.equal( acc( 5.0, 0.0 ), 2.0, 'returns the previous accumulated mean' );

t.equal( acc( 2.0, 0.0 ), null, 'returns expected value' );

t.equal( acc( 2.0, 2.0 ), 2.0, 'returns expected value' );

t.equal( acc( 5.0, 0.0 ), 2.0, 'returns expected value' );

kgryte · 2025-01-27T23:41:23Z

lib/node_modules/@stdlib/stats/incr/wmean/test/test.js

+	t.end();
+});
+
+tape( 'the function throws an error if not provided a nonnegative number', function test( t ) {


Suggested change

tape( 'the function throws an error if not provided a nonnegative number', function test( t ) {

tape( 'the accumulator function throws an error if provided a second argument which is not a nonnegative number', function test( t ) {

--- 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: passed - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed ---

--- 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: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---

anandkaranubc · 2025-02-17T02:36:41Z

/stdlib merge

stdlib-bot · 2025-02-17T02:39:45Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/incr/wmean	$\color{green}189/189$ $\color{green}+100.00\%$	$\color{green}14/14$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}189/189$ $\color{green}+100.00\%$

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

kgryte · 2025-04-30T02:52:11Z

/stdlib merge

anandkaranubc added 2 commits January 26, 2025 21:50

kgryte reviewed Jan 27, 2025

View reviewed changes

kgryte added Needs Changes Pull request which needs changes before being merged. Statistics Issue or pull request related to statistical functionality. labels Jan 27, 2025

anandkaranubc added 2 commits January 27, 2025 18:09

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Feb 17, 2025

Merge remote-tracking branch 'upstream/develop' into fix/wmean

29d359f

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Feb 17, 2025

kgryte added Needs Review A pull request which needs code review. and removed Needs Changes Pull request which needs changes before being merged. labels Apr 30, 2025

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Apr 30, 2025

Merge remote-tracking branch 'upstream/develop' into fix/wmean

a0a1d52

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Apr 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: update `stats/incr/wmean` to handle nonnegative weights #4920

refactor: update `stats/incr/wmean` to handle nonnegative weights #4920

anandkaranubc commented Jan 27, 2025 •

edited

Loading

kgryte Jan 27, 2025

kgryte Jan 27, 2025

kgryte Jan 27, 2025

anandkaranubc Jan 28, 2025 •

edited

Loading

kgryte Jan 27, 2025

kgryte Jan 27, 2025

kgryte Jan 27, 2025

anandkaranubc commented Feb 17, 2025

stdlib-bot commented Feb 17, 2025 •

edited

Loading

kgryte commented Apr 30, 2025

	throw new TypeError( format( 'invalid argument. Must provide a nonnegative weight. Weight: `%s`.', w ) );
	throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative number. Value: `%s`.', w ) );

	* @throws {TypeError} must provide a nonnegative number as the weight
	* @throws {TypeError} second argument must be a nonnegative number

	tape( 'the function throws an error if not provided a nonnegative number', function test( t ) {
	tape( 'the accumulator function throws an error if provided a second argument which is not a nonnegative number', function test( t ) {

refactor: update stats/incr/wmean to handle nonnegative weights #4920

Are you sure you want to change the base?

refactor: update stats/incr/wmean to handle nonnegative weights #4920

Conversation

anandkaranubc commented Jan 27, 2025 • edited Loading

Description

Related Issues

Questions

Other

Checklist

kgryte Jan 27, 2025

Choose a reason for hiding this comment

kgryte Jan 27, 2025

Choose a reason for hiding this comment

kgryte Jan 27, 2025

Choose a reason for hiding this comment

anandkaranubc Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

kgryte Jan 27, 2025

Choose a reason for hiding this comment

kgryte Jan 27, 2025

Choose a reason for hiding this comment

kgryte Jan 27, 2025

Choose a reason for hiding this comment

anandkaranubc commented Feb 17, 2025

stdlib-bot commented Feb 17, 2025 • edited Loading

Coverage Report

kgryte commented Apr 30, 2025

refactor: update `stats/incr/wmean` to handle nonnegative weights #4920

refactor: update `stats/incr/wmean` to handle nonnegative weights #4920

anandkaranubc commented Jan 27, 2025 •

edited

Loading

anandkaranubc Jan 28, 2025 •

edited

Loading

stdlib-bot commented Feb 17, 2025 •

edited

Loading