tarsana / functional

src/list.php

Doc Comments -82 removed lines

@@ -15,8 +15,6 @@ 
  * @stream
  * @signature (a -> b) -> [a] -> [b]
  * @signature (a -> b) -> {k: a} -> {k: b}
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function map() {
@@ -36,8 +34,6 @@ 
  *
  * @stream
  * @signature (a -> [b]) -> [a] -> [b]
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function chain() {
@@ -66,8 +62,6 @@ 
  * ```
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $fn
- * @param  array|\ArrayObject|\SplObjectStorage $list
  * @return array|\ArrayObject|\SplObjectStorage|callable
  */
 function filter() {
@@ -150,8 +144,6 @@ 
  * ```
  *
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param callable $predicate
- * @param array|\ArrayObject|\SplObjectStorage $list
  * @return array|\ArrayObject|\SplObjectStorage|callable
  */
 function filter_values() {
@@ -195,9 +187,6 @@ 
  *
  * @stream
  * @signature (* -> a -> *) -> * -> [a] -> *
- * @param  callable $fn
- * @param  mixed $initial
- * @param  array $list
  * @return array
  */
 function reduce() {
@@ -223,8 +212,6 @@ 
  *
  * @stream
  * @signature (a -> *) -> [a] -> [a]
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function each() {
@@ -251,7 +238,6 @@ 
  * @stream
  * @signature [a] -> a
  * @signature String -> String
- * @param  array|string $list
  * @return mixed
  */
 function head() {
@@ -276,7 +262,6 @@ 
  * @stream
  * @signature [a] -> a
  * @signature String -> String
- * @param  array|string $list
  * @return mixed
  */
 function last () {
@@ -306,7 +291,6 @@ 
  * @stream
  * @signature [a] -> a
  * @signature String -> String
- * @param  array|string $list
  * @return array
  */
 function init () {
@@ -340,7 +324,6 @@ 
  * @stream
  * @signature [a] -> a
  * @signature String -> String
- * @param  array|string $list
  * @return array
  */
 function tail () {
@@ -368,7 +351,6 @@ 
  * @stream
  * @signature [a] -> [a]
  * @signature String -> String
- * @param  array|string $list
  * @return array
  */
 function reverse () {
@@ -392,7 +374,6 @@ 
  * @stream
  * @signature [a] -> Number
  * @signature String -> Number
- * @param  array|string $list
  * @return int
  */
 function length() {
@@ -416,8 +397,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> Boolean
- * @param  callable $predicate
- * @param  array $list
  * @return bool
  */
 function allSatisfies() {
@@ -443,8 +422,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> Boolean
- * @param  callable $predicate
- * @param  array $list
  * @return bool
  */
 function anySatisfies() {
@@ -470,8 +447,6 @@ 
  * @stream
  * @signature [*] -> [*] -> [*]
  * @signature String -> String -> String
- * @param  array $list1
- * @param  array $list2
  * @return array
  */
 function concat() {
@@ -494,7 +469,6 @@ 
  *
  * @stream
  * @signature [[a]] -> [a]
- * @param  array $lists
  * @return array
  */
 function concatAll() {
@@ -529,9 +503,6 @@ 
  * @stream
  * @signature Number -> a -> [a] -> [a]
  * @signature Number -> String -> String -> String
- * @param  int $position
- * @param  mixed $item
- * @param  array $list
  * @return array
  */
 function insert() {
@@ -559,9 +530,6 @@ 
  * @stream
  * @signature Number -> [a] -> [a] -> [a]
  * @signature Number -> String -> String -> String
- * @param  int $position
- * @param  mixed $items
- * @param  array $list
  * @return array
  */
 function insertAll() {
@@ -594,8 +562,6 @@ 
  * @stream
  * @signature * -> [*] -> [*]
  * @signature String -> String -> String
- * @param  mixed $item
- * @param  array $list
  * @return array
  */
 function append() {
@@ -620,8 +586,6 @@ 
  * @stream
  * @signature a -> [a] -> [a]
  * @signature String -> String -> String
- * @param  mixed $item
- * @param  array $list
  * @return array
  */
 function prepend() {
@@ -651,8 +615,6 @@ 
  * @stream
  * @signature Number -> [a] -> [a]
  * @signature Number -> String -> String
- * @param  int $count
- * @param  array $list
  * @return array
  */
 function take() {
@@ -685,8 +647,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeWhile() {
@@ -712,8 +672,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeLastWhile() {
@@ -739,8 +697,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeUntil() {
@@ -766,8 +722,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function takeLastUntil() {
@@ -798,8 +752,6 @@ 
  * @stream
  * @signature Number -> [a] -> [a]
  * @signature Number -> String -> String
- * @param  int $count
- * @param  array $list
  * @return array
  */
 function remove() {
@@ -836,8 +788,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeWhile() {
@@ -863,8 +813,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeLastWhile() {
@@ -891,8 +839,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeUntil() {
@@ -919,8 +865,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> [a]
- * @param  callable $predicate
- * @param  array $list
  * @return array
  */
 function removeLastUntil() {
@@ -943,7 +887,6 @@ 
  *
  * @stream
  * @signature [(k, v)] -> {k: v}
- * @param  array $pairs
  * @return stdClass
  */
 function fromPairs() {
@@ -973,8 +916,6 @@ 
  * @stream
  * @signature Number -> [a] -> [[a]]
  * @signature Number -> String -> [String]
- * @param  int $size
- * @param  array $list
  * @return array
  */
 function slices() {
@@ -1008,8 +949,6 @@ 
  * @stream
  * @signature a -> [a] -> Boolean
  * @signature String -> String -> Boolean
- * @param  mixed $item
- * @param  array|string $list
  * @return bool
  */
 function contains() {
@@ -1035,8 +974,6 @@ 
  * @stream
  * @signature (a -> Boolean) -> [a] -> Maybe(Number)
  * @signature (v -> Boolean) -> {k: v} -> Maybe(k)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function findIndex() {
@@ -1064,8 +1001,6 @@ 
  * @stream
  * @signature (a -> Boolean) -> [a] -> Maybe(Number)
  * @signature (v -> Boolean) -> {k: v} -> Maybe(k)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function findLastIndex() {
@@ -1094,8 +1029,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> Maybe(a)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function find() {
@@ -1121,8 +1054,6 @@ 
  *
  * @stream
  * @signature (a -> Boolean) -> [a] -> Maybe(a)
- * @param  callable $predicate
- * @param  array $list
  * @return mixed
  */
 function findLast() {
@@ -1160,8 +1091,6 @@ 
  * @signature a -> [a] -> Number
  * @signature v -> {k: v} -> Maybe(k)
  * @signature String -> String -> Number
- * @param  mixed $item
- * @param  array $list
  * @return int
  */
 function indexOf() {
@@ -1200,8 +1129,6 @@ 
  * @signature a -> [a] -> Number
  * @signature v -> {k: v} -> Maybe(k)
  * @signature String -> String -> Number
- * @param  mixed $item
- * @param  array $list
  * @return int
  */
 function lastIndexOf() {
@@ -1235,8 +1162,6 @@ 
  *
  * @stream
  * @signature (a -> a -> Boolean) -> [a] -> [a]
- * @param  callable $areEqual
- * @param  array $list
  * @return array
  */
 function uniqueBy() {
@@ -1273,7 +1198,6 @@ 
  *
  * @stream
  * @signature [a] -> [a]
- * @param  array $list
  * @return array
  */
 function unique() {
@@ -1306,8 +1230,6 @@ 
  *
  * @stream
  * @signature (a -> String) -> [a] -> {String: a}
- * @param  callable $fn
- * @param  array $list
  * @return array
  */
 function groupBy() {
@@ -1337,8 +1259,6 @@ 
  *
  * @stream
  * @signature [a] -> [b] -> [[a,b]]
- * @param  array $list1
- * @param  array $list2
  * @return array
  */
 function pairsFrom() {
@@ -1383,8 +1303,6 @@ 
  *
  * @stream
  * @signature (a -> a -> Boolean) -> [a] -> [a]
- * @param  callable $compare
- * @param  array $list
  * @return array
  */
 function sort() {

Braces +93 added lines, -61 removed lines

@@ -83,8 +83,9 @@ 
     	if ($isArray)
 	    {
 	    	foreach ($list as $item) {
-	            if ($fn($item))
-	                $result[] = $item;
+	            if ($fn($item)) {
+	            	                $result[] = $item;
+	            }
 	        }
 	        return $result;
 	    }
@@ -257,7 +258,9 @@ 
 function head() {
     static $head = false;
     $head = $head ?: curry(function($list) {
-        if (isset($list[0])) return $list[0];
+        if (isset($list[0])) {
+            return $list[0];
+        }
         return is_string($list) ? '' : null;
     });
     return _apply($head, func_get_args());
@@ -282,8 +285,9 @@ 
 function last () {
     static $last = false;
     $last = $last ?: curry(function($list) {
-        if(is_string($list))
-            return substr($list, -1);
+        if(is_string($list)) {
+                    return substr($list, -1);
+        }
         $size = count($list);
         return ($size > 0)
             ? $list[$size - 1]
@@ -346,10 +350,11 @@ 
 function tail () {
     static $tail = false;
     $tail = $tail ?: curry(function($list) {
-        if(is_string($list))
-            return (strlen($list) > 1)
+        if(is_string($list)) {
+                    return (strlen($list) > 1)
                 ? substr($list, 1)
                 : '';
+        }
         return (count($list) > 1)
             ? array_slice($list, 1)
             : [];
@@ -424,8 +429,9 @@ 
     static $allSatisfies = false;
     $allSatisfies = $allSatisfies ?: curry(function($predicate, $list) {
         foreach ($list as $item) {
-            if (! $predicate($item))
-                return false;
+            if (! $predicate($item)) {
+                            return false;
+            }
         }
         return true;
     });
@@ -451,8 +457,9 @@ 
     static $anySatisfies = false;
     $anySatisfies = $anySatisfies ?: curry(function($predicate, $list) {
         foreach ($list as $item) {
-            if ($predicate($item))
-                return true;
+            if ($predicate($item)) {
+                            return true;
+            }
         }
         return false;
     });
@@ -477,8 +484,9 @@ 
 function concat() {
     static $concat = false;
     $concat = $concat ?: curry(function($list1, $list2) {
-        if (is_string($list1) && is_string($list2))
-            return $list1 . $list2;
+        if (is_string($list1) && is_string($list2)) {
+                    return $list1 . $list2;
+        }
         return array_merge($list1, $list2);
     });
     return _apply($concat, func_get_args());
@@ -500,10 +508,12 @@ 
 function concatAll() {
     static $concatAll = false;
     $concatAll = $concatAll ?: curry(function($lists) {
-        if (count($lists) == 0)
-            return [];
-        if (is_string($lists[0]))
-            return implode('', $lists);
+        if (count($lists) == 0) {
+                    return [];
+        }
+        if (is_string($lists[0])) {
+                    return implode('', $lists);
+        }
         return _apply('array_merge', $lists);
     });
     return _apply($concatAll, func_get_args());
@@ -568,14 +578,17 @@ 
     static $insertAll = false;
     $insertAll = $insertAll ?: curry(function($position, $items, $list) {
         $size = length($list);
-        if ($position < 0)
-            $position = $size + $position;
-        if ($position < 0)
-            $position = 0;
-        if (is_string($list))
-            return ($position >= $size)
+        if ($position < 0) {
+                    $position = $size + $position;
+        }
+        if ($position < 0) {
+                    $position = 0;
+        }
+        if (is_string($list)) {
+                    return ($position >= $size)
                 ? $list . $items
                 : substr($list, 0, $position) . $items . substr($list, $position);
+        }
         return ($position >= $size)
             ? array_merge($list, $items)
             : array_merge(array_slice($list, 0, $position), $items, array_slice($list, $position));
@@ -659,8 +672,9 @@ 
     static $take = false;
     $take = $take ?: curry(function($count, $list) {
         $length = length($list);
-        if ($count > $length || $count < -$length)
-            return $list;
+        if ($count > $length || $count < -$length) {
+                    return $list;
+        }
         if(is_string($list)) {
             return ($count >= 0)
                 ? substr($list, 0, $count)
@@ -694,8 +708,9 @@ 
     $takeWhile = $takeWhile ?: curry(function($predicate, $list) {
         $index = 0;
         $size = length($list);
-        while ($index < $size && $predicate($list[$index]))
-            $index ++;
+        while ($index < $size && $predicate($list[$index])) {
+                    $index ++;
+        }
         return array_slice($list, 0, $index);
     });
     return _apply($takeWhile, func_get_args());
@@ -720,8 +735,9 @@ 
     static $takeLastWhile = false;
     $takeLastWhile = $takeLastWhile ?: curry(function($predicate, $list) {
         $index = length($list) - 1;
-        while ($index >= 0 && $predicate($list[$index]))
-            $index --;
+        while ($index >= 0 && $predicate($list[$index])) {
+                    $index --;
+        }
         return array_slice($list, $index + 1);
     });
     return _apply($takeLastWhile, func_get_args());
@@ -748,8 +764,9 @@ 
     $takeUntil = $takeUntil ?: curry(function($predicate, $list) {
         $index = 0;
         $size = length($list);
-        while ($index < $size && !$predicate($list[$index]))
-            $index ++;
+        while ($index < $size && !$predicate($list[$index])) {
+                    $index ++;
+        }
         return array_slice($list, 0, $index);
     });
     return _apply($takeUntil, func_get_args());
@@ -774,8 +791,9 @@ 
     static $takeLastUntil = false;
     $takeLastUntil = $takeLastUntil ?: curry(function($predicate, $list) {
         $index = length($list) - 1;
-        while ($index >= 0 && !$predicate($list[$index]))
-            $index --;
+        while ($index >= 0 && !$predicate($list[$index])) {
+                    $index --;
+        }
         return array_slice($list, $index + 1);
     });
     return _apply($takeLastUntil, func_get_args());
@@ -807,8 +825,9 @@ 
     $remove = $remove ?: curry(function($count, $list) {
         // ...
         $length = length($list);
-        if ($count > $length || $count < -$length)
-            return [];
+        if ($count > $length || $count < -$length) {
+                    return [];
+        }
         $count = ($count > 0)
             ? $count - $length
             : $count + $length;
@@ -845,8 +864,9 @@ 
     $removeWhile = $removeWhile ?: curry(function($predicate, $list) {
         $index = 0;
         $size = length($list);
-        while ($index < $size && $predicate($list[$index]))
-            $index ++;
+        while ($index < $size && $predicate($list[$index])) {
+                    $index ++;
+        }
         return array_slice($list, $index);
     });
     return _apply($removeWhile, func_get_args());
@@ -871,8 +891,9 @@ 
     static $removeLastWhile = false;
     $removeLastWhile = $removeLastWhile ?: curry(function($predicate, $list) {
         $index = length($list) - 1;
-        while ($index >= 0 && $predicate($list[$index]))
-            $index --;
+        while ($index >= 0 && $predicate($list[$index])) {
+                    $index --;
+        }
         return array_slice($list, 0, $index + 1);
     });
     return _apply($removeLastWhile, func_get_args());
@@ -900,8 +921,9 @@ 
     $removeUntil = $removeUntil ?: curry(function($predicate, $list) {
         $index = 0;
         $size = length($list);
-        while ($index < $size && !$predicate($list[$index]))
-            $index ++;
+        while ($index < $size && !$predicate($list[$index])) {
+                    $index ++;
+        }
         return array_slice($list, $index);
     });
     return _apply($removeUntil, func_get_args());
@@ -927,8 +949,9 @@ 
     static $removeLastUntil = false;
     $removeLastUntil = $removeLastUntil ?: curry(function($predicate, $list) {
         $index = length($list) - 1;
-        while ($index >= 0 && !$predicate($list[$index]))
-            $index --;
+        while ($index >= 0 && !$predicate($list[$index])) {
+                    $index --;
+        }
         return array_slice($list, 0, $index + 1);
     });
     return _apply($removeLastUntil, func_get_args());
@@ -981,8 +1004,9 @@ 
     static $slices = false;
     $slices = $slices ?: curry(function($size, &$list) {
         $length = length($list);
-        if ($length == 0)
-            return is_string($list) ? [''] : [];
+        if ($length == 0) {
+                    return is_string($list) ? [''] : [];
+        }
         $start = 0;
         $result = [];
         $slicer = is_string($list) ? 'substr' : 'array_slice';
@@ -1043,8 +1067,9 @@ 
     static $findIndex = false;
     $findIndex = $findIndex ?: curry(function($predicate, $list) {
         foreach ($list as $key => &$value) {
-            if ($predicate($value))
-                return $key;
+            if ($predicate($value)) {
+                            return $key;
+            }
         }
         return null;
     });
@@ -1074,8 +1099,9 @@ 
         $keys = array_keys($list);
         $index = count($keys) - 1;
         while ($index >= 0) {
-            if ($predicate($list[$keys[$index]]))
-                return $keys[$index];
+            if ($predicate($list[$keys[$index]])) {
+                            return $keys[$index];
+            }
             $index --;
         }
         return null;
@@ -1102,8 +1128,9 @@ 
     static $find = false;
     $find = $find ?: curry(function($predicate, $list) {
         foreach ($list as $key => &$value) {
-            if ($predicate($value))
-                return $value;
+            if ($predicate($value)) {
+                            return $value;
+            }
         }
         return null;
     });
@@ -1131,8 +1158,9 @@ 
         $keys = array_keys($list);
         $index = count($keys) - 1;
         while ($index >= 0) {
-            if ($predicate($list[$keys[$index]]))
-                return $list[$keys[$index]];
+            if ($predicate($list[$keys[$index]])) {
+                            return $list[$keys[$index]];
+            }
             $index --;
         }
         return null;
@@ -1176,8 +1204,9 @@ 
         $keys = array_keys($list);
         $length = count($keys);
         while ($index < $length) {
-            if (_equals($item, $list[$keys[$index]]))
-                return $keys[$index];
+            if (_equals($item, $list[$keys[$index]])) {
+                            return $keys[$index];
+            }
             $index ++;
         }
         return -1;
@@ -1215,8 +1244,9 @@ 
         $keys = array_keys($list);
         $index = count($list) - 1;
         while ($index >= 0) {
-            if (_equals($list[$keys[$index]], $item))
-                return $keys[$index];
+            if (_equals($list[$keys[$index]], $item)) {
+                            return $keys[$index];
+            }
             $index --;
         }
         return -1;
@@ -1316,8 +1346,9 @@ 
         $result = [];
         foreach($list as $item) {
             $index = $fn($item);
-            if (! isset($result[$index]))
-                $result[$index] = [];
+            if (! isset($result[$index])) {
+                            $result[$index] = [];
+            }
             $result[$index][] = $item;
         }
         return $result;
@@ -1346,8 +1377,9 @@ 
     $pairsFrom = $pairsFrom ?: curry(function($list1, $list2) {
         $length1 = count($list1);
         $length2 = count($list2);
-        if (0 == $length1 || 0 == $length2)
-            return [];
+        if (0 == $length1 || 0 == $length2) {
+                    return [];
+        }
         $result = [];
         $index = 0;
         $length = min($length1, $length2);