NGramsTrait::frequency() - Code Metrics - Inspection of "Add method frequency()." - drupol/phpngrams - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0e6f4c...e299fb )

by Pol

created 2018-02-05 20:51 UTC

NGramsTrait::frequency() A

↳ Parent: NGramsTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	2
crap	1

<?php

namespace drupol\phpngrams;

trait NGramsTrait
{
    /**
     * @param array $data
     * @param int $n
     * @param bool $cyclic
     *
     * @return \Generator
     */
    public function ngramsArray(array $data, $n = 1, $cyclic = true)

    {
        return $this->doNgrams($data, $n, $cyclic);
    }

    /**
     * @param string $data
     * @param int $n
     * @param bool $cyclic
     *
     * @return \Generator
     */
    public function ngramsString($data, $n = 1, $cyclic = true)

    {
        foreach ($this->doNgrams(str_split($data), $n, $cyclic) as $data) {
            yield implode('', $data);
        }
    }

    /**
     * @param \Generator $ngrams
     * @param string $substring
     *
     * @return float|int
     */
    public function frequency(\Generator $ngrams, $substring)
    {
        $ngrams = iterator_to_array($ngrams);


        return count(array_filter($ngrams, function ($n) use ($substring) {

            return $n === $substring;
        }))/count($ngrams);
    }

    /**
     * @param $data
     * @param $n
     * @param $cyclic
     *
     * @return \Generator
     */
    private function doNgrams($data, $n = 1, $cyclic = true)

    {
        $dataLength = count($data);

        $n = $n > $dataLength ? $dataLength : $n;


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

        for ($j = 0; $j < $length; $j++) {
            $ngrams = [];
            for ($i = $j; $i < $n + $j; $i++) {
                $ngrams[] = $data[$i%$dataLength];
            }
            yield $ngrams;
        }
    }
}


1		<?php
2
3		namespace drupol\phpngrams;
4
5		trait NGramsTrait
6		{
7		/**
8		* @param array $data
9		* @param int $n
10		* @param bool $cyclic
11		*
12		* @return \Generator
13		*/
14	3	public function ngramsArray(array $data, $n = 1, $cyclic = true)
		0 ignored issues – show Comprehensibility introduced 2018-02-05 19:41 UTC by Report Bug Copy Issue Report Avoid variables with short names like $n. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
15		{
16	3	return $this->doNgrams($data, $n, $cyclic);
17		}
18
19		/**
20		* @param string $data
21		* @param int $n
22		* @param bool $cyclic
23		*
24		* @return \Generator
25		*/
26	4	public function ngramsString($data, $n = 1, $cyclic = true)
		0 ignored issues – show Comprehensibility introduced 2018-02-05 19:41 UTC by Report Bug Copy Issue Report Avoid variables with short names like $n. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
27		{
28	4	foreach ($this->doNgrams(str_split($data), $n, $cyclic) as $data) {
29	4	yield implode('', $data);
30		}
31	4	}
32
33		/**
34		* @param \Generator $ngrams
35		* @param string $substring
36		*
37		* @return float\|int
38		*/
39	1	public function frequency(\Generator $ngrams, $substring)
40		{
41	1	$ngrams = iterator_to_array($ngrams);
		0 ignored issues – show Coding Style introduced 2018-02-05 20:57 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$ngrams`. This often makes code more readable. Loading history...
42
43	1	return count(array_filter($ngrams, function ($n) use ($substring) {
		0 ignored issues – show Comprehensibility introduced 2018-02-05 20:59 UTC by Report Bug Copy Issue Report Avoid variables with short names like $n. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
44	1	return $n === $substring;
45	1	}))/count($ngrams);
46		}
47
48		/**
49		* @param $data
50		* @param $n
51		* @param $cyclic
52		*
53		* @return \Generator
54		*/
55	7	private function doNgrams($data, $n = 1, $cyclic = true)
		0 ignored issues – show Comprehensibility introduced 2018-02-05 19:41 UTC by Report Bug Copy Issue Report Avoid variables with short names like $n. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
56		{
57	7	$dataLength = count($data);
58
59	7	$n = $n > $dataLength ? $dataLength : $n;
		0 ignored issues – show Coding Style introduced 2018-02-05 19:41 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$n`. This often makes code more readable. Loading history...
60
61	7	$length = (false === $cyclic ? $dataLength - $n + 1 : $dataLength);
62
63	7	for ($j = 0; $j < $length; $j++) {
64	7	$ngrams = [];
65	7	for ($i = $j; $i < $n + $j; $i++) {
66	7	$ngrams[] = $data[$i%$dataLength];
67		}
68	7	yield $ngrams;
69		}
70	7	}
71		}
72

drupol / phpngrams

Push — master ( 0e6f4c...e299fb )

NGramsTrait::frequency() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like