Flattener::setAddStep() - Code Metrics - Inspection of "Separate concerns" - vctls/php-interval-graph - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9aadcc...35c30e )

by Victor

created 2019-10-17 13:51 UTC

Flattener::setAddStep() A

↳ Parent: Flattener

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	4
rs	10

<?php

namespace Vctls\IntervalGraph;

use Closure;

/**
 * Transforms an array of overlapping intervals into another array of adjacent intervals.
 *
 * Each new interval holds the keys of the corresponding original intervals.
 *
 * @package Vctls\IntervalGraph
 */
class Flattener
{
    /** @var Closure Substract one step from a bound value. */
    protected $substractStep;

    /** @var Closure Add one step to the bound value. */
    protected $addStep;

    /**
     * Set the Closure for decrementing bound values when dealing with
     * discontinuous sets.
     *
     * @param Closure $substractStep
     * @return Flattener
     */
    public function setSubstractStep(Closure $substractStep): Flattener
    {
        $this->substractStep = $substractStep;
        return $this;
    }

    /**
     * Set the Closure for incrementing bound values when dealing with
     * discontinuous sets.
     *
     * @param Closure $addStep
     * @return Flattener
     */
    public function setAddStep(Closure $addStep): Flattener
    {
        $this->addStep = $addStep;
        return $this;
    }

    /**
     * Make an array of bounds from an array of intervals.
     *
     * Assign the value of the interval to each bound.
     *
     * Assign and a '+' sign if it is a low bound, and a '-' if it is an high bound.
     * ```
     * bound = [
     *   bound value,
     *   bound type,
     *   TODO included,
     *   interval key,
     *   interval value
     * ]
     * ```
     *
     * @param array[] $intervals
     * @return array[]
     */
    public static function intervalsToSignedBounds($intervals): array
    {
        $bounds = [];
        foreach ($intervals as $key => $interval) {
            // TODO Get included boolean from interval bound.
            $bounds[] = [$interval[1], '-', true, $key, $interval[2] ?? null];
            $bounds[] = [$interval[0], '+', true, $key, $interval[2] ?? null];
        }
        // Order the bounds.
        usort($bounds, static function (array $d1, array $d2) {
            return ($d1[0] < $d2[0]) ? -1 : 1;
        });
        return $bounds;
    }

    /**
     * Extract discrete values from an array of intervals.
     *
     * Intervals with the exact same lower and higher bound will be considered as discrete values.
     *
     * They will be removed from the initial array, and returned in a separate array.
     *
     * @param array $intervals The initial array.
     * @return array An array containing only discrete values.
     */
    public static function extractDiscreteValues(array &$intervals): array
    {
        $discreteValues = array_filter($intervals, static function ($interval) {
            return $interval[0] === $interval[1];
        });

        $intervals = array_diff_key($intervals, $discreteValues);

        return $discreteValues;
    }

    /**
     * Create each new interval and calculate its value based on the active intervals on each bound.
     *
     * @param array[] $intervals
     * @return array[]
     */
    public function flatten(array $intervals): array
    {

        $discreteValues = self::extractDiscreteValues($intervals);


        $bounds = self::intervalsToSignedBounds($intervals);
        $newIntervals = [];
        $activeIntervals = [];

        $boundsCount = count($bounds);

        // Create new intervals for each set of two consecutive bounds,
        // and calculate its total value.
        for ($i = 1; $i < $boundsCount; $i++) {

            // Set the current bound.
            [$curBoundValue, $curBoundType, $curBoundIncluded, $curBoundIntervalKey] = $bounds[$i - 1];
            [$nextBoundValue, $nextBoundType, $nextBoundIncluded] = $bounds[$i];

            if ($curBoundType === '+') {
                // If this is a low bound,
                // add the key of the interval to the array of active intervals.
                $activeIntervals[$curBoundIntervalKey] = true;
            } else {
                // If this is an high bound, remove the key.
                unset($activeIntervals[$curBoundIntervalKey]);
            }

            if (
                isset($this->addStep, $this->substractStep) && (
                    ($nextBoundIncluded && $nextBoundType === '+')
                    || (!$nextBoundIncluded && $nextBoundType === '+')
                )
            ) {
                $newHighBound = ($this->substractStep)($nextBoundValue);
            } else {
                $newHighBound = $nextBoundValue;
            }

            if (
                isset($this->addStep, $this->substractStep) && $curBoundType === '-' && $curBoundIncluded
            ) {
                $newLowBound = ($this->addStep)($curBoundValue);
            } else {
                $newLowBound = $curBoundValue;
            }

            $newIntervals[] = [
                $newLowBound,
                $newHighBound,
                $activeIntervals
            ];
        }

        // Remove empty interval generated when two or more intervals share a common bound.
        $newIntervals = array_values(array_filter($newIntervals, static function ($i) {
            // Use weak comparison in case of object typed bounds.
            return $i[0] != $i[1];
        }));


        // Push discrete values back into the array.
        if (!empty($discreteValues)) {
            array_push($newIntervals, ...$discreteValues);
        }

        return $newIntervals;
    }
}


