feat: add `assert/is-ragged-nested-array` by performant23 · Pull Request #1368 · stdlib-js/stdlib

performant23 · 2024-02-24T12:03:38Z

Add support for checking if array-like objects are ragged and nested.

Resolves #1347

Description

What is the purpose of this pull request?

This pull request:

Adds support for checking if array-like objects are ragged and nested.

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: add @stdlib/assert/is-ragged-nested-array #1347

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.

The test results when applied on the functionality (benchmarks, examples, tests) can be found here - https://drive.google.com/drive/folders/1AomH4BL-sKkQCO6lhFU5BUelUW3wZp4f?usp=sharing

Checklist

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

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

…isRaggedNestedArray' (assert/is-ragged-nested-array) Add support for checking if array-like objects are ragged and nested. Fixes: stdlib-js#1347 Issue Link: stdlib-js#1347

stdlib-bot

👋 Hi there! 👋

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

Pranavchiku

Please address following suggestion, also run the tests, benchmarks prior to pushing the changes.

…sRaggedNestedArray' (Revision 1) Add support for checking if array-like objects are ragged and nested. Signed-off-by: Pranavchiku goswami.4@iitj.ac.in

performant23 · 2024-02-24T17:46:27Z

Hello, I have modified the files, marked the suggestions as done, and pushed the commit with the changes! Please do let me know if there are any further changes necessary.

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

kgryte · 2024-02-24T21:55:18Z

+console.log( isRaggedNestedArray( [ [1, 2, 3], [4, 5] ] ) );
+// => true
+
+console.log( isRaggedNestedArray( [ [1, 2, 3], [4, 5, 6] ] ) );


Suggested change

console.log( isRaggedNestedArray( [ [1, 2, 3], [4, 5] ] ) );

// => true

console.log( isRaggedNestedArray( [ [1, 2, 3], [4, 5, 6] ] ) );

console.log( isRaggedNestedArray( [ [ 1, 2, 3 ], [ 4, 5 ] ] ) );

// => true

console.log( isRaggedNestedArray( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ) );

Here and elsewhere.

Thanks for the suggestion @kgryte! Just to confirm, you mean adding a leading and trailing whitespace in array initializations in all files in the package not just this one right?

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

kgryte · 2024-02-24T21:58:33Z

