Merge pull request #117 from salehhashemi1992/mode-function-multiple-return

Enhance mode() Function to Return Multiple Modes

Author: darwinz

Maths/Mode.php

@@ -1,20 +1,21 @@
 <?php
 /**
  * This function calculates
- * The mode value of
+ * the mode value(s) of
  * numbers provided
- * 
+ *
  * @param decimal $numbers A variable sized number input
- * @return decimal $mode Mode of provided numbers
+ * @return array $modes Array of mode(s) of provided numbers
+ * @throws \Exception
  */
 function mode(...$numbers)
 {
     if (empty($numbers)) {
-        throw new \Exception('Please pass values to find mean value');
+        throw new \Exception('Please pass values to find the mode');
     }
 
-    $values = array_count_values($numbers); 
-    $mode = array_search(max($values), $values);
+    $values = array_count_values($numbers);
+    $maxCount = max($values);
 
-    return $mode;
+    return array_keys($values, $maxCount, true);
 }

tests/Maths/MathsTest.php

@@ -141,8 +141,10 @@ public function testMedian()
 
     public function testMode()
     {
-        mode(4,2,7,9,2,9,0,4,2);
-        mode(21,72,40,21,0,99,21,99,0,40);
-        mode(3,3,3,3);
+        $this->assertEquals([3], mode(1, 2, 3, 3, 4, 5));
+        $this->assertEquals([5, 6], mode(5, 5, 6, 6, 7));
+        $this->assertEquals([1, 2, 3, 4, 5], mode(1, 2, 3, 4, 5));
+        $this->assertEquals([2, 3, 4], mode(2, 2, 3, 3, 4, 4));
     }
+
 }