Add sort and has methods to PackedArrays #32144

aaronfranke · 2019-09-15T01:44:02Z

This PR adds two methods, for sorting using Godot's built-in sorting system, and for checking if it contains a specific value.

The methods are added for PackedByteArray, PackedColorArray, PackedInt32Array, PackedInt64Array, PackedFloat32Array, PackedFloat64Array, PackedStringArray, PackedVector2Array, and PackedVector3Array. I've exposed the methods to Variant and GDScript, but I also need this functionality internally for #31171

Xrayez · 2019-09-15T18:18:16Z

Perhaps rename contains to has to be consistent with Arrays respective method?

aaronfranke · 2019-09-15T19:29:38Z

@Xrayez Thanks for pointing it out, but it might make more sense to rename has to contains in 4.0. EDIT: Many people seem to prefer has so I changed this PR to have has.

akien-mga · 2019-09-25T07:09:57Z

but it might make more sense to rename has to contains in 4.0.

That's a separate discussion, but if you want this change in 3.2, consistency is more important than potential future changes. Both Array and Dictionary use has, so there's no reason for PoolArrays not to.

reduz · 2019-09-25T12:58:01Z

This PR really overcomplicated things, simply

copy the sort functions (sort() and sort_custom()) functions from vector.h
do sorting with a locked poolvector, else it will be super slow.

nathanfranke · 2019-10-17T09:13:32Z

Just a note:
core/sort_array.h already contains heap sort and insertion sort
std::sort uses QuickSort already (typically)

aaronfranke · 2020-02-21T05:34:39Z

Because of the removal of PoolArrays, I basically had to recreate this PR from scratch. Fortunately, it was super simple. Since Vector<T> already has a sort method, all I had to do is expose it, and implement/expose the has method as well (amazingly, a copy-paste with no changes worked).

Since this PR is so simple and I need it for another PR, this should probably be merged soon-ish.

aaronfranke · 2020-05-08T06:08:33Z

Updated again, now compatible with Packed(Int32/Int64/Float32/Float64)Arrays.

akien-mga · 2020-06-17T10:41:27Z

core/vector.h

+	bool has(const T &p_val) {
+		for (int i = 0; i < size(); i++) {
+			if (get(i) == p_val) {
+				return true;
+			}
+		}
+		return false;
+	}


