feat: add `math/base/special/nanmin` #2342

RidamGarg · 2024-06-08T19:27:07Z

Added Package @stdlib/math/base/special/nanmin.

Resolves: #2318

Checklist

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

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

stdlib-bot

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

kgryte · 2024-06-08T20:31:27Z

@RidamGarg Are you planning on adding the C implementation to this PR or in a subsequent PR?

kgryte · 2024-06-08T23:55:29Z

@RidamGarg Looks like you'll also need to resolve some CI failures for linting and benchmarks.

RidamGarg · 2024-06-09T02:04:17Z

@kgryte made some changes. Can you please try again? I am planning to first complete the JS Implementation for both #2318 & #2317. After that I'll start C implementation of both

RidamGarg · 2024-06-09T07:36:42Z

@kgryte I am able to make the changes by cloning the project again. Can you please check once if you can merge PR now?

RidamGarg · 2024-06-09T09:55:12Z

@kgryte made the linting changes again & pushed the code. Can You please tell me? How Can I check these linting errors on my system?

kgryte · 2024-06-09T09:58:58Z

@RidamGarg You'll want to consult the project development guide and leverage various make recipes (e.g., https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib/lint). Since you are running on Windows, you'll likely need to use WSL. But perhaps a more straightforward approach would be to leverage a dev container https://github.com/stdlib-js/stdlib/tree/develop/.devcontainer which sets up an environment for development.

RidamGarg · 2024-06-09T10:04:04Z

Okay @kgryte I'll go through this. Thanks for sharing!

RidamGarg · 2024-06-09T14:52:59Z

@kgryte, Can you please check? If we are able to merge the code now once. As I resolved the required eslint issues. So, that after this I can start my work on another issue?

Planeshifter · 2024-06-09T21:16:04Z

/stdlib update-copyright-years

Planeshifter

Thanks @RidamGarg for your PR! Looks good overall; left a few suggestions, the main relating to the package description.

lib/node_modules/@stdlib/math/base/special/nanmin/README.md

lib/node_modules/@stdlib/math/base/special/nanmin/lib/main.js

lib/node_modules/@stdlib/math/base/special/nanmin/docs/types/index.d.ts

lib/node_modules/@stdlib/math/base/special/nanmin/lib/index.js

lib/node_modules/@stdlib/math/base/special/nanmin/lib/main.js

lib/node_modules/@stdlib/math/base/special/nanmin/package.json

Signed-off-by: Ridam Garg <67867319+RidamGarg@users.noreply.github.com>

RidamGarg · 2024-06-10T07:58:39Z

@Planeshifter made the required changes

lib/node_modules/@stdlib/math/base/special/nanmin/lib/main.js

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter · 2024-06-10T12:58:38Z

Thank you for making the changes and your contribution, @RidamGarg. It is much appreciated!

Planeshifter · 2024-06-10T13:02:33Z

@RidamGarg Could you please tick the checkbox that you read and accept the contributing guidelines, which is present in the PR template and which I inserted into your opening comment? Will merge your PR afterwards. Thank you!

RidamGarg · 2024-06-10T13:08:42Z

Done @Planeshifter

kgryte · 2024-06-10T14:40:53Z

lib/node_modules/@stdlib/math/base/special/nanmin/README.md