+	var len = -1;
+	var i;
+
+	if ( !isArrayLikeObject( value ) ) {
+		return false;
+	}
+	for ( i = 0; i < value.length; i++ ) {
+		if ( !isArrayLikeObject( value[i] ) ) {
+			return false;
+		}
+		if ( len === -1 ) {
+			len = value[i].length;
+		} else if ( value[i].length !== len ) {


Suggested change

var len = -1;

var i;

if ( !isArrayLikeObject( value ) ) {

return false;

}

for ( i = 0; i < value.length; i++ ) {

if ( !isArrayLikeObject( value[i] ) ) {

return false;

}

if ( len === -1 ) {

len = value[i].length;

} else if ( value[i].length !== len ) {

var len;

var i;

if ( !isArrayLikeObject( value ) || value.length < 2 ) {

return false;

}

len = value[ 0 ].length;

for ( i = 1; i < value.length; i++ ) {

if ( !isArrayLikeObject( value[ i ] ) ) {

return false;

}

if ( value[ i ].length !== len ) {

Empty and single element arrays are not ragged. You can avoid additional branching logic by caching the length of the first array.

kgryte · 2024-02-24T21:59:25Z

@@ -0,0 +1,75 @@
+{
+    "name": "@stdlib/assert/is-ragged-nested-array",


The indentation in this file is off.

kgryte · 2024-02-24T21:59:37Z

+        "2d",
+        "two-dimensional"
+      ]
+    }  


Missing newline.

kgryte · 2024-02-24T21:59:58Z

+        "ragged",
+        "nested",
+        "is",
+        "israggednestedarray",


Suggested change

"israggednestedarray",

"isarray",

kgryte · 2024-02-24T22:00:18Z

+* limitations under the License.
+*/
+
+/* eslint-disable no-unused-vars */


Test files should never have unused variables.

That's correct, thanks! Also, just noticed that the package 'is-array-like-object', had this line in the test.js file.
/* eslint-disable object-curly-newline, no-unused-vars */
I'm not sure if it's the expected behavior there, but in case it isn't, just letting you know!

Edit: So, just noticed that this is used 20 times in 9 files in node_modules/@stdlib

kgryte · 2024-02-24T22:00:27Z

+	var i;
+
+	values = [
+		[ [1, 2, 3], [4, 5] ],


kgryte · 2024-02-24T22:00:56Z

+		false,
+		{},
+		function boop( a, b, c ) {},
+		[1, 2, 3]


Add empty array and [ [ 1, 2, 3 ] ].

kgryte

Thanks for working on this, @performant23. This is shaping up. So long as the comments are addressed, this is on track for being merged.

…sRaggedNestedArray' (Revision 2) Add support for checking if array-like objects are ragged and nested. Signed-off-by: Athan kgryte@gmail.com

…ttps://github.com/performant23/stdlib into feature/add-@stdlib/assert/is-ragged-nested-array

performant23 · 2024-02-25T07:26:35Z

Hey everyone, I have modified the files and pushed the commit with the changes! Please do let me know if there are any further changes necessary.

Planeshifter

Thanks for making the requested changes and your contribution, @performant23! This looks good to me; will merge shortly.

feat(@stdlib/assert): if applied, this commit will add the function '…

d1d40de

…isRaggedNestedArray' (assert/is-ragged-nested-array) Add support for checking if array-like objects are ragged and nested. Fixes: stdlib-js#1347 Issue Link: stdlib-js#1347

stdlib-bot reviewed Feb 24, 2024

View reviewed changes

kgryte changed the title ~~feat(@stdlib/assert): if applied, this commit will add the function isRaggedNestedArray' (assert/is-ragged-nested-array), Resolves #1347~~ feat: add assert/is-ragged-nested-array Feb 24, 2024

kgryte added Feature Issue or pull request for adding a new feature. Needs Review A pull request which needs code review. Utilities Issue or pull request concerning general utilities. labels Feb 24, 2024

Pranavchiku suggested changes Feb 24, 2024

View reviewed changes

feat(@stdlib/assert): if applied, this commit will add the function i…

930e28e

…sRaggedNestedArray' (Revision 1) Add support for checking if array-like objects are ragged and nested. Signed-off-by: Pranavchiku goswami.4@iitj.ac.in

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

kgryte added 4 commits February 24, 2024 13:47

Apply suggestions from code review

c9b8af1

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

Apply suggestions from code review

11eaa51

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

Apply suggestions from code review

6b565ac

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

Apply suggestions from code review

547a90e

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/benchmark/benchmark.js Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/repl.txt Outdated

Apply suggestions from code review

4469ea1

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/repl.txt Outdated

Apply suggestions from code review

39b883f

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/repl.txt

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/repl.txt

Apply suggestions from code review

754ca0a

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/types/index.d.ts Outdated

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/types/index.d.ts Outdated

kgryte added 2 commits February 24, 2024 13:53

Apply suggestions from code review

7a4e95b

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

Apply suggestions from code review

6665a62

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/types/test.ts

Apply suggestions from code review

c867372

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/docs/types/test.ts Outdated

Apply suggestions from code review

fdc1f4c

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

kgryte reviewed Feb 24, 2024

View reviewed changes

Comment thread lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md Outdated

Apply suggestions from code review

2bebaf4

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

kgryte reviewed Feb 24, 2024

View reviewed changes

kgryte requested changes Feb 24, 2024

View reviewed changes

performant23 added 2 commits February 25, 2024 12:48

feat(@stdlib/assert): if applied, this commit will add the function i…

39586ed

…sRaggedNestedArray' (Revision 2) Add support for checking if array-like objects are ragged and nested. Signed-off-by: Athan kgryte@gmail.com

Merge branch 'feature/add-@stdlib/assert/is-ragged-nested-array' of h…

9f94915

…ttps://github.com/performant23/stdlib into feature/add-@stdlib/assert/is-ragged-nested-array

Planeshifter approved these changes Feb 26, 2024

View reviewed changes

Planeshifter merged commit 0fb4869 into stdlib-js:develop Feb 26, 2024

Planeshifter removed the Needs Review A pull request which needs code review. label Mar 26, 2024

		@@ -0,0 +1,75 @@
		{
		"name": "@stdlib/assert/is-ragged-nested-array",

Uh oh!

Conversation

performant23 commented Feb 24, 2024

Description

Related Issues

Questions

Other

Checklist

Uh oh!

stdlib-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Pranavchiku 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!

performant23 commented Feb 24, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

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!

performant23 Feb 25, 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!

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!

performant23 commented Feb 25, 2024

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

performant23 Feb 25, 2024 •

edited

Loading