Add _toArray, update _contains, _filter and _reduce

The updated functions now support ds_lists as well as arrays

Author: twisterghost

README.md

@@ -129,14 +129,21 @@ _concat(_arrayOf(0, 1, 2), _arrayOf(3, 4, 5));
 
 ### `_contains(collection, target, fromIndex = 0)`
 
-Returns true if the given array contains the given value
+Returns true if the given collection contains the given value
 
 ```
-@param {String|Array|DS_Map} The collection to search
+@param {String|Array|DS_Map|DS_List} The collection to search
 @param {*} The value to look for
 @param {Real} [0] The index to begin looking from
+@param {ds_type} [ds_type_list] The type of the ds, if this is a ds.
 @returns {Boolean} True if the collection contains the target, otherwise false
 
+Note: You only need to specify a ds_type when looking at a ds_list or ds_map.
+By default, the ds_type is set to ds_type_map. Options are:
+
+* ds_type_list
+* ds_type_map
+
 @example
 _contains([1, 2, 3], 1);
 // => true
@@ -164,12 +171,12 @@ _map(_filter(_collect(obj_enemy)), hasNoHealth), _destroy);
 
 ### `_filter(array, filterScript)`
 
-Returns an array where values of the input array are truthy when run through the provided function.
+Returns a a collection where values of the input collection are truthy when run through the provided function.
 
 ```
-@param {Array} The array to filter
+@param {Array|DS_List} The collection to filter
 @param {Script} The script to filter with
-@returns {Array} The filtered array
+@returns {Array|DS_List} The filtered collection
 
 @example
 _filter(_arrayOf(0, 1, 2, 3), lessThanTwo)
@@ -400,7 +407,7 @@ _or(false, false);
 
 ### `_partial(script, arg0, arg1 ... arg13)`
 
-Creates a partial function identifier for use in place of raw scripts in gdash functions, or with the use of _run.
+Creates a partial function identifier for use in place of raw scripts in gdash functions, or with the use of `_run`.
 
 Partials are to be treated as a data structure, and must be cleaned up with `_free()` when they are no longer of use.
 
