chore: add common functions return types

Author: yemilgr

src/Combinatorics.php

@@ -50,7 +50,7 @@ public function __construct(array $dataset = [], $length = null)
      * @return int
      *             The number of element
      */
-    public function count()
+    public function count(): int
     {
         return count($this->toArray());
     }
@@ -61,7 +61,7 @@ public function count()
      * @return mixed[]
      *                 The dataset
      */
-    public function getDataset()
+    public function getDataset(): array
     {
         return $this->dataset;
     }
@@ -72,7 +72,7 @@ public function getDataset()
      * @return int
      *             The length
      */
-    public function getLength()
+    public function getLength(): int
     {
         return (int) $this->length;
     }
@@ -85,7 +85,7 @@ public function getLength()
      *
      * @return $this
      */
-    public function setDataset(array $dataset = [])
+    public function setDataset(array $dataset = []): Combinatorics
     {
         $this->dataset = $dataset;
 
@@ -100,7 +100,7 @@ public function setDataset(array $dataset = [])
      *
      * @return $this
      */
-    public function setLength($length = null)
+    public function setLength($length = null): Combinatorics
     {
         $length = $length ?? $this->datasetCount;
         $this->length = (abs($length) > $this->datasetCount) ? $this->datasetCount : $length;
@@ -111,7 +111,7 @@ public function setLength($length = null)
     /**
      * @return array<int, mixed>
      */
-    public function toArray()
+    public function toArray(): array
     {
         return [];
     }
@@ -127,7 +127,7 @@ public function toArray()
      * @return int
      *             The factorial of $n
      */
-    protected function fact($n, $total = 1)
+    protected function fact($n, $total = 1): int
     {
         return (2 > $n) ? $total : $this->fact($n - 1, $total * $n);
     }

src/GeneratorInterface.php

@@ -14,12 +14,12 @@ interface GeneratorInterface
      * @return Generator<int, mixed>
      *                    The generator
      */
-    public function generator();
+    public function generator(): Generator;
 
     /**
      * Convert the generator into an array.
      *
      * @return array<int, mixed>
      */
-    public function toArray();
+    public function toArray(): array;
 }

src/Generators/Combinations.php

@@ -21,7 +21,7 @@ class Combinations extends CombinationsIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): Generator
     {
         return $this->get($this->getDataset(), $this->getLength());
     }
@@ -36,7 +36,7 @@ public function generator()
      *
      * @return Generator<array>
      */
-    protected function get(array $dataset, $length)
+    protected function get(array $dataset, $length): Generator
     {
         $originalLength = count($dataset);
         $remainingLength = $originalLength - $length + 1;

src/Generators/Fibonacci.php

@@ -13,7 +13,7 @@ class Fibonacci extends FibonacciIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): Generator
     {
         return $this->get();
     }
@@ -23,7 +23,7 @@ public function generator()
      *
      * @return Generator<int>
      */
-    protected function get()
+    protected function get(): Generator
     {
         $a = 0;
         $b = 1;

src/Generators/FiniteGroup.php

@@ -18,7 +18,7 @@ class FiniteGroup extends FiniteGroupIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): Generator
     {
         return $this->get();
     }
@@ -29,7 +29,7 @@ public function generator()
      * @return Generator<int>
      *                    The finite group generator
      */
-    protected function get()
+    protected function get(): Generator
     {
         foreach ($this->group as $number) {
             yield $number;

src/Generators/NGrams.php

@@ -13,15 +13,15 @@ class NGrams extends NGramsIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): Generator
     {
         return $this->get();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         return [];
     }
@@ -32,7 +32,7 @@ public function toArray()
      * @return Generator<int>
      *                    The generator
      */
-    protected function get()
+    protected function get(): Generator
     {
         while (true) {
             $this->next();

src/Generators/Perfect.php

@@ -12,7 +12,7 @@ class Perfect extends PerfectIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): \Generator
     {
         for ($j = 2; $this->getMaxLimit() >= $j; ++$j) {
             if ($this->isPerfectNumber($j)) {

src/Generators/Permutations.php

@@ -36,15 +36,15 @@ public function __construct(array $dataset = [], $length = null)
     /**
      * {@inheritdoc}
      */
-    public function count()
+    public function count(): int
     {
         return $this->combinations->count() * $this->fact($this->getLength());
     }
 
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): Generator
     {
         foreach ($this->combinations->generator() as $combination) {
             foreach ($this->get($combination) as $current) {
@@ -56,7 +56,7 @@ public function generator()
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         $data = [];
 
@@ -75,7 +75,7 @@ public function toArray()
      *
      * @return Generator<array>
      */
-    protected function get(array $dataset)
+    protected function get(array $dataset): Generator
     {
         foreach ($dataset as $key => $firstItem) {
             $remaining = $dataset;

src/Generators/Prime.php

@@ -12,7 +12,7 @@ class Prime extends PrimeIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): \Generator
     {
         for ($j = 2; $this->getMaxLimit() >= $j; ++$j) {
             if ($this->isPrimeNumber($j)) {

src/Generators/PrimeFactors.php

@@ -12,7 +12,7 @@ class PrimeFactors extends PrimeFactorsIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): \Generator
     {
         $number = $this->getNumber();