1			<?php
2
3			namespace Vctls\IntervalGraph;
4
5			use Closure;
6
7			/**
8			* Transforms an array of overlapping intervals into another array of adjacent intervals.
9			*
10			* Each new interval holds the keys of the corresponding original intervals.
11			*
12			* @package Vctls\IntervalGraph
13			*/
14			class Flattener
15			{
16			/** @var Closure Substract one step from a bound value. */
17			protected $substractStep;
18
19			/** @var Closure Add one step to the bound value. */
20			protected $addStep;
21
22			/**
23			* Set the Closure for decrementing bound values when dealing with
24			* discontinuous sets.
25			*
26			* @param Closure $substractStep
27			* @return Flattener
28			*/
29			public function setSubstractStep(Closure $substractStep): Flattener
30			{
31			$this->substractStep = $substractStep;
32			return $this;
33			}
34
35			/**
36			* Set the Closure for incrementing bound values when dealing with
37			* discontinuous sets.
38			*
39			* @param Closure $addStep
40			* @return Flattener
41			*/
42			public function setAddStep(Closure $addStep): Flattener
43			{
44			$this->addStep = $addStep;
45			return $this;
46			}
47
48			/**
49			* Make an array of bounds from an array of intervals.
50			*
51			* Assign the value of the interval to each bound.
52			*
53			* Assign and a '+' sign if it is a low bound, and a '-' if it is an high bound.
54			* ```
55			* bound = [
56			* bound value,
57			* bound type,
58			* TODO included,
59			* interval key,
60			* interval value
61			* ]
62			* ```
63			*
64			* @param array[] $intervals
65			* @return array[]
66			*/
67			public static function intervalsToSignedBounds($intervals): array
68			{
69			$bounds = [];
70			foreach ($intervals as $key => $interval) {
71			// TODO Get included boolean from interval bound.
72			$bounds[] = [$interval[1], '-', true, $key, $interval[2] ?? null];
73			$bounds[] = [$interval[0], '+', true, $key, $interval[2] ?? null];
74			}
75			// Order the bounds.
76			usort($bounds, static function (array $d1, array $d2) {
77			return ($d1[0] < $d2[0]) ? -1 : 1;
78			});
79			return $bounds;
80			}
81
82			/**
83			* Extract discrete values from an array of intervals.
84			*
85			* Intervals with the exact same lower and higher bound will be considered as discrete values.
86			*
87			* They will be removed from the initial array, and returned in a separate array.
88			*
89			* @param array $intervals The initial array.
90			* @return array An array containing only discrete values.
91			*/
92			public static function extractDiscreteValues(array &$intervals): array
93			{
94			$discreteValues = array_filter($intervals, static function ($interval) {
95			return $interval[0] === $interval[1];
96			});
97
98			$intervals = array_diff_key($intervals, $discreteValues);
99
100			return $discreteValues;
101			}
102
103			/**
104			* Create each new interval and calculate its value based on the active intervals on each bound.
105			*
106			* @param array[] $intervals
107			* @return array[]
108			*/
109			public function flatten(array $intervals): array
110			{
111
112			$discreteValues = self::extractDiscreteValues($intervals);
113
114
115			$bounds = self::intervalsToSignedBounds($intervals);
116			$newIntervals = [];
117			$activeIntervals = [];
118
119			$boundsCount = count($bounds);
120
121			// Create new intervals for each set of two consecutive bounds,
122			// and calculate its total value.
123			for ($i = 1; $i < $boundsCount; $i++) {
124
125			// Set the current bound.
126			[$curBoundValue, $curBoundType, $curBoundIncluded, $curBoundIntervalKey] = $bounds[$i - 1];
127			[$nextBoundValue, $nextBoundType, $nextBoundIncluded] = $bounds[$i];
128
129			if ($curBoundType === '+') {
130			// If this is a low bound,
131			// add the key of the interval to the array of active intervals.
132			$activeIntervals[$curBoundIntervalKey] = true;
133			} else {
134			// If this is an high bound, remove the key.
135			unset($activeIntervals[$curBoundIntervalKey]);
136			}
137
138			if (
139			isset($this->addStep, $this->substractStep) && (
140			($nextBoundIncluded && $nextBoundType === '+')
141			\|\| (!$nextBoundIncluded && $nextBoundType === '+')
142			)
143			) {
144			$newHighBound = ($this->substractStep)($nextBoundValue);
145			} else {
146			$newHighBound = $nextBoundValue;
147			}
148
149			if (
150			isset($this->addStep, $this->substractStep) && $curBoundType === '-' && $curBoundIncluded
151			) {
152			$newLowBound = ($this->addStep)($curBoundValue);
153			} else {
154			$newLowBound = $curBoundValue;
155			}
156
157			$newIntervals[] = [
158			$newLowBound,
159			$newHighBound,
160			$activeIntervals
161			];
162			}
163
164			// Remove empty interval generated when two or more intervals share a common bound.
165			$newIntervals = array_values(array_filter($newIntervals, static function ($i) {
166			// Use weak comparison in case of object typed bounds.
167			return $i[0] != $i[1];
168			}));
169
170
171			// Push discrete values back into the array.
172			if (!empty($discreteValues)) {
173			array_push($newIntervals, ...$discreteValues);
174			}
175
176			return $newIntervals;
177			}
178			}
179

vctls / php-interval-graph

Push — master ( 9aadcc...35c30e )

Flattener::setAddStep() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like