+```
+
+
+If both argument are `NaN`, the function returns `NaN`.


Suggested change

If both argument are `NaN`, the function returns `NaN`.

If both arguments are `NaN`, the function returns `NaN`.

kgryte · 2024-06-10T14:42:15Z

lib/node_modules/@stdlib/math/base/special/nanmin/examples/index.js

+var nanmin = require( './../lib' );
+
+var m = nanmin( 3.0, 4.0 );
+// returns 3.0


We should be logging each return value to the console.

kgryte · 2024-06-10T14:43:07Z

lib/node_modules/@stdlib/math/base/special/nanmin/lib/main.js

+*/
+function nanmin( x, y ) {
+	if ( isnan( x ) ) {
+		return ( isnan(y) ) ? NaN : y;


Suggested change

return ( isnan(y) ) ? NaN : y;

return ( isnan( y ) ) ? NaN : y;

Consistent spacing.

kgryte · 2024-06-10T14:45:04Z

lib/node_modules/@stdlib/math/base/special/nanmin/README.md

+</section>
+
+<!-- /.usage -->
+


This readme is missing various sections (eg, examples, links, etc).

I added the section previously but got this comment from @Planeshifter. We auto-populate these sections from metadata, so this should be left empty. Should I add this in my next PR?

@RidamGarg Sorry if my comment was not fully clear; the suggested change was to remove the inner content of the sections, not remove them altogether.

So

 <section class="related"> * * * ## See Also - <span class="package-name">[`@stdlib/math/base/special/max`][@stdlib/math/base/special/max]</span><span class="delimiter">: </span><span class="description">return the maximum value.</span> - <span class="package-name">[`@stdlib/math/base/special/minabs`][@stdlib/math/base/special/minabs]</span><span class="delimiter">: </span><span class="description">return the minimum absolute value.</span> - <span class="package-name">[`@stdlib/math/base/special/minn`][@stdlib/math/base/special/minn]</span><span class="delimiter">: </span><span class="description">return the minimum value.</span> </section>   <section class="links">  [@stdlib/math/base/special/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/max [@stdlib/math/base/special/minabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabs [@stdlib/math/base/special/minn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minn  </section> 

should have become

 <section class="related"> </section>   <section class="links">   </section> 

We auto-populate the contents for the related packages, but that will only work if the sections are there.

Notice that the examples section is separate from that. It should contain the example from examples/index.js file; see other packages for reference.

Ooh, Okay @Planeshifter, Now I got it. Thanks for the clarification.

kgryte · 2024-06-10T14:46:48Z

@RidamGarg You'll want to address the small comments in a follow-up PR.

cc @Planeshifter

PR-URL: stdlib-js#2342 Closes: stdlib-js#2318 --------- Signed-off-by: Ridam Garg <ridamgarg8979@gmail> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: RidamGarg <ridamgarg8979@gmail> Co-authored-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>

Added @stdlib/math/base/special/nanmin

0f2c4d6

stdlib-bot added the Math Issue or pull request specific to math functionality. label Jun 8, 2024

stdlib-bot reviewed Jun 8, 2024

View reviewed changes

RidamGarg mentioned this pull request Jun 8, 2024

[RFC]: add @stdlib/math/base/special/nanmin #2318

Closed

3 tasks

kgryte added the Feature Issue or pull request for adding a new feature. label Jun 8, 2024

kgryte changed the title ~~Added @stdlib/math/base/special/nanmin~~ feat: add math/base/special/nanmin Jun 8, 2024

Added @stdlib/math/base/special/nanmin

d144bb4

RidamGarg added 2 commits June 9, 2024 09:38

Added @stdlib/math/base/special/nanmin

78d82a3

Added @stdlib/math/base/special/nanmin

cf88b61

Added @stdlib/math/base/special/nanmin

4a1e103

Added @stdlib/math/base/special/nanmin

aeb3795

RidamGarg added 2 commits June 9, 2024 15:36

Added @stdlib/math/base/special/nanmin

4ff14fc

feat: added @stdlib/math/base/special/nanmin

b1edc3d

feat: added @stdlib/math/base/special/nanmin

6460912

chore: update copyright years

5ccd941

Planeshifter reviewed Jun 9, 2024

View reviewed changes

RidamGarg and others added 3 commits June 10, 2024 13:10

feat: added @stdlib/math/base/special/nanmin

4a4f8f3

Merge branch 'main' of https://github.com/RidamGarg/stdlib

39e88db

feat: added @stdlib/math/base/special/nanmin

4a8425e

Signed-off-by: Ridam Garg <67867319+RidamGarg@users.noreply.github.com>

Planeshifter reviewed Jun 10, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/nanmin/lib/main.js Outdated Show resolved Hide resolved

Update lib/node_modules/@stdlib/math/base/special/nanmin/lib/main.js

0118ae0

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter merged commit a985cc2 into stdlib-js:develop Jun 10, 2024
8 checks passed

kgryte reviewed Jun 10, 2024

View reviewed changes

	If both argument are `NaN`, the function returns `NaN`.
	If both arguments are `NaN`, the function returns `NaN`.

	return ( isnan(y) ) ? NaN : y;
	return ( isnan( y ) ) ? NaN : y;

Uh oh!

feat: add math/base/special/nanmin #2342

feat: add math/base/special/nanmin #2342

Uh oh!

Conversation

RidamGarg commented Jun 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

stdlib-bot left a comment

Choose a reason for hiding this comment

Uh oh!

kgryte commented Jun 8, 2024

Uh oh!

kgryte commented Jun 8, 2024

Uh oh!

RidamGarg commented Jun 9, 2024

Uh oh!

RidamGarg commented Jun 9, 2024

Uh oh!

RidamGarg commented Jun 9, 2024

Uh oh!

kgryte commented Jun 9, 2024

Uh oh!

RidamGarg commented Jun 9, 2024

Uh oh!

RidamGarg commented Jun 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Planeshifter commented Jun 9, 2024

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RidamGarg commented Jun 10, 2024

Uh oh!

Uh oh!

Planeshifter commented Jun 10, 2024

Uh oh!

Planeshifter commented Jun 10, 2024

Uh oh!

RidamGarg commented Jun 10, 2024

Uh oh!

Uh oh!

kgryte Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

kgryte Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

kgryte Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

kgryte Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

RidamGarg Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

Planeshifter Jun 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RidamGarg Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

kgryte commented Jun 10, 2024

Uh oh!

Uh oh!

feat: add `math/base/special/nanmin` #2342

feat: add `math/base/special/nanmin` #2342

RidamGarg commented Jun 8, 2024 •

edited

Loading

RidamGarg commented Jun 9, 2024 •

edited

Loading

Planeshifter Jun 10, 2024 •

edited

Loading