LayerPacker::isSameDimensions() - Code Metrics - Inspection of "Correct rotations before entering callbacks, add a..." - dvdoug/BoxPacker - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2e0db4...02b4d3 )

by Doug

created 2023-04-23 16:31 UTC

LayerPacker::isSameDimensions() A

↳ Parent: LayerPacker

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

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

namespace DVDoug\BoxPacker;

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

use function array_merge;
use function iterator_to_array;
use function max;
use function sort;

/**
 * Layer packer.
 * @internal
 */
class LayerPacker implements LoggerAwareInterface
{
    private LoggerInterface $logger;

    private bool $singlePassMode = false;

    private readonly OrientatedItemFactory $orientatedItemFactory;

    private bool $beStrictAboutItemOrdering = false;

    private bool $isBoxRotated = false;

    public function __construct(private readonly Box $box)
    {
        $this->logger = new NullLogger();

        $this->orientatedItemFactory = new OrientatedItemFactory($this->box);

        $this->orientatedItemFactory->setLogger($this->logger);
    }

    /**
     * Sets a logger.
     */
    public function setLogger(LoggerInterface $logger): void
    {
        $this->logger = $logger;
        $this->orientatedItemFactory->setLogger($logger);
    }

    public function setSinglePassMode(bool $singlePassMode): void
    {
        $this->singlePassMode = $singlePassMode;
        $this->orientatedItemFactory->setSinglePassMode($singlePassMode);
    }

    public function setBoxIsRotated(bool $boxIsRotated): void
    {
        $this->isBoxRotated = $boxIsRotated;
        $this->orientatedItemFactory->setBoxIsRotated($boxIsRotated);
    }

    public function beStrictAboutItemOrdering(bool $beStrict): void
    {
        $this->beStrictAboutItemOrdering = $beStrict;
    }

    /**
     * Pack items into an individual vertical layer.
     */
    public function packLayer(ItemList &$items, PackedItemList $packedItemList, int $startX, int $startY, int $startZ, int $widthForLayer, int $lengthForLayer, int $depthForLayer, int $guidelineLayerDepth, bool $considerStability): PackedLayer
filter:
    dependency_paths: ["lib/*"]
    {
        $layer = new PackedLayer();
        $x = $startX;
        $y = $startY;
        $z = $startZ;
        $rowLength = 0;
        $prevItem = null;
        $skippedItems = [];
        $remainingWeightAllowed = $this->box->getMaxWeight() - $this->box->getEmptyWeight() - $packedItemList->getWeight();

        while ($items->count() > 0) {
            $itemToPack = $items->extract();

            // skip items that will never fit e.g. too heavy
            if ($itemToPack->getWeight() > $remainingWeightAllowed) {
                continue;
            }

            $orientatedItem = $this->orientatedItemFactory->getBestOrientation($itemToPack, $prevItem, $items, $widthForLayer - $x, $lengthForLayer - $y, $depthForLayer, $rowLength, $x, $y, $z, $packedItemList, $considerStability);

            if ($orientatedItem instanceof OrientatedItem) {
                $packedItem = PackedItem::fromOrientatedItem($orientatedItem, $x, $y, $z);
                $layer->insert($packedItem);
                $packedItemList->insert($packedItem);

                $rowLength = max($rowLength, $packedItem->getLength());
                $prevItem = $orientatedItem;

                // Figure out if we can stack items on top of this rather than side by side
                // e.g. when we've packed a tall item, and have just put a shorter one next to it.
                $stackableDepth = ($guidelineLayerDepth ?: $layer->getDepth()) - $packedItem->getDepth();
                if ($stackableDepth > 0) {
                    $stackedLayer = $this->packLayer($items, $packedItemList, $x, $y, $z + $packedItem->getDepth(), $x + $packedItem->getWidth(), $y + $packedItem->getLength(), $stackableDepth, $stackableDepth, $considerStability);
                    $layer->merge($stackedLayer);
                }

                $x += $packedItem->getWidth();
                $remainingWeightAllowed = $this->box->getMaxWeight() - $this->box->getEmptyWeight() - $packedItemList->getWeight(); // remember may have packed additional items

                if ($items->count() === 0 && $skippedItems) {

                    $items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true);
                    $skippedItems = [];
                }
                continue;
            }

            if (!$this->beStrictAboutItemOrdering && $items->count() > 0) { // skip for now, move on to the next item
                $this->logger->debug("doesn't fit, skipping for now");
                $skippedItems[] = $itemToPack;
                // abandon here if next item is the same, no point trying to keep going. Last time is not skipped, need that to trigger appropriate reset logic
                while ($items->count() > 1 && self::isSameDimensions($itemToPack, $items->top())) {
                    $skippedItems[] = $items->extract();
                }
                continue;
            }

            if ($x > $startX) {
                // Having now placed items, there is space *within the same row* along the length. Pack into that.
                $this->logger->debug('No more fit in width wise, packing along remaining length');
                $layer->merge($this->packLayer($items, $packedItemList, $x, $y + $rowLength, $z, $widthForLayer, $lengthForLayer - $rowLength, $depthForLayer, $layer->getDepth(), $considerStability));

                $this->logger->debug('No more fit in width wise, resetting for new row');
                $y += $rowLength;
                $x = $startX;
                $rowLength = 0;
                $skippedItems[] = $itemToPack;
                $items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true);
                $skippedItems = [];
                $prevItem = null;
                continue;
            }

