drupol\phpngrams\AbstractNGrams

Complexity

Total Complexity

7

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	ngramsFactory()	0	4	2
A	doNgrams()	0	12	4
A	frequency()	0	12	1

<?php

declare(strict_types = 1);

namespace drupol\phpngrams;

use drupol\phpermutations\Iterators\NGrams;

This use statement conflicts with another class in this namespace, drupol\phpngrams\NGrams. Consider defining an alias.

/**
 * Class AbstractNGrams.
 */
abstract class AbstractNGrams implements NGramsInterface
{
    /**
     * {@inheritdoc}
     */
    public function frequency(\Generator $ngrams, array $subset)
    {
        $ngrams = iterator_to_array($ngrams);

        return \count(
            array_filter(
                $ngrams,
                static function ($n) use ($subset) {
                    return $n === $subset;
                }
            )
        ) / \count($ngrams);
    }

    /**
     * {@inheritdoc}
     */
    abstract public function ngrams(array $data, int $n = 1);

    /**
     * @param array $data
     * @param int $n
     * @param bool $cyclic
     *
     * @return bool|\Generator
     */
    protected function ngramsFactory(array $data, int $n, bool $cyclic)
    {
        foreach ($this->doNgrams($data, $n, $cyclic) as $item) {
            yield $item;
        }
    }

    /**
     * @param array $data
     * @param int $n
     * @param bool $cyclic
     *
     * @return \Generator
     */
    private function doNgrams(array $data, int $n, bool $cyclic)
    {
        $dataLength = \count($data);
        $n = $n > $dataLength ? $dataLength : $n;

        $ngrams = new NGrams($data, $n);

        $length = (false === $cyclic ? $dataLength - $n + 1 : $dataLength);

        for ($j = 0; $j < $length; ++$j) {
            yield \array_slice($ngrams->current(), 0, $n);
            $ngrams->rewind();
        }
    }
}