Array::has() relies on find(), which is also implemented for Vector/CowData. Maybe it would be faster than this? (Didn't try.)

I'm not sure which is faster, but they both look similar, and it would be simpler and better for consistency with Array to use find, so I changed it to find.

bruvzg · 2020-06-17T10:50:07Z

core/variant_call.cpp

@@ -2182,6 +2216,8 @@ void register_variant_methods() {
 	ADDFUNC1(PACKED_COLOR_ARRAY, NIL, PackedColorArray, remove, INT, "idx", varray());
 	ADDFUNC2R(PACKED_COLOR_ARRAY, INT, PackedColorArray, insert, INT, "idx", COLOR, "color", varray());
 	ADDFUNC1(PACKED_COLOR_ARRAY, NIL, PackedColorArray, resize, INT, "idx", varray());
+	ADDFUNC1R(PACKED_COLOR_ARRAY, BOOL, PackedColorArray, has, COLOR, "value", varray());
+	ADDFUNC0(PACKED_COLOR_ARRAY, NIL, PackedColorArray, sort, varray());


Since PackedVectors are code types new methods should be added to the GDNative API as well: gdnative_api.json, packed_arrays.cpp, packed_arrays.h

Thanks for the info, done.

akien-mga · 2020-07-07T07:09:49Z

Thanks!

Calinou · 2020-08-31T14:58:52Z

Is it possible to remake this pull request for the 3.2 branch in a fully compatible manner?

aaronfranke · 2020-08-31T16:16:20Z

I made this before 3.2 was released, but Akien gave it the 4.0 milestone.

akien-mga · 2020-08-31T16:19:04Z

I made this before 3.2 was released, but Akien gave it the 4.0 milestone.

Yes, because it was made during feature freeze, and so wouldn't be merged during the stage/RC stage for 3.2. A PR gets the milestone matching the version which will be in development when it's meant to be merged in master. That doesn't mean that it can't be considered for a backport when we have no hurry and can take the time to assess and test changes like this one (as you've seen with 3.2.x releases which got hundreds of backports).

This is a backport from 4.0 to 3.x that adds 'sort' and 'has' methods to the following types: - PoolByteArray - PoolIntArray - PoolRealArray - PoolStringArray - PoolVector2Array - PoolVector3Array - PoolColorArray For all the types above, the methods 'sort' and 'has' have been exposed to the GDNative API (v. 1.3) Since the method 'has' was already implemented in GDScript before, in this commit it has been only exposed to GDNative API. The classes documentation is updated. The method 'sort' uses the exisging class "Sorter". Pooled arrays in 4.0 are rewritten, that's why this backport is not completely indentical to the original PR made for 4.0 (see godotengine#32144).

aaronfranke requested a review from a team as a code owner September 15, 2019 01:44

YeldhamDev added enhancement topic:core labels Sep 15, 2019

aaronfranke force-pushed the poolarray branch 2 times, most recently from 850a58a to 0904f5f Compare September 17, 2019 22:59

akien-mga added the for pr meeting label Sep 25, 2019

akien-mga added this to the 4.0 milestone Sep 25, 2019

aaronfranke force-pushed the poolarray branch from 0904f5f to c2e10d7 Compare October 2, 2019 02:32

aaronfranke changed the title ~~Add sort and contains methods to PoolArrays~~ Add sort and has methods to PoolArrays Oct 2, 2019

akien-mga requested a review from reduz October 27, 2019 08:52

aaronfranke force-pushed the poolarray branch from c2e10d7 to 4d92976 Compare November 29, 2019 05:40

aaronfranke force-pushed the poolarray branch from 4d92976 to 3f258ca Compare December 14, 2019 06:06

aaronfranke force-pushed the poolarray branch 2 times, most recently from f354233 to 5d00b10 Compare January 17, 2020 03:01

aaronfranke force-pushed the poolarray branch from 5d00b10 to 2f81c6a Compare February 21, 2020 04:33

aaronfranke changed the title ~~Add sort and has methods to PoolArrays~~ Add sort and has methods to PackedArrays Feb 21, 2020

aaronfranke force-pushed the poolarray branch from 2f81c6a to 86ab103 Compare February 29, 2020 07:13

aaronfranke mentioned this pull request Mar 13, 2020

"Interface -> Editor" and "Interface -> Editors" #25363

Closed

3 tasks

aaronfranke force-pushed the poolarray branch from 86ab103 to 097325e Compare March 14, 2020 07:33

aaronfranke mentioned this pull request Mar 23, 2020

Project feature warning system #31171

Merged

aaronfranke force-pushed the poolarray branch from 097325e to abd8c84 Compare April 4, 2020 07:57

aaronfranke requested a review from akien-mga April 6, 2020 22:37

aaronfranke mentioned this pull request Apr 7, 2020

Consider always saving the rendering API name #37645

Open

aaronfranke mentioned this pull request Apr 19, 2020

Add ability to remove default input map godotengine/godot-proposals#303

Closed

aaronfranke force-pushed the poolarray branch from 1bd0b0b to bb33533 Compare May 15, 2020 03:17

aaronfranke force-pushed the poolarray branch from bb33533 to 8d0c915 Compare June 3, 2020 02:57

aaronfranke force-pushed the poolarray branch from 8d0c915 to d76ae54 Compare June 17, 2020 03:19

akien-mga reviewed Jun 17, 2020

View reviewed changes

bruvzg reviewed Jun 17, 2020

View reviewed changes

aaronfranke force-pushed the poolarray branch from d76ae54 to 0be4c4d Compare June 17, 2020 18:30

Add sort and has methods to PackedArrays

af80bcd

aaronfranke force-pushed the poolarray branch from 0be4c4d to af80bcd Compare July 7, 2020 02:33

akien-mga merged commit 624eff4 into godotengine:master Jul 7, 2020

aaronfranke deleted the poolarray branch July 7, 2020 17:01

Calinou mentioned this pull request Aug 6, 2020

Pool{Type}Array has no method 'has' #41075

Closed

Calinou mentioned this pull request Aug 31, 2020

Add sort methods to PoolStringArray godotengine/godot-proposals#1439

Closed

Calinou mentioned this pull request Oct 8, 2021

no clean optimized and fast way to sort StringArray #5202

Closed

Calinou removed the for pr meeting label Nov 21, 2021

kdiduk mentioned this pull request Dec 5, 2021

[GDScript] Add 'sort' and 'has' methods to pooled arrays #55650

Merged

aaronfranke mentioned this pull request Feb 3, 2022

String: Add contains(). #57562

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sort and has methods to PackedArrays #32144

Add sort and has methods to PackedArrays #32144

aaronfranke commented Sep 15, 2019 •

edited

Loading

Xrayez commented Sep 15, 2019

aaronfranke commented Sep 15, 2019 •

edited

Loading

akien-mga commented Sep 25, 2019

reduz commented Sep 25, 2019

nathanfranke commented Oct 17, 2019

aaronfranke commented Feb 21, 2020 •

edited

Loading

aaronfranke commented May 8, 2020

akien-mga Jun 17, 2020

aaronfranke Jun 17, 2020

bruvzg Jun 17, 2020

aaronfranke Jun 17, 2020

akien-mga commented Jul 7, 2020

Calinou commented Aug 31, 2020

aaronfranke commented Aug 31, 2020

akien-mga commented Aug 31, 2020

Add sort and has methods to PackedArrays #32144

Add sort and has methods to PackedArrays #32144

Conversation

aaronfranke commented Sep 15, 2019 • edited Loading

Xrayez commented Sep 15, 2019

aaronfranke commented Sep 15, 2019 • edited Loading

akien-mga commented Sep 25, 2019

reduz commented Sep 25, 2019

nathanfranke commented Oct 17, 2019

aaronfranke commented Feb 21, 2020 • edited Loading

aaronfranke commented May 8, 2020

akien-mga Jun 17, 2020

Choose a reason for hiding this comment

aaronfranke Jun 17, 2020

Choose a reason for hiding this comment

bruvzg Jun 17, 2020

Choose a reason for hiding this comment

aaronfranke Jun 17, 2020

Choose a reason for hiding this comment

akien-mga commented Jul 7, 2020

Calinou commented Aug 31, 2020

aaronfranke commented Aug 31, 2020

akien-mga commented Aug 31, 2020

aaronfranke commented Sep 15, 2019 •

edited

Loading

aaronfranke commented Sep 15, 2019 •

edited

Loading

aaronfranke commented Feb 21, 2020 •

edited

Loading