            $this->logger->debug('no items fit, so starting next vertical layer');
            $skippedItems[] = $itemToPack;

            $items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true);

            return $layer;
        }

        return $layer;
    }

    /**
     * Compare two items to see if they have same dimensions.
     */
    private static function isSameDimensions(Item $itemA, Item $itemB): bool
    {
        if ($itemA === $itemB) {
            return true;
        }
        $itemADimensions = [$itemA->getWidth(), $itemA->getLength(), $itemA->getDepth()];
        $itemBDimensions = [$itemB->getWidth(), $itemB->getLength(), $itemB->getDepth()];
        sort($itemADimensions);
        sort($itemBDimensions);

        return $itemADimensions === $itemBDimensions;
    }
}


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 Psr\Log\LoggerAwareInterface;
12		use Psr\Log\LoggerInterface;
13		use Psr\Log\NullLogger;
14
15		use function array_merge;
16		use function iterator_to_array;
17		use function max;
18		use function sort;
19
20		/**
21		* Layer packer.
22		* @internal
23		*/
24		class LayerPacker implements LoggerAwareInterface
25		{
26		private LoggerInterface $logger;
27
28		private bool $singlePassMode = false;
29
30		private readonly OrientatedItemFactory $orientatedItemFactory;
31
32		private bool $beStrictAboutItemOrdering = false;
33
34		private bool $isBoxRotated = false;
35
36	92	public function __construct(private readonly Box $box)
37		{
38	92	$this->logger = new NullLogger();
39
40	92	$this->orientatedItemFactory = new OrientatedItemFactory($this->box);
		0 ignored issues – show Bug introduced 2022-12-05 18:54 UTC by Report Bug Copy Issue Report The property `orientatedItemFactory` is declared read-only in `DVDoug\BoxPacker\LayerPacker`. Loading history...
41	92	$this->orientatedItemFactory->setLogger($this->logger);
42		}
43
44		/**
45		* Sets a logger.
46		*/
47	92	public function setLogger(LoggerInterface $logger): void
48		{
49	92	$this->logger = $logger;
50	92	$this->orientatedItemFactory->setLogger($logger);
51		}
52
53	22	public function setSinglePassMode(bool $singlePassMode): void
54		{
55	22	$this->singlePassMode = $singlePassMode;
56	22	$this->orientatedItemFactory->setSinglePassMode($singlePassMode);
57		}
58
59	92	public function setBoxIsRotated(bool $boxIsRotated): void
60		{
61	92	$this->isBoxRotated = $boxIsRotated;
62	92	$this->orientatedItemFactory->setBoxIsRotated($boxIsRotated);
63		}
64
65	39	public function beStrictAboutItemOrdering(bool $beStrict): void
66		{
67	39	$this->beStrictAboutItemOrdering = $beStrict;
68		}
69
70		/**
71		* Pack items into an individual vertical layer.
72		*/
73	92	public function packLayer(ItemList &$items, PackedItemList $packedItemList, int $startX, int $startY, int $startZ, int $widthForLayer, int $lengthForLayer, int $depthForLayer, int $guidelineLayerDepth, bool $considerStability): PackedLayer
		0 ignored issues – show Bug introduced 2022-12-05 18:54 UTC by Report Bug Copy Issue Report The type `DVDoug\BoxPacker\PackedItemList` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
74		{
75	92	$layer = new PackedLayer();
76	92	$x = $startX;
77	92	$y = $startY;
78	92	$z = $startZ;
79	92	$rowLength = 0;
80	92	$prevItem = null;
81	92	$skippedItems = [];
82	92	$remainingWeightAllowed = $this->box->getMaxWeight() - $this->box->getEmptyWeight() - $packedItemList->getWeight();
83
84	92	while ($items->count() > 0) {
85	92	$itemToPack = $items->extract();
86
87		// skip items that will never fit e.g. too heavy
88	92	if ($itemToPack->getWeight() > $remainingWeightAllowed) {
89	18	continue;
90		}
91
92	90	$orientatedItem = $this->orientatedItemFactory->getBestOrientation($itemToPack, $prevItem, $items, $widthForLayer - $x, $lengthForLayer - $y, $depthForLayer, $rowLength, $x, $y, $z, $packedItemList, $considerStability);
93
94	90	if ($orientatedItem instanceof OrientatedItem) {
95	89	$packedItem = PackedItem::fromOrientatedItem($orientatedItem, $x, $y, $z);
96	89	$layer->insert($packedItem);
97	89	$packedItemList->insert($packedItem);
98
99	89	$rowLength = max($rowLength, $packedItem->getLength());
100	89	$prevItem = $orientatedItem;
101
102		// Figure out if we can stack items on top of this rather than side by side
103		// e.g. when we've packed a tall item, and have just put a shorter one next to it.
104	89	$stackableDepth = ($guidelineLayerDepth ?: $layer->getDepth()) - $packedItem->getDepth();
105	89	if ($stackableDepth > 0) {
106	30	$stackedLayer = $this->packLayer($items, $packedItemList, $x, $y, $z + $packedItem->getDepth(), $x + $packedItem->getWidth(), $y + $packedItem->getLength(), $stackableDepth, $stackableDepth, $considerStability);
107	30	$layer->merge($stackedLayer);
108		}
109
110	89	$x += $packedItem->getWidth();
111	89	$remainingWeightAllowed = $this->box->getMaxWeight() - $this->box->getEmptyWeight() - $packedItemList->getWeight(); // remember may have packed additional items
112
113	89	if ($items->count() === 0 && $skippedItems) {
		0 ignored issues – show Bug Best Practice introduced 2021-03-11 21:27 UTC by Report Bug Copy Issue Report The expression `$skippedItems` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
114	16	$items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true);
115	16	$skippedItems = [];
116		}
117	89	continue;
118		}
119
120	81	if (!$this->beStrictAboutItemOrdering && $items->count() > 0) { // skip for now, move on to the next item
121	70	$this->logger->debug("doesn't fit, skipping for now");
122	70	$skippedItems[] = $itemToPack;
123		// abandon here if next item is the same, no point trying to keep going. Last time is not skipped, need that to trigger appropriate reset logic
124	70	while ($items->count() > 1 && self::isSameDimensions($itemToPack, $items->top())) {
125	32	$skippedItems[] = $items->extract();
126		}
127	70	continue;
128		}
129
130	81	if ($x > $startX) {
131		// Having now placed items, there is space within the same row along the length. Pack into that.
132	80	$this->logger->debug('No more fit in width wise, packing along remaining length');
133	80	$layer->merge($this->packLayer($items, $packedItemList, $x, $y + $rowLength, $z, $widthForLayer, $lengthForLayer - $rowLength, $depthForLayer, $layer->getDepth(), $considerStability));
134
135	80	$this->logger->debug('No more fit in width wise, resetting for new row');
136	80	$y += $rowLength;
137	80	$x = $startX;
138	80	$rowLength = 0;
139	80	$skippedItems[] = $itemToPack;
140	80	$items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true);
141	80	$skippedItems = [];
142	80	$prevItem = null;
143	80	continue;
144		}
145
146	71	$this->logger->debug('no items fit, so starting next vertical layer');
147	71	$skippedItems[] = $itemToPack;
148
149	71	$items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true);
150
151	71	return $layer;
152		}
153
154	91	return $layer;
155		}
156
157		/**
158		* Compare two items to see if they have same dimensions.
159		*/
160	42	private static function isSameDimensions(Item $itemA, Item $itemB): bool
161		{
162	42	if ($itemA === $itemB) {
163	29	return true;
164		}
165	21	$itemADimensions = [$itemA->getWidth(), $itemA->getLength(), $itemA->getDepth()];
166	21	$itemBDimensions = [$itemB->getWidth(), $itemB->getLength(), $itemB->getDepth()];
167	21	sort($itemADimensions);
168	21	sort($itemBDimensions);
169
170	21	return $itemADimensions === $itemBDimensions;
171		}
172		}
173

dvdoug / BoxPacker

Push — master ( 2e0db4...02b4d3 )

LayerPacker::isSameDimensions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like