ItemList::extract() - Code Metrics - Inspection of "Enable JIT on CI" - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — test_jit ( c34f6e...87859e )

by Doug

created 2020-04-11 21:59 UTC

ItemList::extract() A

↳ Parent: ItemList

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Box packing (3D bin packing, knapsack problem).
 *
 * @author Doug Wright
 */
declare(strict_types=1);

namespace DVDoug\BoxPacker;

use function array_key_last;
use function array_pop;
use function array_reverse;
use function array_slice;
use ArrayIterator;
use function count;
use Countable;
use function end;
use IteratorAggregate;
use Traversable;
use function usort;

/**
 * List of items to be packed, ordered by volume.
 *
 * @author Doug Wright
 */
class ItemList implements Countable, IteratorAggregate
{
    /**
     * List containing items.
     *
     * @var Item[]
     */
    private $list = [];

    /**
     * Has this list already been sorted?
     *
     * @var bool
     */
    private $isSorted = false;

    /**
     * Does this list contain constrained items?
     *
     * @var bool
     */
    private $hasConstrainedItems;

    /**
     * Do a bulk create.
     *
     * @param  Item[]   $items
     * @return ItemList
     */
    public static function fromArray(array $items, bool $preSorted = false): self
    {
        $list = new static();
        $list->list = array_reverse($items); // internal sort is largest at the end
        $list->isSorted = $preSorted;

        return $list;
    }

    public function insert(Item $item): void
    {
        $this->list[] = $item;
        $this->isSorted = false;
        $this->hasConstrainedItems = $this->hasConstrainedItems || $item instanceof ConstrainedPlacementItem;
    }

    /**
     * Remove item from list.
     */
    public function remove(Item $item): void
    {
        if (!$this->isSorted) {
            usort($this->list, [$this, 'compare']);
            $this->isSorted = true;
        }

        end($this->list);
        do {
            if (current($this->list) === $item) {
                unset($this->list[key($this->list)]);

                return;
            }
        } while (prev($this->list) !== false);
    }

    /**
     * @internal
     */
    public function extract(): Item
    {
        if (!$this->isSorted) {
            usort($this->list, [$this, 'compare']);
            $this->isSorted = true;
        }

        return array_pop($this->list);
    }

    /**
     * @internal
     */
    public function top(): Item
    {
        if (!$this->isSorted) {
            usort($this->list, [$this, 'compare']);
            $this->isSorted = true;
        }

        if (\PHP_VERSION_ID < 70300) {
            return array_slice($this->list, -1, 1)[0];
        }

        return $this->list[array_key_last($this->list)];
    }

    /**
     * @internal
     *
     * @return ItemList
     */
    public function topN(int $n): self
    {
        if (!$this->isSorted) {
            usort($this->list, [$this, 'compare']);
            $this->isSorted = true;
        }

        $topNList = new self();
        $topNList->list = array_slice($this->list, -$n, $n);
        $topNList->isSorted = true;

        return $topNList;
    }

    public function getIterator(): Traversable
    {
        if (!$this->isSorted) {
            usort($this->list, [$this, 'compare']);
            $this->isSorted = true;
        }

        return new ArrayIterator(array_reverse($this->list));
    }

    /**
     * Number of items in list.
     */
    public function count(): int
    {
        return count($this->list);
    }

    /**
     * Does this list contain items with constrained placement criteria.
     */
    public function hasConstrainedItems(): bool
    {
        if (!isset($this->hasConstrainedItems)) {
            $this->hasConstrainedItems = false;
            foreach ($this->list as $item) {
                if ($item instanceof ConstrainedPlacementItem) {
                    $this->hasConstrainedItems = true;
                    break;
                }
            }
        }

        return $this->hasConstrainedItems;
    }

    private static function compare(Item $itemA, Item $itemB): int
    {
        $volumeDecider = $itemA->getWidth() * $itemA->getLength() * $itemA->getDepth() <=> $itemB->getWidth() * $itemB->getLength() * $itemB->getDepth();
        if ($volumeDecider !== 0) {
            return $volumeDecider;
        }
        $weightDecider = $itemA->getWeight() - $itemB->getWeight();
        if ($weightDecider !== 0) {
            return $weightDecider;
        }

        return $itemB->getDescription() <=> $itemA->getDescription();
    }
}


