loophp\iterators\RandomIterableAggregate

Complexity

Total Complexity

6

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	randomize()	0	19	4
A	__construct()	0	4	1
A	getIterator()	0	5	1

<?php

/**
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace loophp\iterators;

use ArrayIterator;
use Generator;
use Iterator;
use IteratorAggregate;
use Traversable;

use const PHP_INT_MAX;
use const PHP_INT_MIN;

/**
 * @template TKey
 * @template T
 *
 * @implements IteratorAggregate<TKey, T>
 */
final class RandomIterableAggregate implements IteratorAggregate
{
    /**
     * @var IteratorAggregate<int, array{0: TKey, 1: T}>
     */
    private IteratorAggregate $iteratorAggregate;

    private int $seed;

    /**
     * @param iterable<TKey, T> $iterable
     */
    public function __construct(iterable $iterable, int $seed = 0)
    {
        $this->iteratorAggregate = new PackIterableAggregate($iterable);
        $this->seed = $seed;
    }

    /**
     * @return Traversable<TKey, T>
     */
    public function getIterator(): Traversable
    {
        mt_srand($this->seed);

        yield from $this->randomize($this->iteratorAggregate, $this->seed);
    }

    /**
     * @param Traversable<int, array{0: TKey, 1: T}> $traversable
     *
     * @return Generator<TKey, T>
     */
    private function randomize(Traversable $traversable, int $seed): Generator
    {
        $isQueueEmpty = true;
        /** @var ArrayIterator<int, array{0: TKey, 1: T}> $queue */
        $queue = new ArrayIterator();

        foreach (new UnpackIterableAggregate($traversable) as $key => $value) {
            if (mt_rand(0, $seed) === 0) {
                yield $key => $value;

                continue;
            }

            $queue->append([$key, $value]);
            $isQueueEmpty = false;
        }

        if (false === $isQueueEmpty) {
            yield from $this->randomize($queue, $seed);
        }
    }
}