Skip to content
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

feat: add accessor protocol support and refactor stats/base/nanmin #6211

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

feat: add accessor protocol support and refactor stats/base/nanmin #6211

wants to merge 7 commits into from

Conversation

rahulptl165
Copy link
Contributor

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: 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 #5659 .

Description

What is the purpose of this pull request?

This pull request:

  • Adds new lib/accessors.js file.
  • Modified lib/nanmin.js and lib/ndarray.js .
  • Modified bechmarks, tests, example and docs files accordingly.

Related Issues

Does this pull request have any related issues?

This pull request:

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.

@stdlib-js/reviewers

@rahulptl165
feat: add accessor protocol and refactor stats/base/nanmin
8c3522e 
---
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: 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
---
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Mar 19, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 19, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/nanmin $\color{green}297/297$
$\color{green}+100.00\%$ 		$\color{green}42/42$
$\color{green}+100.00\%$ 		$\color{green}3/3$
$\color{green}+100.00\%$ 		$\color{green}297/297$
$\color{green}+100.00\%$

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

@rahulptl165
Copy link
Contributor Author

Hi @kgryte, Please review my PR. thanks

@rahulptl165
test: ensure to include existing assertions
d428349 
---
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: passed
  - 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: passed
  - task: lint_license_headers
    status: passed
---
@kgryte kgryte changed the title feat: add accessor protocol and refactor stats/base/nanmin feat: add accessor protocol support and refactor stats/base/nanmin Mar 24, 2025
@kgryte
docs: fix grammar
8d43719 
Signed-off-by: Athan <[email protected]>
@kgryte
docs: fix grammar
6adf7e1 
Signed-off-by: Athan <[email protected]>
kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/README.md Outdated
x[ i ] = round( (randu()*100.0) - 50.0 );
}
}
var x = discreteUniform( 10, -50, 50, {
Copy link
Member

Choose a reason for hiding this comment

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

How you refactored this example does not preserve the original logic. See, e.g., https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmax#examples

kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/examples/index.js Outdated
x[ i ] = round( (randu()*100.0) - 50.0 );
}
}
var x = discreteUniform( 10, -50, 50, {
Copy link
Member

Choose a reason for hiding this comment

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

Same comment as README.

kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/lib/accessors.js
/**
* Computes the minimum value of a strided array, ignoring `NaN` values.
*
* @param {PositiveInteger} N - number of indexed elements
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* @param {PositiveInteger} N - number of indexed elements
* @private
* @param {PositiveInteger} N - number of indexed elements

This function is not part of the package's public API.

kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/lib/nanmin.js Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Would you mind renaming this file to main.js and updating index.js accordingly?

kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/lib/nanmin.js Outdated
@@ -41,46 +41,8 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
* var v = nanmin( N, x, 1 );
Copy link
Member

Choose a reason for hiding this comment

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

Let's go ahead and remove L39 and replace N here with x.length. The use of N in this example doesn't really add anything.

kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/lib/ndarray.js Outdated
@@ -44,33 +46,38 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
* var v = nanmin( N, x, 2, 1 );
Copy link
Member

Choose a reason for hiding this comment

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

You need to replace usage of floor in this example.

Copy link
Member

Choose a reason for hiding this comment

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

That may also apply to index.js.

kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
lib/node_modules/@stdlib/stats/base/nanmin/test/test.nanmin.js
@@ -21,7 +21,7 @@
// MODULES //

var tape = require( 'tape' );
var floor = require( '@stdlib/math/base/special/floor' );
var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
var Float64Array = require( '@stdlib/array/float64' );
Copy link
Member

Choose a reason for hiding this comment

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

L28 will need to be updated after renaming nanmin.js. May apply elsewhere, as well.

@kgryte
docs: update note
57fb8a2 
Signed-off-by: Athan <[email protected]>
kgryte
kgryte reviewed Mar 24, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

Left an initial round of comments.

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 24, 2025
@rahulptl165
refactor: addressed requested changes
ed96a58 
---
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: 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: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@rahulptl165
Copy link
Contributor Author

Hi @kgryte, I have addressed requested changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Good First PR A pull request resolving a Good First Issue. Needs Changes Pull request which needs changes before being merged. 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.

[RFC]: refactor and add protocol support to stats/base/nanmin
3 participants
@rahulptl165 @stdlib-bot @kgryte