Skip to content

Add sorted() method to Array and Dictionary #112138

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+132 −0
Open

Add sorted() method to Array and Dictionary #112138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions core/templates/vector.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,12 @@ class Vector {
sort_custom<Comparator<T>>();
}

Vector<T> sorted() const {
Vector<T> result = *this;
result.sort();
return result;
}

template <typename Comparator, bool Validate = SORT_ARRAY_VALIDATE_ENABLED, typename... Args>
void sort_custom(Args &&...args) {
Size len = _cowdata.size();
Expand Down
12 changes: 12 additions & 0 deletions core/variant/array.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -735,11 +735,23 @@ void Array::sort() {
_p->array.sort_custom<_ArrayVariantSort>();
}

Array Array::sorted() const {
Array ret = duplicate();
ret.sort();
return ret;
}

void Array::sort_custom(const Callable &p_callable) {
ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
_p->array.sort_custom<CallableComparator, true>(p_callable);
}

Array Array::sorted_custom(const Callable &p_callable) const {
Array ret = duplicate();
ret.sort_custom(p_callable);
return ret;
}

void Array::shuffle() {
ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
const int n = _p->array.size();
Expand Down
2 changes: 2 additions & 0 deletions core/variant/array.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,9 @@ class Array {
Variant pick_random() const;

void sort();
Array sorted() const;
void sort_custom(const Callable &p_callable);
Array sorted_custom(const Callable &p_callable) const;
void shuffle();
int bsearch(const Variant &p_value, bool p_before = true) const;
int bsearch_custom(const Variant &p_value, const Callable &p_callable, bool p_before = true) const;
Expand Down
6 changes: 6 additions & 0 deletions core/variant/dictionary.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,12 @@ void Dictionary::sort() {
_p->variant_map.sort_custom<_DictionaryVariantSort>();
}

Dictionary Dictionary::sorted() const {
Dictionary ret = duplicate();
ret.sort();
return ret;
}

void Dictionary::merge(const Dictionary &p_dictionary, bool p_overwrite) {
ERR_FAIL_COND_MSG(_p->read_only, "Dictionary is in read-only state.");
for (const KeyValue<Variant, Variant> &E : p_dictionary._p->variant_map) {
Expand Down
1 change: 1 addition & 0 deletions core/variant/dictionary.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ class Dictionary {
void reserve(int p_new_capacity);
void clear();
void sort();
Dictionary sorted() const;
void merge(const Dictionary &p_dictionary, bool p_overwrite = false);
Dictionary merged(const Dictionary &p_dictionary, bool p_overwrite = false) const;

Expand Down
13 changes: 13 additions & 0 deletions core/variant/variant_call.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2457,6 +2457,7 @@ static void _register_variant_builtin_methods_misc() {
bind_method(Dictionary, clear, sarray(), varray());
bind_method(Dictionary, assign, sarray("dictionary"), varray());
bind_method(Dictionary, sort, sarray(), varray());
bind_method(Dictionary, sorted, sarray(), varray());
bind_method(Dictionary, merge, sarray("dictionary", "overwrite"), varray(false));
bind_method(Dictionary, merged, sarray("dictionary", "overwrite"), varray(false));
bind_method(Dictionary, has, sarray("key"), varray());
Expand Down Expand Up @@ -2520,7 +2521,9 @@ static void _register_variant_builtin_methods_array() {
bind_method(Array, pop_front, sarray(), varray());
bind_method(Array, pop_at, sarray("position"), varray());
bind_method(Array, sort, sarray(), varray());
bind_method(Array, sorted, sarray(), varray());
bind_method(Array, sort_custom, sarray("func"), varray());
bind_method(Array, sorted_custom, sarray("func"), varray());
bind_method(Array, shuffle, sarray(), varray());
bind_method(Array, bsearch, sarray("value", "before"), varray(true));
bind_method(Array, bsearch_custom, sarray("value", "func", "before"), varray(true));
Expand Down Expand Up @@ -2581,6 +2584,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedByteArray, reverse, sarray(), varray());
bind_method(PackedByteArray, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedByteArray, sort, sarray(), varray());
bind_method(PackedByteArray, sorted, sarray(), varray());
bind_method(PackedByteArray, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedByteArray, duplicate, sarray(), varray());
bind_method(PackedByteArray, find, sarray("value", "from"), varray(0));
Expand Down Expand Up @@ -2657,6 +2661,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedInt32Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedInt32Array, to_byte_array, sarray(), varray());
bind_method(PackedInt32Array, sort, sarray(), varray());
bind_method(PackedInt32Array, sorted, sarray(), varray());
bind_method(PackedInt32Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedInt32Array, duplicate, sarray(), varray());
bind_method(PackedInt32Array, find, sarray("value", "from"), varray(0));
Expand All @@ -2681,6 +2686,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedInt64Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedInt64Array, to_byte_array, sarray(), varray());
bind_method(PackedInt64Array, sort, sarray(), varray());
bind_method(PackedInt64Array, sorted, sarray(), varray());
bind_method(PackedInt64Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedInt64Array, duplicate, sarray(), varray());
bind_method(PackedInt64Array, find, sarray("value", "from"), varray(0));
Expand All @@ -2705,6 +2711,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedFloat32Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedFloat32Array, to_byte_array, sarray(), varray());
bind_method(PackedFloat32Array, sort, sarray(), varray());
bind_method(PackedFloat32Array, sorted, sarray(), varray());
bind_method(PackedFloat32Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedFloat32Array, duplicate, sarray(), varray());
bind_method(PackedFloat32Array, find, sarray("value", "from"), varray(0));
Expand All @@ -2729,6 +2736,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedFloat64Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedFloat64Array, to_byte_array, sarray(), varray());
bind_method(PackedFloat64Array, sort, sarray(), varray());
bind_method(PackedFloat64Array, sorted, sarray(), varray());
bind_method(PackedFloat64Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedFloat64Array, duplicate, sarray(), varray());
bind_method(PackedFloat64Array, find, sarray("value", "from"), varray(0));
Expand All @@ -2753,6 +2761,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedStringArray, slice, sarray("begin", "end"), varray(INT_MAX));
bind_function(PackedStringArray, to_byte_array, _VariantCall::func_PackedStringArray_to_byte_array, sarray(), varray());
bind_method(PackedStringArray, sort, sarray(), varray());
bind_method(PackedStringArray, sorted, sarray(), varray());
bind_method(PackedStringArray, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedStringArray, duplicate, sarray(), varray());
bind_method(PackedStringArray, find, sarray("value", "from"), varray(0));
Expand All @@ -2777,6 +2786,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedVector2Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedVector2Array, to_byte_array, sarray(), varray());
bind_method(PackedVector2Array, sort, sarray(), varray());
bind_method(PackedVector2Array, sorted, sarray(), varray());
bind_method(PackedVector2Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedVector2Array, duplicate, sarray(), varray());
bind_method(PackedVector2Array, find, sarray("value", "from"), varray(0));
Expand All @@ -2801,6 +2811,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedVector3Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedVector3Array, to_byte_array, sarray(), varray());
bind_method(PackedVector3Array, sort, sarray(), varray());
bind_method(PackedVector3Array, sorted, sarray(), varray());
bind_method(PackedVector3Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedVector3Array, duplicate, sarray(), varray());
bind_method(PackedVector3Array, find, sarray("value", "from"), varray(0));
Expand All @@ -2825,6 +2836,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedColorArray, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedColorArray, to_byte_array, sarray(), varray());
bind_method(PackedColorArray, sort, sarray(), varray());
bind_method(PackedColorArray, sorted, sarray(), varray());
bind_method(PackedColorArray, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedColorArray, duplicate, sarray(), varray());
bind_method(PackedColorArray, find, sarray("value", "from"), varray(0));
Expand All @@ -2849,6 +2861,7 @@ static void _register_variant_builtin_methods_array() {
bind_method(PackedVector4Array, slice, sarray("begin", "end"), varray(INT_MAX));
bind_method(PackedVector4Array, to_byte_array, sarray(), varray());
bind_method(PackedVector4Array, sort, sarray(), varray());
bind_method(PackedVector4Array, sorted, sarray(), varray());
bind_method(PackedVector4Array, bsearch, sarray("value", "before"), varray(true));
bind_method(PackedVector4Array, duplicate, sarray(), varray());
bind_method(PackedVector4Array, find, sarray("value", "from"), varray(0));
Expand Down
15 changes: 15 additions & 0 deletions doc/classes/Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -812,6 +812,21 @@
[b]Note:[/b] You should not randomize the return value of [param func], as the heapsort algorithm expects a consistent result. Randomizing the return value will result in unexpected behavior.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="sorted_custom" qualifiers="const">
<return type="Array" />
<param index="0" name="func" type="Callable" />
<description>
Returns a copy of this array sorted using a custom [Callable]. See also [method sort_custom].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort_custom].
</description>
</method>
</methods>
<operators>
<operator name="operator !=">
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/Dictionary.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,13 @@
This method ensures that the dictionary's entries are ordered consistently when [method keys] or [method values] are called, or when the dictionary needs to be converted to a string through [method @GlobalScope.str] or [method JSON.stringify].
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="Dictionary" />
<description>
Returns a sorted copy of this dictionary. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="values" qualifiers="const">
<return type="Array" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedByteArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,13 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedByteArray" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_color_array" qualifiers="const">
<return type="PackedColorArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedColorArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,13 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedColorArray" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedFloat32Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,13 @@
[b]Note:[/b] [constant @GDScript.NAN] doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedFloat32Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedFloat64Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,13 @@
[b]Note:[/b] [constant @GDScript.NAN] doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedFloat64Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedInt32Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedInt32Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedInt64Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,13 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedInt64Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedStringArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,13 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedStringArray" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedVector2Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,13 @@
[b]Note:[/b] Vectors with [constant @GDScript.NAN] elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedVector2Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedVector3Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,13 @@
[b]Note:[/b] Vectors with [constant @GDScript.NAN] elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedVector3Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/PackedVector4Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,13 @@
[b]Note:[/b] Vectors with [constant @GDScript.NAN] elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
</description>
</method>
<method name="sorted" qualifiers="const">
<return type="PackedVector4Array" />
<description>
Returns a sorted copy of this array. See also [method sort].
[b]Note:[/b] This method creates a copy, which may have a noticeable performance cost. To perform in-place sorting instead, use [method sort].
</description>
</method>
<method name="to_byte_array" qualifiers="const">
<return type="PackedByteArray" />
<description>
Expand Down