drupol\phpermutations\Iterators\FiniteGroup

Complexity

Total Complexity

13

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	computeGroup()	0	7	3
A	next()	0	4	1
A	getSize()	0	3	1
A	setSize()	0	4	1
A	gcd()	0	3	2
A	order()	0	10	2
A	count()	0	3	1
A	valid()	0	3	1
A	current()	0	3	1

<?php

declare(strict_types=1);

namespace drupol\phpermutations\Iterators;

use drupol\phpermutations\Iterators;

use function count;

/**
 * Class FiniteGroup.
 *
 * The finite group is an abelian finite cyclic group.
 */
class FiniteGroup extends Iterators
{
    /**
     * The group.
     *
     * @var int[]
     */
    protected $group;

    /**
     * The group size.
     *
     * @var int
     */
    protected $size;

    /**
     * Count elements of an object.
     *
     * @return int
     *             The number of element
     */
    public function count(): int
    {
        return count($this->group);
    }

    /**
     * {@inheritdoc}
     */
    public function current(): mixed
    {
        return current($this->group);
    }

    /**
     * Get the group size.
     *
     * @return int
     *             The size
     */
    public function getSize(): int
    {
        return (int) $this->size;
    }

    /**
     * {@inheritdoc}
     *
     * @return void
     */
    public function next(): void
    {
        ++$this->key;
        next($this->group);
    }

    /**
     * Get the order.
     *
     * @param int $generator
     *                       The generator
     *
     * @return int
     *             The order
     */
    public function order($generator): int
    {
        $result = [];

        foreach (range(1, $this->getSize()) as $number) {
            $value = ($generator ** $number) % $this->getSize();
            $result[$value] = $value;
        }

        return count($result);
    }

    /**
     * Set the group size.
     *
     * @param int $size
     *                  The size
     *
     * @return void
     */
    public function setSize($size): void
    {
        $this->size = $size;
        $this->computeGroup();
    }

    /**
     * {@inheritdoc}
     *
     * @return bool
     */
    public function valid(): bool
    {
        return isset($this->group[$this->key()]);
    }

    /**
     * Clean out the group from unwanted values.
     *
     * @return void
     */
    private function computeGroup(): void
    {
        $this->group = [];

        foreach (range(1, $this->getSize()) as $number) {
            if (1 === $this->gcd($number, $this->getSize())) {
                $this->group[] = $number;
            }
        }
    }

    /**
     * Get the greater common divisor between two numbers.
     *
     * @param int $a
     *               The first number
     * @param int $b
     *               The second number
     *
     * @return int
     *             The greater common divisor between $a and $b
     */
    private function gcd($a, $b): int
    {
        return $b ? $this->gcd($b, $a % $b) : $a;
    }
}