1		<?php
2		/**
3		* Box packing (3D bin packing, knapsack problem).
4		*
5		* @author Doug Wright
6		*/
7		declare(strict_types=1);
8
9		namespace DVDoug\BoxPacker;
10
11		use function array_key_last;
12		use function array_pop;
13		use function array_reverse;
14		use function array_slice;
15		use ArrayIterator;
16		use function count;
17		use Countable;
18		use function end;
19		use IteratorAggregate;
20		use Traversable;
21		use function usort;
22
23		/**
24		* List of items to be packed, ordered by volume.
25		*
26		* @author Doug Wright
27		*/
28		class ItemList implements Countable, IteratorAggregate
29		{
30		/**
31		* List containing items.
32		*
33		* @var Item[]
34		*/
35		private $list = [];
36
37		/**
38		* Has this list already been sorted?
39		*
40		* @var bool
41		*/
42		private $isSorted = false;
43
44		/**
45		* Does this list contain constrained items?
46		*
47		* @var bool
48		*/
49		private $hasConstrainedItems;
50
51		/**
52		* Do a bulk create.
53		*
54		* @param Item[] $items
55		* @return ItemList
56		*/
57	55	public static function fromArray(array $items, bool $preSorted = false): self
58		{
59	55	$list = new static();
60	55	$list->list = array_reverse($items); // internal sort is largest at the end
61	55	$list->isSorted = $preSorted;
62
63	55	return $list;
64		}
65
66	64	public function insert(Item $item): void
67		{
68	64	$this->list[] = $item;
69	64	$this->isSorted = false;
70	64	$this->hasConstrainedItems = $this->hasConstrainedItems \|\| $item instanceof ConstrainedPlacementItem;
71	64	}
72
73		/**
74		* Remove item from list.
75		*/
76	45	public function remove(Item $item): void
77		{
78	45	if (!$this->isSorted) {
79	3	usort($this->list, [$this, 'compare']);
80	3	$this->isSorted = true;
81		}
82
83	45	end($this->list);
84		do {
85	45	if (current($this->list) === $item) {
86	45	unset($this->list[key($this->list)]);
87
88	45	return;
89		}
90	6	} while (prev($this->list) !== false);
91		}
92
93		/**
94		* @internal
95		*/
96	58	public function extract(): Item
97		{
98	58	if (!$this->isSorted) {
99	30	usort($this->list, [$this, 'compare']);
100	30	$this->isSorted = true;
101		}
102
103	58	return array_pop($this->list);
104		}
105
106		/**
107		* @internal
108		*/
109	43	public function top(): Item
110		{
111	43	if (!$this->isSorted) {
112	1	usort($this->list, [$this, 'compare']);
113	1	$this->isSorted = true;
114		}
115
116	43	if (\PHP_VERSION_ID < 70300) {
117		return array_slice($this->list, -1, 1)[0];
118		}
119
120	43	return $this->list[array_key_last($this->list)];
121		}
122
123		/**
124		* @internal
125		*
126		* @return ItemList
127		*/
128	36	public function topN(int $n): self
129		{
130	36	if (!$this->isSorted) {
131	1	usort($this->list, [$this, 'compare']);
132	1	$this->isSorted = true;
133		}
134
135	36	$topNList = new self();
136	36	$topNList->list = array_slice($this->list, -$n, $n);
137	36	$topNList->isSorted = true;
138
139	36	return $topNList;
140		}
141
142	61	public function getIterator(): Traversable
143		{
144	61	if (!$this->isSorted) {
145	31	usort($this->list, [$this, 'compare']);
146	31	$this->isSorted = true;
147		}
148
149	61	return new ArrayIterator(array_reverse($this->list));
150		}
151
152		/**
153		* Number of items in list.
154		*/
155	61	public function count(): int
156		{
157	61	return count($this->list);
158		}
159
160		/**
161		* Does this list contain items with constrained placement criteria.
162		*/
163	56	public function hasConstrainedItems(): bool
164		{
165	56	if (!isset($this->hasConstrainedItems)) {
166	34	$this->hasConstrainedItems = false;
167	34	foreach ($this->list as $item) {
168	34	if ($item instanceof ConstrainedPlacementItem) {
169		$this->hasConstrainedItems = true;
170		break;
171		}
172		}
173		}
174
175	56	return $this->hasConstrainedItems;
176		}
177
178	59	private static function compare(Item $itemA, Item $itemB): int
179		{
180	59	$volumeDecider = $itemA->getWidth() * $itemA->getLength() * $itemA->getDepth() <=> $itemB->getWidth() * $itemB->getLength() * $itemB->getDepth();
181	59	if ($volumeDecider !== 0) {
182	29	return $volumeDecider;
183		}
184	52	$weightDecider = $itemA->getWeight() - $itemB->getWeight();
185	52	if ($weightDecider !== 0) {
186	4	return $weightDecider;
187		}
188
189	49	return $itemB->getDescription() <=> $itemA->getDescription();
190		}
191		}
192

dvdoug / BoxPacker

Push — test_jit ( c34f6e...87859e )

ItemList::extract() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like