Merge pull request #17 from yemilgr/returns-type-hints

chore: add common functions return types
drupol · May 12, 2024 · 00a3d1d · 00a3d1d
2 parents e11e36c + 637bb50
commit 00a3d1d
Show file tree

Hide file tree

Showing 22 changed files with 57 additions and 57 deletions.
diff --git a/src/Combinatorics.php b/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);
     }

diff --git a/src/GeneratorInterface.php b/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;
 }
diff --git a/src/Generators/Combinations.php b/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;

diff --git a/src/Generators/Fibonacci.php b/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;

diff --git a/src/Generators/FiniteGroup.php b/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;

diff --git a/src/Generators/NGrams.php b/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();

diff --git a/src/Generators/Perfect.php b/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)) {

diff --git a/src/Generators/Permutations.php b/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;

diff --git a/src/Generators/Prime.php b/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)) {

diff --git a/src/Generators/PrimeFactors.php b/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();
 

diff --git a/src/Generators/Product.php b/src/Generators/Product.php
@@ -15,7 +15,7 @@ class Product extends ProductIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): Generator
     {
         return $this->get($this->getDataset());
     }
@@ -28,7 +28,7 @@ public function generator()
      *
      * @return Generator<array>
      */
-    protected function get(array $data)
+    protected function get(array $data): Generator
     {
         if (!empty($data)) {
             if ($u = array_pop($data)) {

diff --git a/src/Generators/Shift.php b/src/Generators/Shift.php
@@ -12,7 +12,7 @@ class Shift extends ShiftIterator implements GeneratorInterface
     /**
      * {@inheritdoc}
      */
-    public function generator()
+    public function generator(): \Generator
     {
         while (true) {
             $this->next();
@@ -24,7 +24,7 @@ public function generator()
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         return [];
     }

diff --git a/src/Iterators.php b/src/Iterators.php
@@ -52,7 +52,7 @@ public function rewind()
      * @return array<int, mixed>
      *               The elements
      */
-    public function toArray()
+    public function toArray(): array
     {
         $data = [];
 

diff --git a/src/Iterators/Cycle.php b/src/Iterators/Cycle.php
@@ -13,7 +13,7 @@ class Cycle extends Iterators
     /**
      * {@inheritdoc}
      */
-    public function count()
+    public function count(): int
     {
         return count($this->getDataset());
     }
@@ -49,7 +49,7 @@ public function rewind()
      *
      * @return bool
      */
-    public function valid()
+    public function valid(): bool
     {
         return true;
     }

diff --git a/src/Iterators/Fibonacci.php b/src/Iterators/Fibonacci.php
@@ -44,7 +44,7 @@ public function __construct()
      * @return int
      *             The limit
      */
-    public function getMaxLimit()
+    public function getMaxLimit(): int
     {
         return (int) $this->max;
     }
@@ -88,7 +88,7 @@ public function setMaxLimit($max)
      *
      * @return bool
      */
-    public function valid()
+    public function valid(): bool
     {
         return $this->getMaxLimit() > $this->current;
     }

diff --git a/src/Iterators/FiniteGroup.php b/src/Iterators/FiniteGroup.php
@@ -35,7 +35,7 @@ class FiniteGroup extends Iterators
      * @return int
      *             The number of element
      */
-    public function count()
+    public function count(): int
     {
         return count($this->group);
     }
@@ -54,7 +54,7 @@ public function current()
      * @return int
      *             The size
      */
-    public function getSize()
+    public function getSize(): int
     {
         return (int) $this->size;
     }
@@ -79,7 +79,7 @@ public function next()
      * @return int
      *             The order
      */
-    public function order($generator)
+    public function order($generator): int
     {
         $result = [];
 
@@ -110,7 +110,7 @@ public function setSize($size)
      *
      * @return bool
      */
-    public function valid()
+    public function valid(): bool
     {
         return isset($this->group[$this->key()]);
     }
@@ -142,7 +142,7 @@ private function computeGroup()
      * @return int
      *             The greater common divisor between $a and $b
      */
-    private function gcd($a, $b)
+    private function gcd($a, $b): int
     {
         return $b ? $this->gcd($b, $a % $b) : $a;
     }

diff --git a/src/Iterators/Perfect.php b/src/Iterators/Perfect.php
@@ -56,7 +56,7 @@ public function current()
      * @return int
      *             The limit
      */
-    public function getMaxLimit()
+    public function getMaxLimit(): int
     {
         return (int) $this->max;
     }
@@ -67,7 +67,7 @@ public function getMaxLimit()
      * @return int
      *             The limit
      */
-    public function getMinLimit()
+    public function getMinLimit(): int
     {
         return 2 > $this->min ? 2 : $this->min;
     }
@@ -121,7 +121,7 @@ public function setMinLimit($min)
      *
      * @return bool
      */
-    public function valid()
+    public function valid(): bool
     {
         return $this->current() < $this->getMaxLimit();
     }
@@ -137,7 +137,7 @@ public function valid()
      * @return bool
      *              The true if the number is perfect, false otherwise
      */
-    protected function isPerfectNumber($number)
+    protected function isPerfectNumber($number): bool
     {
         $d = 0;
         $max = sqrt($number);