feat: add `stats/mskmax` by iampratik13 · Pull Request #8855 · stdlib-js/stdlib

iampratik13 · 2025-12-06T16:11:54Z

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:

feat: add stats/mskmax

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.

Read, understood, and followed the contributing guidelines.

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

@stdlib-js/reviewers

stdlib-bot · 2025-12-06T16:13:35Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/meanpw	$\color{green}164/164$ $\color{green}+100.00%$	$\color{green}2/2$ $\color{green}+100.00%$	$\color{green}0/0$ $\color{green}+100.00%$	$\color{green}164/164$ $\color{green}+100.00%$
stats/mskmax	$\color{red}331/333$ $\color{red}-0.60%$	$\color{red}18/19$ $\color{red}-5.26%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{red}331/333$ $\color{red}-0.60%$

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

…b/array/uint8

lib/node_modules/@stdlib/stats/mskmax/README.md

Signed-off-by: Athan <kgryte@gmail.com>

kgryte · 2025-12-09T03:49:17Z

lib/node_modules/@stdlib/stats/mskmax/lib/main.js

+// VARIABLES //
+
+var idtypes = dtypes( 'real_and_generic' );
+var mdtypes = dtypes( 'integer' );


Suggested change

var mdtypes = dtypes( 'integer' );

var mdtypes = dtypes( 'mask_index_and_generic' );

We can be more strict here. Users should be more explicit when working with mask arrays.

kgryte · 2025-12-09T03:49:42Z

lib/node_modules/@stdlib/stats/mskmax/lib/main.js

+var mdtypes = dtypes( 'integer' );
+var odtypes = dtypes( 'real_and_generic' );
+var policies = {
+	'output': 'promoted',


This is not correct. We should not be promoting here. A mask array should have no affect on the output dtype.

kgryte · 2025-12-09T03:51:32Z

lib/node_modules/@stdlib/stats/mskmax/README.md

+The function has the following parameters:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have a real-valued or "generic" [data type][@stdlib/ndarray/dtypes].
+-   **mask**: mask [ndarray][@stdlib/ndarray/ctor]. Must have the same shape as `x`. If a mask element is `0`, the corresponding element in `x` is considered valid. If a mask element is non-zero, the corresponding element in `x` is ignored.


This isn't correct. Namely, x and mask should broadcast together. E.g., I should be able to provide a lower-dimensional mask and apply that to each sub-matrix in x. And similarly, I should be able to provide a lower-dimensional x and apply each mask sub-matrix to that same x.

kgryte · 2025-12-09T03:54:18Z

lib/node_modules/@stdlib/stats/mskmax/lib/main.js

+/**
+* Computes the maximum value along one or more ndarray dimensions according to a mask.
+*
+* @name max


Suggested change

* @name max

* @name mskmax

kgryte · 2025-12-09T03:54:49Z

lib/node_modules/@stdlib/stats/mskmax/lib/main.js

+* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+*
+* // Create a mask buffer:
+* var mbuf = new Uint8Array( [ 0, 0, 0, 1, 0, 1 ] ); // eslint-disable-line id-length


Suggested change

* var mbuf = new Uint8Array( [ 0, 0, 0, 1, 0, 1 ] ); // eslint-disable-line id-length

* var mbuf = new Uint8Array( [ 0, 0, 0, 1, 0, 1 ] );

Don't disable lint rules within JSDoc examples like this.

Also, this lint rule is not even applicable here.

kgryte · 2025-12-09T04:06:37Z

lib/node_modules/@stdlib/stats/mskmax/lib/main.js

+* var v = out.get();
+* // returns 5.0
+*/
+var mskmax = factory( table, [ idtypes, mdtypes ], odtypes, policies );


Because of broadcast semantics, it isn't enough to simply call factory here. We need a wrapper which handles broadcast semantics.

The package https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/index-of is NOT an apples-to-apples comparison, but it has the same general idea of a "wrapper" around a "base" implementation.

In short, main.js needs to take the input arrays x and mask, call ndarray/base/maybe-broadcast-arrays on them in order to get arrays which are the same shape, and then pass off to the "base" implementation found in base.js.

Same for assign.js, which needs to take the input arrays x and mask and broadcast them together such that they are the same shape.

Something like

function mskmax( x, mask ) { if ( !isndarrayLike( x ) {...} if ( !isndarrayLike( mask ) {....} arrs = maybeBroadcastArrays( [ x, mask ] ); if ( arguments.length > 2 ) { return base( arrs[ 0 ], arrs[ 1 ], arguments[ 2 ] ); } return base( arrs[ 0 ], arrs[ 1 ] ); }

Your current main.js implementation can serve as base.js.

Obviously this is the first mask package we are doing, so there is a bit more of a learning curve here.

kgryte

Left some initial comments.

Signed-off-by: Athan <kgryte@gmail.com>

kgryte · 2025-12-09T06:41:38Z

@iampratik13 You've included changes for meanpw in this PR, which is not correct. You need to fix your Git history before this PR can move forward.

kgryte · 2025-12-09T06:42:05Z

Our development guide includes instructions for how to properly sync branches and remotes.

stats/mskmax

68ca019

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Dec 6, 2025

iampratik13 added 7 commits December 6, 2025 22:00

Fix documentation examples to use native Uint8Array instead of @stdli…

4252091

…b/array/uint8

fix: examples updated

83f5c14

fix: import added

de416fd

fix: lint

2719c4b

fix: lint

4b59b7e

fix: lint

2b738a6

fix: lint

26bf0d2

iampratik13 closed this Dec 8, 2025

stdlib-bot removed the Needs Review A pull request which needs code review. label Dec 8, 2025

iampratik13 reopened this Dec 8, 2025

kgryte added the Feature Issue or pull request for adding a new feature. label Dec 9, 2025

kgryte reviewed Dec 9, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/mskmax/README.md Outdated Show resolved Hide resolved

docs: update example

59061c4

Signed-off-by: Athan <kgryte@gmail.com>

kgryte reviewed Dec 9, 2025

View reviewed changes

kgryte requested changes Dec 9, 2025

View reviewed changes

kgryte added the Needs Changes Pull request which needs changes before being merged. label Dec 9, 2025

iampratik13 and others added 5 commits December 9, 2025 11:49

stats/meanpw

f279faa

docs: update desc

c437bea

Signed-off-by: Athan <kgryte@gmail.com>

fix: changes done

a28cff6

style: align comments

34f480f

Signed-off-by: Athan <kgryte@gmail.com>

changes done

e868c07

iampratik13 added 2 commits December 9, 2025 11:49

fix: examples updated

c84342a

changes done

6837684

iampratik13 closed this Dec 9, 2025

iampratik13 deleted the stats/mskmax branch December 9, 2025 10:02

	var mdtypes = dtypes( 'integer' );
	var mdtypes = dtypes( 'mask_index_and_generic' );

	* var mbuf = new Uint8Array( [ 0, 0, 0, 1, 0, 1 ] ); // eslint-disable-line id-length
	* var mbuf = new Uint8Array( [ 0, 0, 0, 1, 0, 1 ] );

Uh oh!

Comments

Conversation

iampratik13 commented Dec 6, 2025

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

stdlib-bot commented Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

kgryte commented Dec 9, 2025

Uh oh!

kgryte commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stdlib-bot commented Dec 6, 2025 •

edited

Loading