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() {

Spacing +23 added lines, -23 removed lines

@@ -112,8 +112,8 @@ 
  * @param callable $predicate the filter function
  * @return \Closure
  */
-function _make_filterer (callable $append, callable $predicate) {
-	return function ($acc, ...$entry) use ($append, $predicate) {
+function _make_filterer(callable $append, callable $predicate) {
+	return function($acc, ...$entry) use ($append, $predicate) {
 		if ($predicate($entry[0])) {
 			$append($acc, ...$entry);
 		}
@@ -202,7 +202,7 @@ 
  */
 function reduce() {
     static $reduce = false;
-    $reduce = $reduce ?: curry(function($fn, $initial, $list){
+    $reduce = $reduce ?: curry(function($fn, $initial, $list) {
         return array_reduce($list, $fn, $initial);
     });
     return _apply($reduce, func_get_args());
@@ -229,7 +229,7 @@ 
  */
 function each() {
     static $each = false;
-    $each = $each ?: curry(function($fn, $list){
+    $each = $each ?: curry(function($fn, $list) {
         foreach ($list as $item) {
             $fn($item);
         }
@@ -279,10 +279,10 @@ 
  * @param  array|string $list
  * @return mixed
  */
-function last () {
+function last() {
     static $last = false;
     $last = $last ?: curry(function($list) {
-        if(is_string($list))
+        if (is_string($list))
             return substr($list, -1);
         $size = count($list);
         return ($size > 0)
@@ -309,10 +309,10 @@ 
  * @param  array|string $list
  * @return array
  */
-function init () {
+function init() {
     static $init = false;
     $init = $init ?: curry(function($list) {
-        if(is_string($list)) {
+        if (is_string($list)) {
             $size = strlen($list);
             return ($size > 1)
                 ? substr($list, 0, $size - 1)
@@ -343,10 +343,10 @@ 
  * @param  array|string $list
  * @return array
  */
-function tail () {
+function tail() {
     static $tail = false;
     $tail = $tail ?: curry(function($list) {
-        if(is_string($list))
+        if (is_string($list))
             return (strlen($list) > 1)
                 ? substr($list, 1)
                 : '';
@@ -371,7 +371,7 @@ 
  * @param  array|string $list
  * @return array
  */
-function reverse () {
+function reverse() {
     static $reverse = false;
     $reverse = $reverse ?: curry(function($list) {
         return is_string($list)
@@ -424,7 +424,7 @@ 
     static $allSatisfies = false;
     $allSatisfies = $allSatisfies ?: curry(function($predicate, $list) {
         foreach ($list as $item) {
-            if (! $predicate($item))
+            if (!$predicate($item))
                 return false;
         }
         return true;
@@ -600,7 +600,7 @@ 
  */
 function append() {
     static $append = false;
-    $append = $append ?: curry(function ($item, $list) {
+    $append = $append ?: curry(function($item, $list) {
         return is_string($list)
             ? $list . $item
             : array_merge($list, [$item]);
@@ -626,7 +626,7 @@ 
  */
 function prepend() {
     static $prepend = false;
-    $prepend = $prepend ?: curry(function ($item, $list) {
+    $prepend = $prepend ?: curry(function($item, $list) {
         return is_string($list)
             ? $item . $list
             : array_merge([$item], $list);
@@ -661,7 +661,7 @@ 
         $length = length($list);
         if ($count > $length || $count < -$length)
             return $list;
-        if(is_string($list)) {
+        if (is_string($list)) {
             return ($count >= 0)
                 ? substr($list, 0, $count)
                 : substr($list, $count);
@@ -812,7 +812,7 @@ 
         $count = ($count > 0)
             ? $count - $length
             : $count + $length;
-        if(is_string($list)) {
+        if (is_string($list)) {
             return ($count >= 0)
                 ? substr($list, 0, $count)
                 : substr($list, $count);
@@ -1169,7 +1169,7 @@ 
     $indexOf = $indexOf ?: curry(function($item, $list) {
         if (is_string($list)) {
             $index = strpos($list, $item);
-            return $index === false ? -1 : $index;
+            return $index === false ? - 1 : $index;
         }
         $list = (array) $list;
         $index = 0;
@@ -1180,7 +1180,7 @@ 
                 return $keys[$index];
             $index ++;
         }
-        return -1;
+        return - 1;
     });
     return _apply($indexOf, func_get_args());
 }
@@ -1209,7 +1209,7 @@ 
     $lastIndexOf = $lastIndexOf ?: curry(function($item, $list) {
         if (is_string($list)) {
             $index = strrpos($list, $item);
-            return $index === false ? -1 : $index;
+            return $index === false ? - 1 : $index;
         }
         $list = (array) $list;
         $keys = array_keys($list);
@@ -1219,7 +1219,7 @@ 
                 return $keys[$index];
             $index --;
         }
-        return -1;
+        return - 1;
     });
     return _apply($lastIndexOf, func_get_args());
 }
@@ -1254,7 +1254,7 @@ 
                 }
                 $index ++;
             }
-            if (! $found) {
+            if (!$found) {
                 $result[$size] = $item;
                 $size ++;
             }
@@ -1314,9 +1314,9 @@ 
     static $groupBy = false;
     $groupBy = $groupBy ?: curry(function($fn, $list) {
         $result = [];
-        foreach($list as $item) {
+        foreach ($list as $item) {
             $index = $fn($item);
-            if (! isset($result[$index]))
+            if (!isset($result[$index]))
                 $result[$index] = [];
             $result[$index][] = $item;
         }