@@ -441,7 +448,7 @@ _push(_arrayOf(1, 2), 3);
 Reduces a collection by iterating over it with a function. Provided script should take 2 arguments: `total`, `value`. On the first call, `total` is `undefined`.
 
 ```
-@param {Array} The array to reduce
+@param {Array|DS_List} The collection to reduce
 @param {Script} The script to reduce with
 @returns {*} The reduced value from the given script
 

src/gdash/gdash.yyp

@@ -10,5 +10,14 @@ arr[4] = 5;
 
 assert_equal(_reduce(arr, __sum), 15);
 
+var list = ds_list_create();
+list[| 0] = 1;
+list[| 1] = 2;
+list[| 2] = 3;
+list[| 3] = 4;
+list[| 4] = 5;
+
+assert_equal(_reduce(list, __sum), 15);
+
 test_end();
 

src/gdash/objects/obj_gdash_test_1/Other_14.gml

@@ -14,5 +14,24 @@ assert_is_false(_contains(res, 1));
 assert_is_false(_contains(res, 3));
 assert_is_false(_contains(res, 5));
 
+var list = ds_list_create();
+ds_list_add(list, 0, 1, 2, 3, 4, 5, 6);
+var resList = _filter(list, __isEven);
+
+_log(list[| 1]);
+_log(resList[| 1]);
+
+assert_is_true(_contains(resList, 0, 0, ds_type_list));
+assert_is_true(_contains(resList, 2, 0, ds_type_list));
+assert_is_true(_contains(resList, 4, 0, ds_type_list));
+assert_is_true(_contains(resList, 6, 0, ds_type_list));
+
+assert_is_false(_contains(resList, 1, 0, ds_type_list));
+assert_is_false(_contains(resList, 3, 0, ds_type_list));
+assert_is_false(_contains(resList, 5, 0, ds_type_list));
+
+ds_list_destroy(list);
+ds_list_destroy(resList);
+
 test_end();
 

src/gdash/objects/obj_gdash_test_1/Other_19.gml

@@ -1,7 +1,8 @@
 /// @desc Returns true if the given array contains the given value
-/// @param {String|Array|DS_Map} collection The collection to search
+/// @param {String|Array|DS_Map|DS_List} collection The collection to search
 /// @param {*} value The value to look for
 /// @param {Real} optionalFromIndex [0] The index to begin looking from
+/// @param {ds_type} optionalDSType [ds_type_list] The type of the ds, if this is a ds.
 /// @returns {Boolean} True if the collection contains the target, otherwise false
 /*
 @example
@@ -19,10 +20,17 @@ var collection = argument[0];
 var target = argument[1];
 var fromIndex = 0;
 
-if (argument_count == 3) {
+// TODO: This should default to ds_type_list in the next major version
+var dsType = ds_type_map;
+
+if (argument_count > 2) {
     fromIndex = argument[2];
 }
 
+if (argument_count > 3) {
+    dsType = argument[3];
+}
+
 if (is_string(collection)) {
 
     // If it is a string, check to see if the target is in the string.
@@ -38,18 +46,32 @@ if (is_string(collection)) {
     }
     return false;
 } else if (is_real(collection)) {
-    
-    // If it is a real, assume it is a ds ID.
-    if (ds_exists(collection, ds_type_map)) {
+    if (dsType == ds_type_map) {
         var keys = _keys(collection);
-        for (var i = fromIndex; i < _length(keys); i++) {
-            var thisValue = ds_map_find_value(collection, keys[i])
+        var n = _length(keys);
+        for (var i = fromIndex; i < n; i++) {
+            var thisValue = collection[? keys[i]];
             if (_typeOf(thisValue) == _typeOf(target) && thisValue == target) {
                 return true;
             }
         }
         return false;
+    } else if (dsType == ds_type_list) {
+        var n = _length(collection);
+        for (var i = fromIndex; i < n; i++) {
+            var thisValue = collection[| i];
+            if (_typeOf(thisValue) == _typeOf(target) && thisValue == target) {
+                return true;
+            }
+        }
+    } else {
+        show_error("Cannot look for value in ds type: " + string(dsType) + "\nIf using _contains with a data structure, it must be a list or map.", false);
     }
+} else if (is_undefined(collection)) {
+    return false;
+} else {
+    // Catch case for unknown collection
+    show_error("Cannot look for value in type: " + _typeOf(collection) + "\nCollection must be a string, array, map or list.", false);
 }
-// Catch case for unknown collection
+
 return false;

src/gdash/scripts/_contains/_contains.gml

@@ -1,7 +1,9 @@
-/// @desc Returns an array where values of the input array are truthy when run through the provided function.
-/// @param {Array} inputArray The array to filter
+/// @desc Returns a collection where values of the input collection are truthy when run through the provided function.
+/// @param {Array|ds_list} collection The collection to filter
 /// @param {Script} filterScript The script to filter with
-/// @returns {Array} The filtered array
+/// @returns {Array|ds_list} The filtered collection
+/// Note: Returns the same type as the given collection. Creates a new list if the collection is a list.
+///       the original collection will not be destroyed, so if you pass in a list, you will still need to destroy it.
 /*
 @example
 _filter(_arrayOf(0, 1, 2, 3), lessThanTwo)
@@ -10,14 +12,28 @@ _filter(_arrayOf(0, 1, 2, 3), lessThanTwo)
 */
 
 var result;
+var collection = argument0;
 var j = 0;
-var n = _length(argument0);
+var n = _length(collection);
+var type = _typeOf(collection);
 
-for (var i = 0; i < n; i++) {
-    if (_run(argument1, argument0[@ i])) {
-        result[j] = argument0[@ i];
-        j++;
-    }    
+if (type == "real") {
+    result = ds_list_create();
+    for (var i = 0; i < n; i++) {
+        if (_run(argument1, collection[| i])) {
+            result[| j] = collection[| i];
+            j++;
+        }    
+    }
+} else if (type == "array") {
+    for (var i = 0; i < n; i++) {
+        if (_run(argument1, collection[@ i])) {
+            result[j] = collection[@ i];
+            j++;
+        }    
+    }
+} else {
+    show_error("Cannot filter type: " + type + "\nCollection must be an array or ds_list", false);
 }
 
 return result;

src/gdash/scripts/_filter/_filter.gml

@@ -1,5 +1,5 @@
 /// @desc Reduces a collection by iterating over it with a function. Provided script should take 2 arguments: total, value. On the first call, total is undefined.
-/// @param {Array} inputArray The array to reduce
+/// @param {Array|ds_list} collection The collection to reduce
 /// @param {Script} recuderScript The script to reduce with
 /// @returns {*} The reduced value from the given script
 /*
@@ -13,13 +13,22 @@ _reduce(arr, concat);
 // => 'helloworld';
 */
 
-var array = argument[0];
+var collection = argument[0];
 var func = argument[1];
 var result = undefined;
-var n = _length(array);
+var n = _length(collection);
+var type = _typeOf(collection);
 
-for (var i = 0; i < n; i++) {
-    result = _run(func, result, array[@ i]);
+if (type == "real") {
+    for (var i = 0; i < n; i++) {
+        result = _run(func, result, collection[| i]);
+    }
+} else if (type == "array") {
+    for (var i = 0; i < n; i++) {
+        result = _run(func, result, collection[@ i]);
+    }
+} else {
+    show_error("Cannot reduce type: " + type + "\nCollection must be an array or ds_list", false);
 }
 
 return result;

src/gdash/scripts/_reduce/_reduce.gml

@@ -0,0 +1,12 @@
+/// @desc Converts the given ds_list to an array
+/// @param list
+
+var list = argument0;
+var listSize = ds_list_size(list);
+var array;
+
+for (var i = listSize - 1; i >= 0; i--) {
+    array[i] = list[| i];
+}
+
+return array;